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

DoAfter can now raise events so you don't need to use async with it (#4253)

Browse Source
This commit is contained in:
Vera Aguilera Puerto
2021-07-04 13:32:24 +02:00
committed by GitHub
parent d5e34c6ad4
commit ef958185fb
21 changed files with 106 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Content.IntegrationTests/Tests/DoAfter/DoAfterServerTest.cs
View File

@@ -39,7 +39,7 @@ namespace Content.IntegrationTests.Tests.DoAfter
var mob = entityManager.SpawnEntity("Dummy", MapCoordinates.Nullspace);
var cancelToken = new CancellationTokenSource();
var args = new DoAfterEventArgs(mob, tickTime / 2, cancelToken.Token);
task = EntitySystem.Get<DoAfterSystem>().DoAfter(args);
task = EntitySystem.Get<DoAfterSystem>().WaitDoAfter(args);
});
await server.WaitRunTicks(1);
@@ -62,7 +62,7 @@ namespace Content.IntegrationTests.Tests.DoAfter
var mob = entityManager.SpawnEntity("Dummy", MapCoordinates.Nullspace);
var cancelToken = new CancellationTokenSource();
var args = new DoAfterEventArgs(mob, tickTime * 2, cancelToken.Token);
task = EntitySystem.Get<DoAfterSystem>().DoAfter(args);
task = EntitySystem.Get<DoAfterSystem>().WaitDoAfter(args);
cancelToken.Cancel();
});

2
Content.Server/Body/Surgery/BiologicalSurgeryDataComponent.cs
View File

@@ -68,7 +68,7 @@ namespace Content.Server.Body.Surgery
BreakOnTargetMove = true
};
return await doAfterSystem.DoAfter(args) == DoAfterStatus.Finished;
return await doAfterSystem.WaitDoAfter(args) == DoAfterStatus.Finished;
}
private bool HasIncisionNotClamped()

4
Content.Server/Climbing/Components/ClimbableComponent.cs
View File

@@ -157,7 +157,7 @@ namespace Content.Server.Climbing.Components
BreakOnStun = true
};
var result = await EntitySystem.Get<DoAfterSystem>().DoAfter(doAfterEventArgs);
var result = await EntitySystem.Get<DoAfterSystem>().WaitDoAfter(doAfterEventArgs);
if (result != DoAfterStatus.Cancelled && entityToMove.TryGetComponent(out PhysicsComponent? body) && body.Fixtures.Count >= 1)
{
@@ -204,7 +204,7 @@ namespace Content.Server.Climbing.Components
BreakOnStun = true
};
var result = await EntitySystem.Get<DoAfterSystem>().DoAfter(doAfterEventArgs);
var result = await EntitySystem.Get<DoAfterSystem>().WaitDoAfter(doAfterEventArgs);
if (result != DoAfterStatus.Cancelled && user.TryGetComponent(out PhysicsComponent? body) && body.Fixtures.Count >= 1)
{

4
Content.Server/Construction/Components/ConstructionComponent.cs
View File

@@ -258,7 +258,7 @@ namespace Content.Server.Construction.Components
{
case ArbitraryInsertConstructionGraphStep arbitraryStep:
if (arbitraryStep.EntityValid(eventArgs.Using)
&& await doAfterSystem.DoAfter(doAfterArgs) == DoAfterStatus.Finished)
&& await doAfterSystem.WaitDoAfter(doAfterArgs) == DoAfterStatus.Finished)
{
valid = true;
}
@@ -267,7 +267,7 @@ namespace Content.Server.Construction.Components
case MaterialConstructionGraphStep materialStep:
if (materialStep.EntityValid(eventArgs.Using, out var stack)
&& await doAfterSystem.DoAfter(doAfterArgs) == DoAfterStatus.Finished)
&& await doAfterSystem.WaitDoAfter(doAfterArgs) == DoAfterStatus.Finished)
{
var splitStack = EntitySystem.Get<StackSystem>().Split(eventArgs.Using.Uid, stack, materialStep.Amount, eventArgs.User.Transform.Coordinates);

2
Content.Server/Construction/ConstructionSystem.cs
View File

@@ -238,7 +238,7 @@ namespace Content.Server.Construction
NeedHand = false,
};
if (await doAfterSystem.DoAfter(doAfterArgs) == DoAfterStatus.Cancelled)
if (await doAfterSystem.WaitDoAfter(doAfterArgs) == DoAfterStatus.Cancelled)
{
FailCleanup();
return null;

2
Content.Server/Cuffs/Components/CuffableComponent.cs
View File

@@ -253,7 +253,7 @@ namespace Content.Server.Cuffs.Components
var doAfterSystem = EntitySystem.Get<DoAfterSystem>();
_uncuffing = true;
var result = await doAfterSystem.DoAfter(doAfterEventArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterEventArgs);
_uncuffing = false;

2
Content.Server/Cuffs/Components/HandcuffComponent.cs
View File

@@ -214,7 +214,7 @@ namespace Content.Server.Cuffs.Components
_cuffing = true;
var result = await EntitySystem.Get<DoAfterSystem>().DoAfter(doAfterEventArgs);
var result = await EntitySystem.Get<DoAfterSystem>().WaitDoAfter(doAfterEventArgs);
_cuffing = false;

2
Content.Server/Disposal/Mailing/DisposalMailingUnitComponent.cs
View File

@@ -217,7 +217,7 @@ namespace Content.Server.Disposal.Mailing
NeedHand = false,
};
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
if (result == DoAfterStatus.Cancelled)
return false;

