Cinka/OldThink
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add client pulling prediction (#2041)

Browse Source 
* WIP changes

* Merge conflict fixes

* Bring pull controlelr to current year

* Sync and predict PullController on the client

* Clean imports

* Slow down pullers and make pulling tighter

* Stop pulls on pullable or puller component removals

* Make pulling not occur when moving towards the pulled entity
This commit is contained in:
DrSmugleaf
2020-10-16 20:35:09 +02:00
committed by GitHub
parent 0345fbbd22
commit b1fe4bad01
24 changed files with 734 additions and 341 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Content.Shared/GameObjects/Components/Items/ISharedHandsComponent.cs
View File

@@ -4,6 +4,5 @@ namespace Content.Shared.GameObjects.Components.Items
{
public interface ISharedHandsComponent : IComponent
{
void StopPull();
}
}

38
Content.Shared/GameObjects/Components/Items/SharedHandsComponent.cs
View File

@@ -1,6 +1,8 @@
#nullable enable
using System;
using Content.Shared.GameObjects.Components.Pulling;
using Content.Shared.Physics.Pull;
using Robust.Shared.Containers;
using Robust.Shared.GameObjects;
using Robust.Shared.GameObjects.Components;
using Robust.Shared.Interfaces.GameObjects;
@@ -13,42 +15,6 @@ namespace Content.Shared.GameObjects.Components.Items
{
public sealed override string Name => "Hands";
public sealed override uint? NetID => ContentNetIDs.HANDS;
[ViewVariables]
public IPhysicsComponent? PulledObject { get; protected set; }
[ViewVariables]
protected bool IsPulling => PulledObject != null;
public virtual void StopPull()
{
if (PulledObject != null &&
PulledObject.TryGetController(out PullController controller))
{
controller.StopPull();
}
}
public override void HandleMessage(ComponentMessage message, IComponent? component)
{
base.HandleMessage(message, component);
if (!(message is PullMessage pullMessage) ||
pullMessage.Puller.Owner != Owner)
{
return;
}
switch (message)
{
case PullStartedMessage msg:
PulledObject = msg.Pulled;
break;
case PullStoppedMessage _:
PulledObject = null;
break;
}
}
}
[Serializable, NetSerializable]

4
Content.Shared/GameObjects/Components/Mobs/SharedStatusEffectsComponent.cs
View File

@@ -14,7 +14,11 @@ namespace Content.Shared.GameObjects.Components.Mobs
public override string Name => "StatusEffectsUI";
public override uint? NetID => ContentNetIDs.STATUSEFFECTS;
public abstract void ChangeStatusEffectIcon(StatusEffect effect, string icon);
public abstract void ChangeStatusEffect(StatusEffect effect, string icon, ValueTuple<TimeSpan, TimeSpan>? cooldown);
public abstract void RemoveStatusEffect(StatusEffect effect);
}
[Serializable, NetSerializable]

263
Content.Shared/GameObjects/Components/Pulling/SharedPullableComponent.cs Normal file
View File

