epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Changed documentation for OnEnterComplete

Browse Source
This commit is contained in:
thisisjacob
2020-05-12 10:11:10 -04:00
committed by atlimit8
parent 551ab2fc59
commit 8a07b762a2
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
OpenRA.Mods.Common/Activities/Enter.cs
View File

@@ -53,9 +53,9 @@ namespace OpenRA.Mods.Common.Activities
protected virtual bool TryStartEnter(Actor self, Actor targetActor) { return true; }
/// <summary>
/// Called when the actor has entered the target actor
/// Return true if the action succeeded and the actor should be Killed/Disposed
/// (assuming the relevant EnterBehaviour), or false if the actor should exit unharmed
/// Called when the actor has entered the target actor.
/// Actor will be be Killed/Disposed or they will exit unharmed.
/// Depends on either the EnterBehaviour of the actor or the requirements of an overriding function.
/// </summary>
protected virtual void OnEnterComplete(Actor self, Actor targetActor) { }