From 8a07b762a20fb53cab83e6d1ef96e27671d5c4cc Mon Sep 17 00:00:00 2001 From: thisisjacob Date: Tue, 12 May 2020 10:11:10 -0400 Subject: [PATCH] Changed documentation for OnEnterComplete --- OpenRA.Mods.Common/Activities/Enter.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/OpenRA.Mods.Common/Activities/Enter.cs b/OpenRA.Mods.Common/Activities/Enter.cs index 976120c5f9..a768f8c936 100644 --- a/OpenRA.Mods.Common/Activities/Enter.cs +++ b/OpenRA.Mods.Common/Activities/Enter.cs @@ -53,9 +53,9 @@ namespace OpenRA.Mods.Common.Activities protected virtual bool TryStartEnter(Actor self, Actor targetActor) { return true; } /// - /// 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. /// protected virtual void OnEnterComplete(Actor self, Actor targetActor) { }