Some MoverController cleanup (#18484)

Was going to code a feature but forgor it already existed so I just cleaned up some Dirty / EntityQuery<T> stuff.
This commit is contained in:
metalgearsloth
2023-08-01 14:08:52 +10:00
committed by GitHub
parent 823cb0a762
commit 73c323fd62
5 changed files with 93 additions and 117 deletions

View File

@@ -68,7 +68,9 @@ namespace Content.Shared.Movement.Systems
protected void SetMoveInput(InputMoverComponent component, MoveButtons buttons)
{
if (component.HeldMoveButtons == buttons) return;
if (component.HeldMoveButtons == buttons)
return;
component.HeldMoveButtons = buttons;
Dirty(component);
}
@@ -120,33 +122,31 @@ namespace Content.Shared.Movement.Systems
public void RotateCamera(EntityUid uid, Angle angle)
{
if (CameraRotationLocked || !TryComp<InputMoverComponent>(uid, out var mover))
if (CameraRotationLocked || !MoverQuery.TryGetComponent(uid, out var mover))
return;
mover.TargetRelativeRotation += angle;
Dirty(mover);
Dirty(uid, mover);
}
public void ResetCamera(EntityUid uid)
{
if (CameraRotationLocked ||
!TryComp<InputMoverComponent>(uid, out var mover))
!MoverQuery.TryGetComponent(uid, out var mover))
{
return;
}
// If we updated parent then cancel the accumulator and force it now.
var xformQuery = GetEntityQuery<TransformComponent>();
if (!TryUpdateRelative(mover, xformQuery.GetComponent(uid), xformQuery) && mover.TargetRelativeRotation.Equals(Angle.Zero))
if (!TryUpdateRelative(mover, XformQuery.GetComponent(uid)) && mover.TargetRelativeRotation.Equals(Angle.Zero))
return;
mover.LerpTarget = TimeSpan.Zero;
mover.TargetRelativeRotation = Angle.Zero;
Dirty(mover);
Dirty(uid, mover);
}
private bool TryUpdateRelative(InputMoverComponent mover, TransformComponent xform, EntityQuery<TransformComponent> xformQuery)
private bool TryUpdateRelative(InputMoverComponent mover, TransformComponent xform)
{
var relative = xform.GridUid;
relative ??= xform.MapUid;
@@ -165,15 +165,15 @@ namespace Content.Shared.Movement.Systems
var targetRotation = Angle.Zero;
// Get our current relative rotation
if (xformQuery.TryGetComponent(mover.RelativeEntity, out var oldRelativeXform))
if (XformQuery.TryGetComponent(mover.RelativeEntity, out var oldRelativeXform))
{
currentRotation = _transform.GetWorldRotation(oldRelativeXform, xformQuery) + mover.RelativeRotation;
currentRotation = _transform.GetWorldRotation(oldRelativeXform, XformQuery) + mover.RelativeRotation;
}
if (xformQuery.TryGetComponent(relative, out var relativeXform))
if (XformQuery.TryGetComponent(relative, out var relativeXform))
{
// This is our current rotation relative to our new parent.
mover.RelativeRotation = (currentRotation - _transform.GetWorldRotation(relativeXform, xformQuery)).FlipPositive();
mover.RelativeRotation = (currentRotation - _transform.GetWorldRotation(relativeXform)).FlipPositive();
}
// If we went from grid -> map we'll preserve our worldrotation
@@ -196,32 +196,24 @@ namespace Content.Shared.Movement.Systems
return true;
}
public Angle GetParentGridAngle(InputMoverComponent mover, EntityQuery<TransformComponent> xformQuery)
public Angle GetParentGridAngle(InputMoverComponent mover)
{
var rotation = mover.RelativeRotation;
if (xformQuery.TryGetComponent(mover.RelativeEntity, out var relativeXform))
return (_transform.GetWorldRotation(relativeXform, xformQuery) + rotation);
if (XformQuery.TryGetComponent(mover.RelativeEntity, out var relativeXform))
return _transform.GetWorldRotation(relativeXform) + rotation;
return rotation;
}
public Angle GetParentGridAngle(InputMoverComponent mover)
{
return GetParentGridAngle(mover, GetEntityQuery<TransformComponent>());
}
private void OnFollowedParentChange(EntityUid uid, FollowedComponent component, ref EntParentChangedMessage args)
{
var moverQuery = GetEntityQuery<InputMoverComponent>();
var xformQuery = GetEntityQuery<TransformComponent>();
foreach (var foll in component.Following)
{
if (!moverQuery.TryGetComponent(foll, out var mover))
if (!MoverQuery.TryGetComponent(foll, out var mover))
continue;
var ev = new EntParentChangedMessage(foll, null, args.OldMapId, xformQuery.GetComponent(foll));
var ev = new EntParentChangedMessage(foll, null, args.OldMapId, XformQuery.GetComponent(foll));
OnInputParentChange(foll, mover, ref ev);
}
}
@@ -235,7 +227,7 @@ namespace Content.Shared.Movement.Systems
if (component.LifeStage < ComponentLifeStage.Running)
{
component.RelativeEntity = relative;
Dirty(component);
Dirty(uid, component);
return;
}
@@ -249,7 +241,7 @@ namespace Content.Shared.Movement.Systems
component.TargetRelativeRotation = Angle.Zero;
component.RelativeRotation = Angle.Zero;
component.LerpTarget = TimeSpan.Zero;
Dirty(component);
Dirty(uid, component);
return;
}
@@ -259,14 +251,14 @@ namespace Content.Shared.Movement.Systems
if (component.LerpTarget >= Timing.CurTime)
{
component.LerpTarget = TimeSpan.Zero;
Dirty(component);
Dirty(uid, component);
}
return;
}
component.LerpTarget = TimeSpan.FromSeconds(InputMoverComponent.LerpTime) + Timing.CurTime;
Dirty(component);
Dirty(uid, component);
}
private void HandleDirChange(EntityUid entity, Direction dir, ushort subTick, bool state)
@@ -279,7 +271,7 @@ namespace Content.Shared.Movement.Systems
DebugTools.Assert(relayMover.RelayEntity != entity);
DebugTools.AssertNotNull(relayMover.RelayEntity);
if (TryComp<InputMoverComponent>(entity, out var mover))
if (MoverQuery.TryGetComponent(entity, out var mover))
SetMoveInput(mover, MoveButtons.None);
if (!_mobState.IsIncapacitated(entity))
@@ -288,7 +280,7 @@ namespace Content.Shared.Movement.Systems
return;
}
if (!TryComp<InputMoverComponent>(entity, out var moverComp))
if (!MoverQuery.TryGetComponent(entity, out var moverComp))
return;
// Relay the fact we had any movement event.
@@ -323,7 +315,7 @@ namespace Content.Shared.Movement.Systems
private void HandleRunChange(EntityUid uid, ushort subTick, bool walking)
{
TryComp<InputMoverComponent>(uid, out var moverComp);
MoverQuery.TryGetComponent(uid, out var moverComp);
if (TryComp<RelayInputMoverComponent>(uid, out var relayMover))
{

View File

@@ -29,27 +29,34 @@ namespace Content.Shared.Movement.Systems
/// </summary>
public abstract partial class SharedMoverController : VirtualController
{
[Dependency] private readonly IConfigurationManager _configManager = default!;
[Dependency] private readonly IConfigurationManager _configManager = default!;
[Dependency] protected readonly IGameTiming Timing = default!;
[Dependency] private readonly IMapManager _mapManager = default!;
[Dependency] private readonly ITileDefinitionManager _tileDefinitionManager = default!;
[Dependency] private readonly EntityLookupSystem _lookup = default!;
[Dependency] private readonly InventorySystem _inventory = default!;
[Dependency] private readonly MobStateSystem _mobState = default!;
[Dependency] private readonly SharedAudioSystem _audio = default!;
[Dependency] private readonly SharedContainerSystem _container = default!;
[Dependency] private readonly SharedGravitySystem _gravity = default!;
[Dependency] protected readonly SharedPhysicsSystem Physics = default!;
[Dependency] private readonly IMapManager _mapManager = default!;
[Dependency] private readonly ITileDefinitionManager _tileDefinitionManager = default!;
[Dependency] private readonly InventorySystem _inventory = default!;
[Dependency] private readonly SharedContainerSystem _container = default!;
[Dependency] private readonly EntityLookupSystem _lookup = default!;
[Dependency] private readonly SharedGravitySystem _gravity = default!;
[Dependency] private readonly MobStateSystem _mobState = default!;
[Dependency] private readonly SharedAudioSystem _audio = default!;
[Dependency] private readonly SharedTransformSystem _transform = default!;
[Dependency] private readonly TagSystem _tags = default!;
[Dependency] private readonly SharedTransformSystem _transform = default!;
[Dependency] private readonly TagSystem _tags = default!;
protected EntityQuery<InputMoverComponent> MoverQuery;
protected EntityQuery<MobMoverComponent> MobMoverQuery;
protected EntityQuery<MovementRelayTargetComponent> RelayTargetQuery;
protected EntityQuery<MovementSpeedModifierComponent> ModifierQuery;
protected EntityQuery<PhysicsComponent> PhysicsQuery;
protected EntityQuery<RelayInputMoverComponent> RelayQuery;
protected EntityQuery<SharedPullableComponent> PullableQuery;
protected EntityQuery<TransformComponent> XformQuery;
private const float StepSoundMoveDistanceRunning = 2;
private const float StepSoundMoveDistanceWalking = 1.5f;
private const float FootstepVariation = 0f;
protected ISawmill Sawmill = default!;
/// <summary>
/// <see cref="CCVars.StopSpeed"/>
/// </summary>
@@ -65,7 +72,16 @@ namespace Content.Shared.Movement.Systems
public override void Initialize()
{
base.Initialize();
Sawmill = Logger.GetSawmill("mover");
MoverQuery = GetEntityQuery<InputMoverComponent>();
MobMoverQuery = GetEntityQuery<MobMoverComponent>();
ModifierQuery = GetEntityQuery<MovementSpeedModifierComponent>();
RelayTargetQuery = GetEntityQuery<MovementRelayTargetComponent>();
PhysicsQuery = GetEntityQuery<PhysicsComponent>();
RelayQuery = GetEntityQuery<RelayInputMoverComponent>();
PullableQuery = GetEntityQuery<SharedPullableComponent>();
XformQuery = GetEntityQuery<TransformComponent>();
InitializeFootsteps();
InitializeInput();
InitializeMob();
@@ -101,19 +117,13 @@ namespace Content.Shared.Movement.Systems
EntityUid physicsUid,
PhysicsComponent physicsComponent,
TransformComponent xform,
float frameTime,
EntityQuery<TransformComponent> xformQuery,
EntityQuery<InputMoverComponent> moverQuery,
EntityQuery<MobMoverComponent> mobMoverQuery,
EntityQuery<MovementRelayTargetComponent> relayTargetQuery,
EntityQuery<SharedPullableComponent> pullableQuery,
EntityQuery<MovementSpeedModifierComponent> modifierQuery)
float frameTime)
{
var canMove = mover.CanMove;
if (relayTargetQuery.TryGetComponent(uid, out var relayTarget))
if (RelayTargetQuery.TryGetComponent(uid, out var relayTarget))
{
if (_mobState.IsIncapacitated(relayTarget.Source) ||
!moverQuery.TryGetComponent(relayTarget.Source, out var relayedMover))
!MoverQuery.TryGetComponent(relayTarget.Source, out var relayedMover))
{
canMove = false;
}
@@ -128,17 +138,17 @@ namespace Content.Shared.Movement.Systems
// Update relative movement
if (mover.LerpTarget < Timing.CurTime)
{
if (TryUpdateRelative(mover, xform, xformQuery))
if (TryUpdateRelative(mover, xform))
{
Dirty(mover);
Dirty(uid, mover);
}
}
LerpRotation(mover, frameTime);
LerpRotation(uid, mover, frameTime);
if (!canMove
|| physicsComponent.BodyStatus != BodyStatus.OnGround
|| pullableQuery.TryGetComponent(uid, out var pullable) && pullable.BeingPulled)
|| PullableQuery.TryGetComponent(uid, out var pullable) && pullable.BeingPulled)
{
UsedMobMovement[uid] = false;
return;
@@ -171,14 +181,14 @@ namespace Content.Shared.Movement.Systems
// Regular movement.
// Target velocity.
// This is relative to the map / grid we're on.
var moveSpeedComponent = modifierQuery.CompOrNull(uid);
var moveSpeedComponent = ModifierQuery.CompOrNull(uid);
var walkSpeed = moveSpeedComponent?.CurrentWalkSpeed ?? MovementSpeedModifierComponent.DefaultBaseWalkSpeed;
var sprintSpeed = moveSpeedComponent?.CurrentSprintSpeed ?? MovementSpeedModifierComponent.DefaultBaseSprintSpeed;
var total = walkDir * walkSpeed + sprintDir * sprintSpeed;
var parentRotation = GetParentGridAngle(mover, xformQuery);
var parentRotation = GetParentGridAngle(mover);
var worldTotal = _relativeMovement ? parentRotation.RotateVec(total) : total;
DebugTools.Assert(MathHelper.CloseToPercent(total.Length(), worldTotal.Length()));
@@ -223,7 +233,7 @@ namespace Content.Shared.Movement.Systems
// TODO apparently this results in a duplicate move event because "This should have its event run during
// island solver"??. So maybe SetRotation needs an argument to avoid raising an event?
if (!weightless && mobMoverQuery.TryGetComponent(uid, out var mobMover) &&
if (!weightless && MobMoverQuery.TryGetComponent(uid, out var mobMover) &&
TryGetSound(weightless, uid, mover, mobMover, xform, out var sound))
{
var soundModifier = mover.Sprinting ? 3.5f : 1.5f;
@@ -255,7 +265,7 @@ namespace Content.Shared.Movement.Systems
PhysicsSystem.SetAngularVelocity(physicsUid, 0, body: physicsComponent);
}
public void LerpRotation(InputMoverComponent mover, float frameTime)
public void LerpRotation(EntityUid uid, InputMoverComponent mover, float frameTime)
{
var angleDiff = Angle.ShortestDistance(mover.RelativeRotation, mover.TargetRelativeRotation);
@@ -278,13 +288,13 @@ namespace Content.Shared.Movement.Systems
mover.RelativeRotation += adjustment;
mover.RelativeRotation.FlipPositive();
Dirty(mover);
Dirty(uid, mover);
}
else if (!angleDiff.Equals(Angle.Zero))
{
mover.TargetRelativeRotation.FlipPositive();
mover.RelativeRotation = mover.TargetRelativeRotation;
Dirty(mover);
Dirty(uid, mover);
}
}