@@ -0,0 +1,263 @@
#nullable enable
using System;
using Content.Shared.GameObjects.Components.Mobs;
using Content.Shared.Physics.Pull;
using Robust.Shared.Containers;
using Robust.Shared.GameObjects;
using Robust.Shared.GameObjects.Components;
using Robust.Shared.GameObjects.Components.Transform;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.Map;
using Robust.Shared.Serialization;
namespace Content.Shared.GameObjects.Components.Pulling
{
public abstract class SharedPullableComponent : Component
{
public override string Name => "Pullable";
public override uint? NetID => ContentNetIDs.PULLABLE;
private IEntity? _puller;
public virtual IEntity? Puller
{
get => _puller;
private set
{
if (_puller == value)
{
return;
}
_puller = value;
Dirty();
if (!Owner.TryGetComponent(out IPhysicsComponent? physics))
{
return;
}
PullController controller;
if (value == null)
{
if (physics.TryGetController(out controller))
{
controller.StopPull();
}
return;
}
controller = physics.EnsureController<PullController>();
controller.StartPull(value);
}
}
public bool BeingPulled => Puller != null;
public bool CanStartPull(IEntity puller)
{
if (!puller.HasComponent<SharedPullerComponent>())
{
return false;
}
if (!puller.TryGetComponent(out IPhysicsComponent? physics))
{
return false;
}
if (physics.Anchored)
{
return false;
}
if (puller == Owner)
{
return false;
}
if (!puller.IsInSameOrNoContainer(Owner))
{
return false;
}
return true;
}
public bool TryStartPull(IEntity puller)
{
if (!CanStartPull(puller))
{
return false;
}
TryStopPull();
Puller = puller;
if (Puller != puller)
{
return false;
}
return true;
}
public bool TryStopPull()
{
if (!BeingPulled)
{
return false;
}
Puller = null;
return true;
}
public bool TogglePull(IEntity puller)
{
if (Puller == null)
{
return TryStartPull(puller);
}
return TryStopPull();
}
public bool TryMoveTo(EntityCoordinates to)
{
if (Puller == null)
{
return false;
}
if (!Owner.TryGetComponent(out IPhysicsComponent? physics))
{
return false;
}
if (!physics.TryGetController(out PullController controller))
{
return false;
}
return controller.TryMoveTo(Puller.Transform.Coordinates, to);
}
private void PullerMoved(MoveEvent moveEvent)
{
if (Puller == null)
{
return;
}
if (moveEvent.Sender != Puller)
{
return;
}
if (!Owner.TryGetComponent(out IPhysicsComponent? physics))
{
return;
}
physics.WakeBody();
}
public override ComponentState GetComponentState()
{
return new PullableComponentState(Puller?.Uid);
}
public override void HandleComponentState(ComponentState? curState, ComponentState? nextState)
{
base.HandleComponentState(curState, nextState);
if (!(curState is PullableComponentState state))
{
return;
}
if (state.Puller == null)
{
Puller = null;
return;
}
Puller = Owner.EntityManager.GetEntity(state.Puller.Value);
}
public override void HandleMessage(ComponentMessage message, IComponent? component)
{
base.HandleMessage(message, component);
if (!(message is PullMessage pullMessage) ||
pullMessage.Pulled.Owner != Owner)
{
return;
}
switch (message)
{
case PullStartedMessage msg:
Owner.EntityManager.EventBus.SubscribeEvent<MoveEvent>(EventSource.Local, this, PullerMoved);
AddPullingStatuses(msg.Puller.Owner);
break;
case PullStoppedMessage msg:
Owner.EntityManager.EventBus.UnsubscribeEvent<MoveEvent>(EventSource.Local, this);
RemovePullingStatuses(msg.Puller.Owner);
break;
}
}
private void AddPullingStatuses(IEntity puller)
{
if (Owner.TryGetComponent(out SharedStatusEffectsComponent? pulledStatus))
{
pulledStatus.ChangeStatusEffectIcon(StatusEffect.Pulled,
"/Textures/Interface/StatusEffects/Pull/pulled.png");
}
if (puller.TryGetComponent(out SharedStatusEffectsComponent? ownerStatus))
{
ownerStatus.ChangeStatusEffectIcon(StatusEffect.Pulling,
"/Textures/Interface/StatusEffects/Pull/pulling.png");
}
}
private void RemovePullingStatuses(IEntity puller)
{
if (Owner.TryGetComponent(out SharedStatusEffectsComponent? pulledStatus))
{
pulledStatus.RemoveStatusEffect(StatusEffect.Pulled);
}
if (puller.TryGetComponent(out SharedStatusEffectsComponent? ownerStatus))
{
ownerStatus.RemoveStatusEffect(StatusEffect.Pulling);
}
}
public override void OnRemove()
{
TryStopPull();
base.OnRemove();
}
}
[Serializable, NetSerializable]
public class PullableComponentState : ComponentState
{
public readonly EntityUid? Puller;
public PullableComponentState(EntityUid? puller) : base(ContentNetIDs.PULLABLE)
{
Puller = puller;
}
}
}

72
Content.Shared/GameObjects/Components/Pulling/SharedPullerComponent.cs Normal file
View File

