From e2c1f186af15a281e283d65c10c9cb92862e0d24 Mon Sep 17 00:00:00 2001 From: Syntriax Date: Sun, 20 Nov 2022 13:32:06 +0300 Subject: [PATCH] Some more Documentation --- Bases/MovementBase.cs | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/Bases/MovementBase.cs b/Bases/MovementBase.cs index 8d116a9..2181431 100644 --- a/Bases/MovementBase.cs +++ b/Bases/MovementBase.cs @@ -29,12 +29,20 @@ namespace Syntriax.Modules.Movement } public IToggleState ToggleState { get; protected set; } = null; + + /// public abstract void ApplyMovement(); public abstract void Move(float x = 0, float y = 0, float z = 0); + /// + /// Called when this is activated. + /// protected abstract void OnActivated(); + /// + /// Called when this is deactivated. + /// protected abstract void OnDeactivated(); protected virtual void Start() @@ -46,6 +54,9 @@ namespace Syntriax.Modules.Movement movementController.OnMovementDeactivated += OnDeactivated; } + /// + /// Called when the activates one of it's s. + /// private void OnActivated(IMovement movement) { if ((object)movement != this) @@ -53,6 +64,10 @@ namespace Syntriax.Modules.Movement OnActivated(); } + + /// + /// Called when the activates one of it's s. + /// private void OnDeactivated(IMovement movement) { if ((object)movement != this)