DoAfter Refactor (#13225)
Co-authored-by: DrSmugleaf <drsmugleaf@gmail.com>
This commit is contained in:
keronshb
@@ -1,223 +1,182 @@
|
||||
using Content.Shared.DoAfter;
|
||||
using JetBrains.Annotations;
|
||||
using Robust.Client.Graphics;
|
||||
using Robust.Client.Player;
|
||||
using Robust.Shared.GameStates;
|
||||
using Robust.Shared.Prototypes;
|
||||
using Robust.Shared.Timing;
|
||||
using Robust.Shared.Utility;
|
||||
|
||||
namespace Content.Client.DoAfter
|
||||
namespace Content.Client.DoAfter;
|
||||
|
||||
/// <summary>
|
||||
/// Handles events that need to happen after a certain amount of time where the event could be cancelled by factors
|
||||
/// such as moving.
|
||||
/// </summary>
|
||||
public sealed class DoAfterSystem : SharedDoAfterSystem
|
||||
{
|
||||
[Dependency] private readonly IOverlayManager _overlay = default!;
|
||||
[Dependency] private readonly IPlayerManager _player = default!;
|
||||
[Dependency] private readonly IPrototypeManager _prototype = default!;
|
||||
|
||||
/// <summary>
|
||||
/// Handles events that need to happen after a certain amount of time where the event could be cancelled by factors
|
||||
/// such as moving.
|
||||
/// We'll use an excess time so stuff like finishing effects can show.
|
||||
/// </summary>
|
||||
[UsedImplicitly]
|
||||
public sealed class DoAfterSystem : EntitySystem
|
||||
public const float ExcessTime = 0.5f;
|
||||
|
||||
public override void Initialize()
|
||||
{
|
||||
[Dependency] private readonly IGameTiming _gameTiming = default!;
|
||||
[Dependency] private readonly IOverlayManager _overlay = default!;
|
||||
[Dependency] private readonly IPlayerManager _player = default!;
|
||||
[Dependency] private readonly IPrototypeManager _prototype = default!;
|
||||
base.Initialize();
|
||||
UpdatesOutsidePrediction = true;
|
||||
SubscribeNetworkEvent<CancelledDoAfterMessage>(OnCancelledDoAfter);
|
||||
SubscribeLocalEvent<DoAfterComponent, ComponentHandleState>(OnDoAfterHandleState);
|
||||
_overlay.AddOverlay(new DoAfterOverlay(EntityManager, _prototype));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// We'll use an excess time so stuff like finishing effects can show.
|
||||
/// </summary>
|
||||
public const float ExcessTime = 0.5f;
|
||||
public override void Shutdown()
|
||||
{
|
||||
base.Shutdown();
|
||||
_overlay.RemoveOverlay<DoAfterOverlay>();
|
||||
}
|
||||
|
||||
public override void Initialize()
|
||||
private void OnDoAfterHandleState(EntityUid uid, DoAfterComponent component, ref ComponentHandleState args)
|
||||
{
|
||||
if (args.Current is not DoAfterComponentState state)
|
||||
return;
|
||||
|
||||
foreach (var (_, doAfter) in state.DoAfters)
|
||||
{
|
||||
base.Initialize();
|
||||
UpdatesOutsidePrediction = true;
|
||||
SubscribeNetworkEvent<CancelledDoAfterMessage>(OnCancelledDoAfter);
|
||||
SubscribeLocalEvent<DoAfterComponent, ComponentHandleState>(OnDoAfterHandleState);
|
||||
_overlay.AddOverlay(
|
||||
new DoAfterOverlay(
|
||||
EntityManager,
|
||||
_prototype));
|
||||
if (component.DoAfters.ContainsKey(doAfter.ID))
|
||||
continue;
|
||||
|
||||
component.DoAfters.Add(doAfter.ID, doAfter);
|
||||
}
|
||||
}
|
||||
|
||||
public override void Shutdown()
|
||||
private void OnCancelledDoAfter(CancelledDoAfterMessage ev)
|
||||
{
|
||||
if (!TryComp<DoAfterComponent>(ev.Uid, out var doAfter))
|
||||
return;
|
||||
|
||||
Cancel(doAfter, ev.ID);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Remove a DoAfter without showing a cancellation graphic.
|
||||
/// </summary>
|
||||
public void Remove(DoAfterComponent component, Shared.DoAfter.DoAfter doAfter, bool found = false)
|
||||
{
|
||||
component.DoAfters.Remove(doAfter.ID);
|
||||
component.CancelledDoAfters.Remove(doAfter.ID);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Mark a DoAfter as cancelled and show a cancellation graphic.
|
||||
/// </summary>
|
||||
/// Actual removal is handled by DoAfterEntitySystem.
|
||||
public void Cancel(DoAfterComponent component, byte id)
|
||||
{
|
||||
if (component.CancelledDoAfters.ContainsKey(id))
|
||||
return;
|
||||
|
||||
if (!component.DoAfters.ContainsKey(id))
|
||||
return;
|
||||
|
||||
var doAfterMessage = component.DoAfters[id];
|
||||
doAfterMessage.Cancelled = true;
|
||||
doAfterMessage.CancelledTime = GameTiming.CurTime;
|
||||
component.CancelledDoAfters.Add(id, doAfterMessage);
|
||||
}
|
||||
|
||||
// TODO separate DoAfter & ActiveDoAfter components for the entity query.
|
||||
public override void Update(float frameTime)
|
||||
{
|
||||
if (!GameTiming.IsFirstTimePredicted)
|
||||
return;
|
||||
|
||||
var playerEntity = _player.LocalPlayer?.ControlledEntity;
|
||||
|
||||
foreach (var (comp, xform) in EntityQuery<DoAfterComponent, TransformComponent>())
|
||||
{
|
||||
base.Shutdown();
|
||||
_overlay.RemoveOverlay<DoAfterOverlay>();
|
||||
}
|
||||
var doAfters = comp.DoAfters;
|
||||
|
||||
private void OnDoAfterHandleState(EntityUid uid, DoAfterComponent component, ref ComponentHandleState args)
|
||||
{
|
||||
if (args.Current is not DoAfterComponentState state)
|
||||
return;
|
||||
if (doAfters.Count == 0)
|
||||
continue;
|
||||
|
||||
var toRemove = new RemQueue<ClientDoAfter>();
|
||||
var userGrid = xform.Coordinates;
|
||||
var toRemove = new RemQueue<Shared.DoAfter.DoAfter>();
|
||||
|
||||
foreach (var (id, doAfter) in component.DoAfters)
|
||||
// Check cancellations / finishes
|
||||
foreach (var (id, doAfter) in doAfters)
|
||||
{
|
||||
var found = false;
|
||||
|
||||
foreach (var clientdoAfter in state.DoAfters)
|
||||
// If we've passed the final time (after the excess to show completion graphic) then remove.
|
||||
if ((float)doAfter.Elapsed.TotalSeconds + (float)doAfter.CancelledElapsed.TotalSeconds >
|
||||
doAfter.Delay + ExcessTime)
|
||||
{
|
||||
if (clientdoAfter.ID == id)
|
||||
toRemove.Add(doAfter);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (doAfter.Cancelled)
|
||||
{
|
||||
doAfter.CancelledElapsed = GameTiming.CurTime - doAfter.CancelledTime;
|
||||
continue;
|
||||
}
|
||||
|
||||
doAfter.Elapsed = GameTiming.CurTime - doAfter.StartTime;
|
||||
|
||||
// Well we finished so don't try to predict cancels.
|
||||
if ((float)doAfter.Elapsed.TotalSeconds > doAfter.Delay)
|
||||
continue;
|
||||
|
||||
// Predictions
|
||||
if (comp.Owner != playerEntity)
|
||||
continue;
|
||||
|
||||
// TODO: Add these back in when I work out some system for changing the accumulation rate
|
||||
// based on ping. Right now these would show as cancelled near completion if we moved at the end
|
||||
// despite succeeding.
|
||||
continue;
|
||||
|
||||
if (doAfter.EventArgs.BreakOnUserMove)
|
||||
{
|
||||
if (!userGrid.InRange(EntityManager, doAfter.UserGrid, doAfter.EventArgs.MovementThreshold))
|
||||
{
|
||||
found = true;
|
||||
break;
|
||||
Cancel(comp, id);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
if (!found)
|
||||
if (doAfter.EventArgs.BreakOnTargetMove)
|
||||
{
|
||||
toRemove.Add(doAfter);
|
||||
if (!Deleted(doAfter.EventArgs.Target) &&
|
||||
!Transform(doAfter.EventArgs.Target.Value).Coordinates.InRange(EntityManager,
|
||||
doAfter.TargetGrid,
|
||||
doAfter.EventArgs.MovementThreshold))
|
||||
{
|
||||
Cancel(comp, id);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
foreach (var doAfter in toRemove)
|
||||
{
|
||||
Remove(component, doAfter);
|
||||
Remove(comp, doAfter);
|
||||
}
|
||||
|
||||
foreach (var doAfter in state.DoAfters)
|
||||
{
|
||||
if (component.DoAfters.ContainsKey(doAfter.ID))
|
||||
continue;
|
||||
// Remove cancelled DoAfters after ExcessTime has elapsed
|
||||
var toRemoveCancelled = new RemQueue<Shared.DoAfter.DoAfter>();
|
||||
|
||||
component.DoAfters.Add(doAfter.ID, doAfter);
|
||||
foreach (var (_, doAfter) in comp.CancelledDoAfters)
|
||||
{
|
||||
var cancelledElapsed = (float)doAfter.CancelledElapsed.TotalSeconds;
|
||||
|
||||
if (cancelledElapsed > ExcessTime)
|
||||
toRemoveCancelled.Add(doAfter);
|
||||
}
|
||||
}
|
||||
|
||||
private void OnCancelledDoAfter(CancelledDoAfterMessage ev)
|
||||
{
|
||||
if (!TryComp<DoAfterComponent>(ev.Uid, out var doAfter))
|
||||
return;
|
||||
|
||||
Cancel(doAfter, ev.ID);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Remove a DoAfter without showing a cancellation graphic.
|
||||
/// </summary>
|
||||
public void Remove(DoAfterComponent component, ClientDoAfter clientDoAfter)
|
||||
{
|
||||
component.DoAfters.Remove(clientDoAfter.ID);
|
||||
|
||||
var found = false;
|
||||
|
||||
component.CancelledDoAfters.Remove(clientDoAfter.ID);
|
||||
|
||||
if (!found)
|
||||
component.DoAfters.Remove(clientDoAfter.ID);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Mark a DoAfter as cancelled and show a cancellation graphic.
|
||||
/// </summary>
|
||||
/// Actual removal is handled by DoAfterEntitySystem.
|
||||
public void Cancel(DoAfterComponent component, byte id)
|
||||
{
|
||||
if (component.CancelledDoAfters.ContainsKey(id))
|
||||
return;
|
||||
|
||||
if (!component.DoAfters.ContainsKey(id))
|
||||
return;
|
||||
|
||||
var doAfterMessage = component.DoAfters[id];
|
||||
doAfterMessage.Cancelled = true;
|
||||
component.CancelledDoAfters.Add(id, doAfterMessage);
|
||||
}
|
||||
|
||||
// TODO separate DoAfter & ActiveDoAfter components for the entity query.
|
||||
public override void Update(float frameTime)
|
||||
{
|
||||
if (!_gameTiming.IsFirstTimePredicted)
|
||||
return;
|
||||
|
||||
var playerEntity = _player.LocalPlayer?.ControlledEntity;
|
||||
|
||||
foreach (var (comp, xform) in EntityQuery<DoAfterComponent, TransformComponent>())
|
||||
foreach (var doAfter in toRemoveCancelled)
|
||||
{
|
||||
var doAfters = comp.DoAfters;
|
||||
|
||||
if (doAfters.Count == 0)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
var userGrid = xform.Coordinates;
|
||||
var toRemove = new RemQueue<ClientDoAfter>();
|
||||
|
||||
// Check cancellations / finishes
|
||||
foreach (var (id, doAfter) in doAfters)
|
||||
{
|
||||
// If we've passed the final time (after the excess to show completion graphic) then remove.
|
||||
if ((doAfter.Accumulator + doAfter.CancelledAccumulator) > doAfter.Delay + ExcessTime)
|
||||
{
|
||||
toRemove.Add(doAfter);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (doAfter.Cancelled)
|
||||
{
|
||||
doAfter.CancelledAccumulator += frameTime;
|
||||
continue;
|
||||
}
|
||||
|
||||
doAfter.Accumulator += frameTime;
|
||||
|
||||
// Well we finished so don't try to predict cancels.
|
||||
if (doAfter.Accumulator > doAfter.Delay)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
// Predictions
|
||||
if (comp.Owner != playerEntity)
|
||||
continue;
|
||||
|
||||
// TODO: Add these back in when I work out some system for changing the accumulation rate
|
||||
// based on ping. Right now these would show as cancelled near completion if we moved at the end
|
||||
// despite succeeding.
|
||||
continue;
|
||||
|
||||
if (doAfter.BreakOnUserMove)
|
||||
{
|
||||
if (!userGrid.InRange(EntityManager, doAfter.UserGrid, doAfter.MovementThreshold))
|
||||
{
|
||||
Cancel(comp, id);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
if (doAfter.BreakOnTargetMove)
|
||||
{
|
||||
if (!EntityManager.Deleted(doAfter.Target) &&
|
||||
!Transform(doAfter.Target.Value).Coordinates.InRange(EntityManager, doAfter.TargetGrid,
|
||||
doAfter.MovementThreshold))
|
||||
{
|
||||
Cancel(comp, id);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
foreach (var doAfter in toRemove)
|
||||
{
|
||||
Remove(comp, doAfter);
|
||||
}
|
||||
|
||||
// Remove cancelled DoAfters after ExcessTime has elapsed
|
||||
var toRemoveCancelled = new List<ClientDoAfter>();
|
||||
|
||||
foreach (var (_, doAfter) in comp.CancelledDoAfters)
|
||||
{
|
||||
if (doAfter.CancelledAccumulator > ExcessTime)
|
||||
{
|
||||
toRemoveCancelled.Add(doAfter);
|
||||
}
|
||||
}
|
||||
|
||||
foreach (var doAfter in toRemoveCancelled)
|
||||
{
|
||||
Remove(comp, doAfter);
|
||||
}
|
||||
Remove(comp, doAfter);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user