@@ -0,0 +1,72 @@
#nullable enable
using Content.Shared.GameObjects.Components.Movement;
using Content.Shared.Physics.Pull;
using Robust.Shared.GameObjects;
using Robust.Shared.Interfaces.GameObjects;
using Component = Robust.Shared.GameObjects.Component;
namespace Content.Shared.GameObjects.Components.Pulling
{
[RegisterComponent]
public class SharedPullerComponent : Component, IMoveSpeedModifier
{
public override string Name => "Puller";
private IEntity? _pulling;
public float WalkSpeedModifier => Pulling == null ? 1.0f : 0.75f;
public float SprintSpeedModifier => Pulling == null ? 1.0f : 0.75f;
public IEntity? Pulling
{
get => _pulling;
private set
{
if (_pulling == value)
{
return;
}
_pulling = value;
if (Owner.TryGetComponent(out MovementSpeedModifierComponent? speed))
{
speed.RefreshMovementSpeedModifiers();
}
}
}
public override void OnRemove()
{
if (Pulling != null &&
Pulling.TryGetComponent(out SharedPullableComponent? pullable))
{
pullable.TryStopPull();
}
base.OnRemove();
}
public override void HandleMessage(ComponentMessage message, IComponent? component)
{
base.HandleMessage(message, component);
if (!(message is PullMessage pullMessage) ||
pullMessage.Puller.Owner != Owner)
{
return;
}
switch (message)
{
case PullStartedMessage msg:
Pulling = msg.Pulled.Owner;
break;
case PullStoppedMessage _:
Pulling = null;
break;
}
}
}
}

1
Content.Shared/GameObjects/ContentNetIDs.cs
View File

@@ -81,6 +81,7 @@
public const uint CRAYONS = 1075;
public const uint PLACEABLE_SURFACE = 1076;
public const uint STORABLE = 1077;
public const uint PULLABLE = 1078;
// Net IDs for integration tests.
public const uint PREDICTION_TEST = 10001;

117
Content.Shared/GameObjects/EntitySystems/SharedPullingSystem.cs Normal file
View File

@@ -0,0 +1,117 @@
#nullable enable
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using Content.Shared.GameObjects.Components.Pulling;
using Content.Shared.Input;
using Content.Shared.Physics.Pull;
using JetBrains.Annotations;
using Robust.Shared.GameObjects;
using Robust.Shared.GameObjects.Systems;
using Robust.Shared.Input.Binding;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.Map;
using Robust.Shared.Players;
namespace Content.Shared.GameObjects.EntitySystems
{
[UsedImplicitly]
public class SharedPullingSystem : EntitySystem
{
private readonly Dictionary<IEntity, IEntity> _pullers =
new Dictionary<IEntity, IEntity>();
public override void Initialize()
{
base.Initialize();
SubscribeLocalEvent<PullStartedMessage>(OnPullStarted);
SubscribeLocalEvent<PullStoppedMessage>(OnPullStopped);
CommandBinds.Builder
.Bind(ContentKeyFunctions.MovePulledObject, new PointerInputCmdHandler(HandleMovePulledObject))
.Bind(ContentKeyFunctions.ReleasePulledObject, InputCmdHandler.FromDelegate(HandleReleasePulledObject))
.Register<SharedPullingSystem>();
}
private void OnPullStarted(PullStartedMessage message)
{
SetPuller(message.Puller.Owner, message.Pulled.Owner);
}
private void OnPullStopped(PullStoppedMessage message)
{
RemovePuller(message.Puller.Owner);
}
private bool HandleMovePulledObject(ICommonSession? session, EntityCoordinates coords, EntityUid uid)
{
var player = session?.AttachedEntity;
if (player == null)
{
return false;
}
if (!TryGetPulled(player, out var pulled))
{
return false;
}
if (!pulled.TryGetComponent(out SharedPullableComponent? pullable))
{
return false;
}
pullable.TryMoveTo(coords);
return false;
}
private void HandleReleasePulledObject(ICommonSession? session)
{
var player = session?.AttachedEntity;
if (player == null)
{
return;
}
if (!TryGetPulled(player, out var pulled))
{
return;
}
if (!pulled.TryGetComponent(out SharedPullableComponent? pullable))
{
return;
}
pullable.TryStopPull();
}
private void SetPuller(IEntity puller, IEntity pulled)
{
_pullers[puller] = pulled;
}
private bool RemovePuller(IEntity puller)
{
return _pullers.Remove(puller);
}
public IEntity? GetPulled(IEntity by)
{
return _pullers.GetValueOrDefault(by);
}
public bool TryGetPulled(IEntity by, [NotNullWhen(true)] out IEntity? pulled)
{
return (pulled = GetPulled(by)) != null;
}
public bool IsPulling(IEntity puller)
{
return _pullers.ContainsKey(puller);
}
}
}

175
Content.Shared/Physics/Pull/PullController.cs
View File