2
Content.Server/Disposal/Unit/Components/DisposalUnitComponent.cs
View File

@@ -196,7 +196,7 @@ namespace Content.Server.Disposal.Unit.Components
NeedHand = false,
};
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
if (result == DoAfterStatus.Cancelled)
return false;

3
Content.Server/DoAfter/DoAfter.cs
View File

@@ -4,6 +4,7 @@ using System.Threading.Tasks;
using Content.Server.Hands.Components;
using Content.Server.Items;
using Content.Server.Stunnable.Components;
using Robust.Shared.GameObjects;
using Robust.Shared.IoC;
using Robust.Shared.Map;
using Robust.Shared.Timing;
@@ -16,7 +17,7 @@ namespace Content.Server.DoAfter
private TaskCompletionSource<DoAfterStatus> Tcs { get; }
public DoAfterEventArgs EventArgs;
public readonly DoAfterEventArgs EventArgs;
public TimeSpan StartTime { get; }

30
Content.Server/DoAfter/DoAfterEventArgs.cs
View File

@@ -81,6 +81,36 @@ namespace Content.Server.DoAfter
/// </summary>
public Func<bool>? ExtraCheck { get; set; }
/// <summary>
/// Event to be raised directed to the <see cref="User"/> entity when the DoAfter is cancelled.
/// </summary>
public EntityEventArgs? UserCancelledEvent { get; set; }
/// <summary>
/// Event to be raised directed to the <see cref="User"/> entity when the DoAfter is finished successfully.
/// </summary>
public EntityEventArgs? UserFinishedEvent { get; set; }
/// <summary>
/// Event to be raised directed to the <see cref="User"/> entity when the DoAfter is cancelled.
/// </summary>
public EntityEventArgs? TargetCancelledEvent { get; set; }
/// <summary>
/// Event to be raised directed to the <see cref="User"/> entity when the DoAfter is finished successfully.
/// </summary>
public EntityEventArgs? TargetFinishedEvent { get; set; }
/// <summary>
/// Event to be broadcast when the DoAfter is cancelled.
/// </summary>
public object? BroadcastCancelledEvent { get; set; }
/// <summary>
/// Event to be broadcast when the DoAfter is finished successfully.
/// </summary>
public object? BroadcastFinishedEvent { get; set; }
public DoAfterEventArgs(
IEntity user,
float delay,

63
Content.Server/DoAfter/DoAfterSystem.cs
View File

@@ -11,15 +11,16 @@ namespace Content.Server.DoAfter
[UsedImplicitly]
public sealed class DoAfterSystem : EntitySystem
{
// We cache these lists as to not allocate them every update tick...
private readonly List<DoAfter> _cancelled = new();
private readonly List<DoAfter> _finished = new();
public override void Update(float frameTime)
{
base.Update(frameTime);
foreach (var comp in ComponentManager.EntityQuery<DoAfterComponent>(true))
{
var cancelled = new List<DoAfter>(0);
var finished = new List<DoAfter>(0);
foreach (var doAfter in comp.DoAfters.ToArray())
{
doAfter.Run(frameTime);
@@ -29,27 +30,47 @@ namespace Content.Server.DoAfter
case DoAfterStatus.Running:
break;
case DoAfterStatus.Cancelled:
cancelled.Add(doAfter);
_cancelled.Add(doAfter);
break;
case DoAfterStatus.Finished:
finished.Add(doAfter);
_finished.Add(doAfter);
break;
default:
throw new ArgumentOutOfRangeException();
}
}
foreach (var doAfter in cancelled)
foreach (var doAfter in _cancelled)
{
comp.Cancelled(doAfter);
if(!doAfter.EventArgs.User.Deleted && doAfter.EventArgs.UserCancelledEvent != null)
RaiseLocalEvent(doAfter.EventArgs.User.Uid, doAfter.EventArgs.UserCancelledEvent, false);
if(doAfter.EventArgs.Target is { Deleted: false } && doAfter.EventArgs.TargetCancelledEvent != null)
RaiseLocalEvent(doAfter.EventArgs.Target.Uid, doAfter.EventArgs.TargetCancelledEvent, false);
if(doAfter.EventArgs.BroadcastCancelledEvent != null)
RaiseLocalEvent(doAfter.EventArgs.BroadcastCancelledEvent);
}
foreach (var doAfter in finished)
foreach (var doAfter in _finished)
{
comp.Finished(doAfter);
if(!doAfter.EventArgs.User.Deleted && doAfter.EventArgs.UserFinishedEvent != null)
RaiseLocalEvent(doAfter.EventArgs.User.Uid, doAfter.EventArgs.UserFinishedEvent, false);
if(doAfter.EventArgs.Target is { Deleted: false } && doAfter.EventArgs.TargetFinishedEvent != null)
RaiseLocalEvent(doAfter.EventArgs.Target.Uid, doAfter.EventArgs.TargetFinishedEvent, false);
if(doAfter.EventArgs.BroadcastFinishedEvent != null)
RaiseLocalEvent(doAfter.EventArgs.BroadcastFinishedEvent);
}
finished.Clear();
// Clean the shared lists at the end, ensuring they'll be clean for the next time we need them.
_cancelled.Clear();
_finished.Clear();
}
}
@@ -59,17 +80,33 @@ namespace Content.Server.DoAfter
/// </summary>
/// <param name="eventArgs"></param>
/// <returns></returns>
public async Task<DoAfterStatus> DoAfter(DoAfterEventArgs eventArgs)
public async Task<DoAfterStatus> WaitDoAfter(DoAfterEventArgs eventArgs)
{
var doAfter = CreateDoAfter(eventArgs);
await doAfter.AsTask;
return doAfter.Status;
}
/// <summary>
/// Creates a DoAfter without waiting for it to finish. You can use events with this.
/// These can be potentially cancelled by the user moving or when other things happen.
/// </summary>
/// <param name="eventArgs"></param>
public void DoAfter(DoAfterEventArgs eventArgs)
{
CreateDoAfter(eventArgs);
}
private DoAfter CreateDoAfter(DoAfterEventArgs eventArgs)
{
// Setup
var doAfter = new DoAfter(eventArgs);
// Caller's gonna be responsible for this I guess
var doAfterComponent = eventArgs.User.GetComponent<DoAfterComponent>();
doAfterComponent.Add(doAfter);
await doAfter.AsTask;
return doAfter.Status;
return doAfter;
}
}

