MovementAbility<T>
Class in Zigurous.CharacterController
Inherits from MovementControl<T>
Declaration
public abstract class MovementAbility<T> : MovementControl<T> where T : MovementAbilitySettings, new()Description
A type that performs a movement ability under given conditions.
Type Parameters
| T |
Properties
| movementFlags | The movement flag(s) associated with the ability. The flag(s) will be set when the ability is turned on and unset when the ability is turned off. |
| isActive | Whether the movement ability is active. This may be different than the input state depending on the type of control. |
| activated | The callback invoked when the movement ability is activated. |
| deactivated | The callback invoked when the movement ability is deactivated. |
| cooldown | The cooldown coroutine. |
| hasActiveCooldown | Whether the ability is currently on cooldown (Read only). |
Methods
| Cancel | Cancels the movement ability if it is active without checking whether the ability can be deactivated or not. This is essentially a force stop. |
| OnAbilityActivated | A callback invoked when the ability is activated. |
| OnAbilityDeactivated | A callback invoked when the ability is deactivated. |
| CanAbilityBeActivated | Determines if the ability can be activated given the current state of the character. |
| CanAbilityStayActive | Determines if the ability can stay active given the current state of the character. |
| CanAbilityBeDeactivated | Determines if the ability can be deactivated given the current state of the character. |
| CanTransitionToSelf | Determines if the ability can be activated if it is already active. |
| StartCooldown | Starts a cooldown for the ability. |
| OnCooldownFinished | A callback invoked when the ability cooldown is finished. |
Inherited
Properties
| settings | The settings for the behavior. |
| enabled | Enables or disables the behavior from being updated. |
| controller | The movement controller handling the process. |
| registered | Whether the process has been registered to a controller. |
| order | Determines the order in which processes are handled. The process with the lowest order value is handled first. |
| id | The unique identifier of the movement process. |