@@ -1,22 +1,28 @@
#nullable enable
using System;
using Content.Shared.GameObjects.EntitySystems;
using System.Linq;
using Robust.Shared.Containers;
using Robust.Shared.GameObjects;
using Robust.Shared.GameObjects.Components;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.Interfaces.Physics;
using Robust.Shared.IoC;
using Robust.Shared.Map;
using Robust.Shared.Maths;
using Robust.Shared.Physics;
using Robust.Shared.Utility;
using static Content.Shared.GameObjects.EntitySystems.SharedInteractionSystem;
namespace Content.Shared.Physics.Pull
{
public class PullController : VirtualController
{
private const float DistBeforePull = 1.0f;
[Dependency] private readonly IEntityManager _entityManager = default!;
[Dependency] private readonly IPhysicsManager _physicsManager = default!;
private const float DistBeforeStopPull = SharedInteractionSystem.InteractionRange;
private const float DistBeforeStopPull = InteractionRange;
private const float StopMoveThreshold = 0.25f;
private IPhysicsComponent? _puller;
@@ -26,81 +32,167 @@ namespace Content.Shared.Physics.Pull
public IPhysicsComponent? Puller => _puller;
public void StartPull(IPhysicsComponent puller)
public EntityCoordinates? MovingTo
{
get => _movingTo;
set
{
if (_movingTo == value || ControlledComponent == null)
{
return;
}
_movingTo = value;
ControlledComponent.WakeBody();
}
}
private float DistanceBeforeStopPull()
{
if (_puller == null)
{
return 0;
}
var aabbSize = _puller.AABB.Size;
return (aabbSize.X > aabbSize.Y ? aabbSize.X : aabbSize.Y) + 0.15f;
}
private bool PullerMovingTowardsPulled()
{
if (_puller == null)
{
return false;
}
if (ControlledComponent == null)
{
return false;
}
if (_puller.LinearVelocity.EqualsApprox(Vector2.Zero))
{
return false;
}
var pullerTransform = _puller.Owner.Transform;
var origin = pullerTransform.Coordinates.Position;
var velocity = _puller.LinearVelocity.Normalized;
var mapId = pullerTransform.MapPosition.MapId;
var ray = new CollisionRay(origin, velocity, (int) CollisionGroup.AllMask);
bool Predicate(IEntity e) => e != ControlledComponent.Owner;
var rayResults =
_physicsManager.IntersectRayWithPredicate(mapId, ray, DistanceBeforeStopPull() * 2, Predicate);
return rayResults.Any();
}
public bool StartPull(IEntity entity)
{
DebugTools.AssertNotNull(entity);
if (!entity.TryGetComponent(out IPhysicsComponent? physics))
{
return false;
}
return StartPull(physics);
}
public bool StartPull(IPhysicsComponent puller)
{
DebugTools.AssertNotNull(puller);
if (_puller == puller)
{
return;
return false;
}
_puller = puller;
if (ControlledComponent == null)
{
return;
return false;
}
ControlledComponent.WakeBody();
_puller = puller;
var message = new PullStartedMessage(this, _puller, ControlledComponent);
_puller.Owner.SendMessage(null, message);
ControlledComponent.Owner.SendMessage(null, message);
_puller.Owner.EntityManager.EventBus.RaiseEvent(EventSource.Local, message);
ControlledComponent.WakeBody();
return true;
}
public void StopPull()
public bool StopPull()
{
var oldPuller = _puller;
if (oldPuller == null)
{
return;
return false;
}
_puller = null;
if (ControlledComponent == null)
{
return;
return false;
}
ControlledComponent.WakeBody();
var message = new PullStoppedMessage(this, oldPuller, ControlledComponent);
var message = new PullStoppedMessage(oldPuller, ControlledComponent);
oldPuller.Owner.SendMessage(null, message);
ControlledComponent.Owner.SendMessage(null, message);
oldPuller.Owner.EntityManager.EventBus.RaiseEvent(EventSource.Local, message);
ControlledComponent.WakeBody();
ControlledComponent.TryRemoveController<PullController>();
return true;
}
public void TryMoveTo(EntityCoordinates from, EntityCoordinates to)
public bool TryMoveTo(EntityCoordinates from, EntityCoordinates to)
{
if (_puller == null || ControlledComponent == null)
{
return;
return false;
}
var entityManager = IoCManager.Resolve<IEntityManager>();
if (!from.InRange(entityManager, to, SharedInteractionSystem.InteractionRange))
if (!_puller.Owner.Transform.Coordinates.InRange(_entityManager, from, InteractionRange))
{
return;
return false;
}
ControlledComponent.WakeBody();
var dist = _puller.Owner.Transform.Coordinates.Position - to.Position;
if (Math.Sqrt(dist.LengthSquared) > DistBeforeStopPull ||
Math.Sqrt(dist.LengthSquared) < 0.25f)
if (!_puller.Owner.Transform.Coordinates.InRange(_entityManager, to, InteractionRange))
{
return;
return false;
}
_movingTo = to;
if (!from.InRange(_entityManager, to, InteractionRange))
{
return false;
}
if (from.Position.EqualsApprox(to.Position))
{
return false;
}
if (!_puller.Owner.Transform.Coordinates.TryDistance(_entityManager, to, out var distance) ||
Math.Sqrt(distance) > DistBeforeStopPull ||
Math.Sqrt(distance) < StopMoveThreshold)
{
return false;
}
MovingTo = to;
return true;
}
public override void UpdateBeforeProcessing()
@@ -116,21 +208,20 @@ namespace Content.Shared.Physics.Pull
return;
}
// Are we outside of pulling range?
var dist = _puller.Owner.Transform.WorldPosition - ControlledComponent.Owner.Transform.WorldPosition;
var distance = _puller.Owner.Transform.WorldPosition - ControlledComponent.Owner.Transform.WorldPosition;
if (dist.Length > DistBeforeStopPull)
if (distance.Length > DistBeforeStopPull)
{
StopPull();
}
else if (_movingTo.HasValue)
else if (MovingTo.HasValue)
{
var diff = _movingTo.Value.Position - ControlledComponent.Owner.Transform.Coordinates.Position;
var diff = MovingTo.Value.Position - ControlledComponent.Owner.Transform.Coordinates.Position;
LinearVelocity = diff.Normalized * 5;
}
else if (dist.Length > DistBeforePull)
else if (distance.Length > DistanceBeforeStopPull() && !PullerMovingTowardsPulled())
{
LinearVelocity = dist.Normalized * _puller.LinearVelocity.Length * 1.1f;
LinearVelocity = distance.Normalized * _puller.LinearVelocity.Length * 1.5f;
}
else
{
@@ -144,18 +235,14 @@ namespace Content.Shared.Physics.Pull
if (ControlledComponent == null)
{
_movingTo = null;
MovingTo = null;
return;
}
if (_movingTo == null)
if (MovingTo != null &&
ControlledComponent.Owner.Transform.Coordinates.Position.EqualsApprox(MovingTo.Value.Position, 0.01))
{
return;
}
if (ControlledComponent.Owner.Transform.Coordinates.Position.EqualsApprox(_movingTo.Value.Position, 0.01))
{
_movingTo = null;
MovingTo = null;
}
}
}