2
Content.Server/Engineering/EntitySystems/DisassembleOnActivateSystem.cs
View File

@@ -33,7 +33,7 @@ namespace Content.Server.Engineering.EntitySystems
BreakOnUserMove = true,
BreakOnStun = true,
};
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
if (result != DoAfterStatus.Finished)
return;

2
Content.Server/Engineering/EntitySystems/SpawnAfterInteractSystem.cs
View File

@@ -50,7 +50,7 @@ namespace Content.Server.Engineering.EntitySystems
BreakOnStun = true,
PostCheck = IsTileClear,
};
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
if (result != DoAfterStatus.Finished)
return;

2
Content.Server/Fluids/Components/BucketComponent.cs
View File

@@ -82,7 +82,7 @@ namespace Content.Server.Fluids.Components
BreakOnStun = true,
BreakOnDamage = true,
};
var result = await EntitySystem.Get<DoAfterSystem>().DoAfter(doAfterArgs);
var result = await EntitySystem.Get<DoAfterSystem>().WaitDoAfter(doAfterArgs);
_currentlyUsing.Remove(eventArgs.Using.Uid);

2
Content.Server/Fluids/Components/MopComponent.cs
View File

@@ -123,7 +123,7 @@ namespace Content.Server.Fluids.Components
BreakOnStun = true,
BreakOnDamage = true,
};
var result = await EntitySystem.Get<DoAfterSystem>().DoAfter(doAfterArgs);
var result = await EntitySystem.Get<DoAfterSystem>().WaitDoAfter(doAfterArgs);
Mopping = false;

