Class SharedDoAfterSystem
Inheritance
System.Object
SharedDoAfterSystem
Assembly: Content.Shared.dll
Syntax
public abstract class SharedDoAfterSystem : EntitySystem, EntitySystem
Fields
|
Improve this Doc
View Source
GameTiming
Declaration
protected readonly IGameTiming GameTiming
Field Value
| Type |
Description |
| Robust.Shared.Timing.IGameTiming |
|
Methods
|
Improve this Doc
View Source
Cancel(EntityUid, UInt16, DoAfterComponent)
Cancels an active DoAfter.
Declaration
public void Cancel(EntityUid entity, ushort id, DoAfterComponent comp = null)
Parameters
|
Improve this Doc
View Source
Cancel(Nullable<DoAfterId>, DoAfterComponent)
Cancels an active DoAfter.
Declaration
public void Cancel(DoAfterId? id, DoAfterComponent comp = null)
Parameters
| Type |
Name |
Description |
| System.Nullable<Content.Shared.DoAfter.DoAfterId> |
id |
|
| DoAfterComponent |
comp |
|
|
Improve this Doc
View Source
GetStatus(EntityUid, UInt16, DoAfterComponent)
Returns the current status of a DoAfter
Declaration
public DoAfterStatus GetStatus(EntityUid entity, ushort id, DoAfterComponent comp = null)
Parameters
Returns
|
Improve this Doc
View Source
GetStatus(Nullable<DoAfterId>, DoAfterComponent)
Returns the current status of a DoAfter
Declaration
public DoAfterStatus GetStatus(DoAfterId? id, DoAfterComponent comp = null)
Parameters
| Type |
Name |
Description |
| System.Nullable<Content.Shared.DoAfter.DoAfterId> |
id |
|
| DoAfterComponent |
comp |
|
Returns
|
Improve this Doc
View Source
Initialize()
Declaration
public override void Initialize()
|
Improve this Doc
View Source
TryStartDoAfter(DoAfterArgs, DoAfterComponent)
Attempts to start a new DoAfter. Note that even if this function returns true, an interaction may have
occured, as starting a duplicate DoAfter may cancel currently running DoAfters.
Declaration
public bool TryStartDoAfter(DoAfterArgs args, DoAfterComponent component = null)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
TryStartDoAfter(DoAfterArgs, out Nullable<DoAfterId>, DoAfterComponent)
Attempts to start a new DoAfter. Note that even if this function returns false, an interaction may have
occured, as starting a duplicate DoAfter may cancel currently running DoAfters.
Declaration
public bool TryStartDoAfter(DoAfterArgs args, out DoAfterId? id, DoAfterComponent comp = null)
Parameters
| Type |
Name |
Description |
| DoAfterArgs |
args |
The DoAfter arguments
|
| System.Nullable<Content.Shared.DoAfter.DoAfterId> |
id |
The Id of the newly started DoAfter
|
| DoAfterComponent |
comp |
The user's DoAfter component
|
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Update(EntityUid, ActiveDoAfterComponent, DoAfterComponent, TimeSpan, EntityQuery<TransformComponent>, EntityQuery<HandsComponent>)
Declaration
protected void Update(EntityUid uid, ActiveDoAfterComponent active, DoAfterComponent comp, TimeSpan time, EntityQuery<TransformComponent> xformQuery, EntityQuery<HandsComponent> handsQuery)
Parameters
|
Improve this Doc
View Source
Update(Single)
Declaration
public override void Update(float frameTime)
Parameters
| Type |
Name |
Description |
| System.Single |
frameTime |
|
|
Improve this Doc
View Source
WaitDoAfter(DoAfterArgs, DoAfterComponent)
Tasks that are delayed until the specified time has passed
These can be potentially cancelled by the user moving or when other things happen.
Declaration
public Task<DoAfterStatus> WaitDoAfter(DoAfterArgs doAfter, DoAfterComponent component = null)
Parameters
Returns
Implements
EntitySystem