4
Content.Shared/Physics/Pull/PullMessage.cs
View File

@@ -5,13 +5,11 @@ namespace Content.Shared.Physics.Pull
{
public class PullMessage : ComponentMessage
{
public readonly PullController Controller;
public readonly IPhysicsComponent Puller;
public readonly IPhysicsComponent Pulled;
protected PullMessage(PullController controller, IPhysicsComponent puller, IPhysicsComponent pulled)
protected PullMessage(IPhysicsComponent puller, IPhysicsComponent pulled)
{
Controller = controller;
Puller = puller;
Pulled = pulled;
}

2
Content.Shared/Physics/Pull/PullStartedMessage.cs
View File

@@ -5,7 +5,7 @@ namespace Content.Shared.Physics.Pull
public class PullStartedMessage : PullMessage
{
public PullStartedMessage(PullController controller, IPhysicsComponent puller, IPhysicsComponent pulled) :
base(controller, puller, pulled)
base(puller, pulled)
{
}
}

3
Content.Shared/Physics/Pull/PullStoppedMessage.cs
View File

@@ -4,8 +4,7 @@ namespace Content.Shared.Physics.Pull
{
public class PullStoppedMessage : PullMessage
{
public PullStoppedMessage(PullController controller, IPhysicsComponent puller, IPhysicsComponent pulled) :
base(controller, puller, pulled)
public PullStoppedMessage(IPhysicsComponent puller, IPhysicsComponent pulled) : base(puller, pulled)
{
}
}