MovementAbility<T>

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

movementFlagsThe 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.
isActiveWhether the movement ability is active. This may be different than the input state depending on the type of control.
activatedThe callback invoked when the movement ability is activated.
deactivatedThe callback invoked when the movement ability is deactivated.
cooldownThe cooldown coroutine.
hasActiveCooldownWhether the ability is currently on cooldown (Read only).

Methods

CancelCancels the movement ability if it is active without checking whether the ability can be deactivated or not. This is essentially a force stop.
OnAbilityActivatedA callback invoked when the ability is activated.
OnAbilityDeactivatedA callback invoked when the ability is deactivated.
CanAbilityBeActivatedDetermines if the ability can be activated given the current state of the character.
CanAbilityStayActiveDetermines if the ability can stay active given the current state of the character.
CanAbilityBeDeactivatedDetermines if the ability can be deactivated given the current state of the character.
CanTransitionToSelfDetermines if the ability can be activated if it is already active.
StartCooldownStarts a cooldown for the ability.
OnCooldownFinishedA callback invoked when the ability cooldown is finished.
Inherited

Properties

settingsThe settings for the behavior.
enabledEnables or disables the behavior from being updated.
controllerThe movement controller handling the process.
registeredWhether the process has been registered to a controller.
orderDetermines the order in which processes are handled. The process with the lowest order value is handled first.
idThe unique identifier of the movement process.