Some more Documentation
This commit is contained in:
		| @@ -29,12 +29,20 @@ namespace Syntriax.Modules.Movement | |||||||
|         } |         } | ||||||
|  |  | ||||||
|         public IToggleState ToggleState { get; protected set; } = null; |         public IToggleState ToggleState { get; protected set; } = null; | ||||||
|  |  | ||||||
|  |         /// <inheritdoc/> | ||||||
|         public abstract void ApplyMovement(); |         public abstract void ApplyMovement(); | ||||||
|  |  | ||||||
|         public abstract void Move(float x = 0, float y = 0, float z = 0); |         public abstract void Move(float x = 0, float y = 0, float z = 0); | ||||||
|  |  | ||||||
|  |         /// <summary> | ||||||
|  |         /// Called when this <see cref="IMovement"/> is activated.   | ||||||
|  |         /// </summary> | ||||||
|         protected abstract void OnActivated(); |         protected abstract void OnActivated(); | ||||||
|  |  | ||||||
|  |         /// <summary> | ||||||
|  |         /// Called when this <see cref="IMovement"/> is deactivated.   | ||||||
|  |         /// </summary> | ||||||
|         protected abstract void OnDeactivated(); |         protected abstract void OnDeactivated(); | ||||||
|  |  | ||||||
|         protected virtual void Start() |         protected virtual void Start() | ||||||
| @@ -46,6 +54,9 @@ namespace Syntriax.Modules.Movement | |||||||
|             movementController.OnMovementDeactivated += OnDeactivated; |             movementController.OnMovementDeactivated += OnDeactivated; | ||||||
|         } |         } | ||||||
|  |  | ||||||
|  |         /// <summary> | ||||||
|  |         /// Called when the <see cref="IMovementController"/> activates one of it's <see cref="IMovement"/>s.   | ||||||
|  |         /// </summary> | ||||||
|         private void OnActivated(IMovement movement) |         private void OnActivated(IMovement movement) | ||||||
|         { |         { | ||||||
|             if ((object)movement != this) |             if ((object)movement != this) | ||||||
| @@ -53,6 +64,10 @@ namespace Syntriax.Modules.Movement | |||||||
|             OnActivated(); |             OnActivated(); | ||||||
|         } |         } | ||||||
|  |  | ||||||
|  |  | ||||||
|  |         /// <summary> | ||||||
|  |         /// Called when the <see cref="IMovementController"/> activates one of it's <see cref="IMovement"/>s.   | ||||||
|  |         /// </summary> | ||||||
|         private void OnDeactivated(IMovement movement) |         private void OnDeactivated(IMovement movement) | ||||||
|         { |         { | ||||||
|             if ((object)movement != this) |             if ((object)movement != this) | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user