2
Content.Server/Kitchen/Components/KitchenSpikeComponent.cs
View File

@@ -133,7 +133,7 @@ namespace Content.Server.Kitchen.Components
_beingButchered.Add(victimUid);
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
_beingButchered.Remove(victimUid);

2
Content.Server/RCD/Components/RCDComponent.cs
View File

@@ -119,7 +119,7 @@ namespace Content.Server.RCD.Components
ExtraCheck = () => IsRCDStillValid(eventArgs, mapGrid, tile, snapPos, startingMode) //All of the sanity checks are here
};
var result = await _doAfterSystem.DoAfter(doAfterEventArgs);
var result = await _doAfterSystem.WaitDoAfter(doAfterEventArgs);
if (result == DoAfterStatus.Cancelled)
{
return true;

2
Content.Server/Storage/Components/ServerStorageComponent.cs
View File

@@ -522,7 +522,7 @@ namespace Content.Server.Storage.Components
BreakOnUserMove = true,
NeedHand = true,
};
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
if (result != DoAfterStatus.Finished) return true;
}

8
Content.Server/Strip/StrippableComponent.cs
View File

@@ -197,7 +197,7 @@ namespace Content.Server.Strip
NeedHand = true,
};
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
if (result != DoAfterStatus.Finished) return;
userHands.Drop(item!.Owner, false);
@@ -264,7 +264,7 @@ namespace Content.Server.Strip
NeedHand = true,
};
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
if (result != DoAfterStatus.Finished) return;
userHands.Drop(hand);
@@ -314,7 +314,7 @@ namespace Content.Server.Strip
BreakOnUserMove = true,
};
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
if (result != DoAfterStatus.Finished) return;
var item = inventory.GetSlotItem(slot);
@@ -370,7 +370,7 @@ namespace Content.Server.Strip
BreakOnUserMove = true,
};
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
if (result != DoAfterStatus.Finished) return;
var item = hands.GetItem(hand);

2
Content.Server/Tools/Components/ToolComponent.cs
View File

@@ -85,7 +85,7 @@ namespace Content.Server.Tools.Components
NeedHand = true,
};
var result = await doAfterSystem.DoAfter(doAfterArgs);
var result = await doAfterSystem.WaitDoAfter(doAfterArgs);
if (result == DoAfterStatus.Cancelled)
return false;