TopDown Engine
v4.2
|
A class meant to be overridden that handles a character's ability. More...
Public Member Functions | |
delegate void | AbilityEvent () |
virtual string | HelpBoxText () |
This method is only used to display a helpbox text at the beginning of the ability's inspector. More... | |
virtual void | ForceInitialization () |
Call this any time you want to force this ability to initialize (again) More... | |
virtual void | ResetInput () |
Resets all input for this ability. Can be overridden for ability specific directives More... | |
virtual void | EarlyProcessAbility () |
The first of the 3 passes you can have in your ability. Think of it as EarlyUpdate() if it existed More... | |
virtual void | ProcessAbility () |
The second of the 3 passes you can have in your ability. Think of it as Update() More... | |
virtual void | LateProcessAbility () |
The last of the 3 passes you can have in your ability. Think of it as LateUpdate() More... | |
virtual void | UpdateAnimator () |
Override this to send parameters to the character's animator. This is called once per cycle, by the Character class, after Early, normal and Late process(). More... | |
virtual void | PermitAbility (bool abilityPermitted) |
Changes the status of the ability's permission More... | |
virtual void | Flip () |
Override this to specify what should happen in this ability when the character flips More... | |
virtual void | ResetAbility () |
Override this to reset this ability's parameters. It'll be automatically called when the character gets killed, in anticipation for its respawn. More... | |
virtual void | SetInputManager (InputManager newInputManager) |
Changes the reference to the input manager with the one set in parameters More... | |
virtual void | PlayAbilityStartSfx () |
Plays the ability start sound effect More... | |
virtual void | PlayAbilityUsedSfx () |
Plays the ability used sound effect More... | |
virtual void | StopAbilityUsedSfx () |
Stops the ability used sound effect More... | |
virtual void | PlayAbilityStopSfx () |
Plays the ability stop sound effect More... | |
virtual void | PlayAbilityStartFeedbacks () |
Plays the ability start sound effect More... | |
virtual void | StopStartFeedbacks () |
Stops the ability used sound effect More... | |
virtual void | PlayAbilityStopFeedbacks () |
Plays the ability stop sound effect More... | |
Public Attributes | |
AudioClip | AbilityStartSfx |
the sound fx to play when the ability starts More... | |
AudioClip | AbilityInProgressSfx |
the sound fx to play while the ability is running More... | |
AudioClip | AbilityStopSfx |
the sound fx to play when the ability stops More... | |
MMFeedbacks | AbilityStartFeedbacks |
the feedbacks to play when the ability starts More... | |
MMFeedbacks | AbilityStopFeedbacks |
the feedbacks to play when the ability stops More... | |
bool | AbilityPermitted = true |
if true, this ability can perform as usual, if not, it'll be ignored. You can use this to unlock abilities over time for example More... | |
CharacterStates.MovementStates[] | BlockingMovementStates |
an array containing all the blocking movement states. If the Character is in one of these states and tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while Idle or Swimming, for example. More... | |
CharacterStates.CharacterConditions[] | BlockingConditionStates |
an array containing all the blocking condition states. If the Character is in one of these states and tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while dead, for example. More... | |
Weapon.WeaponStates[] | BlockingWeaponStates |
an array containing all the blocking weapon states. If one of the character's weapons is in one of these states and yet the character tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while attacking, for example. More... | |
AbilityEvent | OnAbilityStart |
AbilityEvent | OnAbilityStop |
Protected Member Functions | |
virtual void | Awake () |
On awake we proceed to pre initializing our ability More... | |
virtual void | Start () |
On Start(), we call the ability's intialization More... | |
virtual void | PreInitialization () |
A method you can override to have an initialization before the actual initialization More... | |
virtual void | Initialization () |
Gets and stores components for further use More... | |
virtual void | BindAnimator () |
Binds the animator from the character and initializes the animator parameters More... | |
virtual void | InitializeAnimatorParameters () |
Adds required animator parameters to the animator parameters list if they exist More... | |
virtual void | InternalHandleInput () |
Internal method to check if an input manager is present or not More... | |
virtual void | HandleInput () |
Called at the very start of the ability's cycle, and intended to be overridden, looks for input and calls methods if conditions are met More... | |
virtual void | RegisterAnimatorParameter (string parameterName, AnimatorControllerParameterType parameterType, out int parameter) |
Registers a new animator parameter to the list More... | |
virtual void | OnRespawn () |
Override this to describe what should happen to this ability when the character respawns More... | |
virtual void | OnDeath () |
Override this to describe what should happen to this ability when the character respawns More... | |
virtual void | OnHit () |
Override this to describe what should happen to this ability when the character takes a hit More... | |
virtual void | OnEnable () |
On enable, we bind our respawn delegate More... | |
virtual void | OnDisable () |
On disable, we unbind our respawn delegate More... | |
Protected Attributes | |
Character | _character |
TopDownController | _controller |
TopDownController2D | _controller2D |
TopDownController3D | _controller3D |
GameObject | _model |
Health | _health |
CharacterMovement | _characterMovement |
InputManager | _inputManager |
Animator | _animator = null |
CharacterStates | _state |
SpriteRenderer | _spriteRenderer |
MMStateMachine< CharacterStates.MovementStates > | _movement |
MMStateMachine< CharacterStates.CharacterConditions > | _condition |
AudioSource | _abilityInProgressSfx |
bool | _abilityInitialized = false |
float | _verticalInput |
float | _horizontalInput |
bool | _startFeedbackIsPlaying = false |
List< CharacterHandleWeapon > | _handleWeaponList |
Properties | |
virtual bool | AbilityAuthorized [get] |
virtual bool | AbilityInitialized [get] |
whether or not this ability has been initialized More... | |
A class meant to be overridden that handles a character's ability.
delegate void MoreMountains.TopDownEngine.CharacterAbility.AbilityEvent | ( | ) |
|
protectedvirtual |
On awake we proceed to pre initializing our ability
Reimplemented in MoreMountains.TopDownEngine.CharacterOrientation2D.
|
protectedvirtual |
Binds the animator from the character and initializes the animator parameters
|
virtual |
The first of the 3 passes you can have in your ability. Think of it as EarlyUpdate() if it existed
|
virtual |
Override this to specify what should happen in this ability when the character flips
Reimplemented in MoreMountains.TopDownEngine.CharacterHandleWeapon, and MoreMountains.TopDownEngine.CharacterSwitchModel.
|
virtual |
Call this any time you want to force this ability to initialize (again)
|
protectedvirtual |
Called at the very start of the ability's cycle, and intended to be overridden, looks for input and calls methods if conditions are met
Reimplemented in MoreMountains.TopDownEngine.CharacterGridMovement, MoreMountains.TopDownEngine.CharacterHandleWeapon, MoreMountains.TopDownEngine.CharacterInventory, MoreMountains.TopDownEngine.CharacterMovement, MoreMountains.TopDownEngine.CharacterCrouch, MoreMountains.TopDownEngine.CharacterRotateCamera, MoreMountains.TopDownEngine.CharacterDash3D, MoreMountains.TopDownEngine.CharacterDash2D, MoreMountains.TopDownEngine.CharacterJump3D, MoreMountains.TopDownEngine.CharacterSwitchModel, MoreMountains.TopDownEngine.CharacterJump2D, MoreMountains.TopDownEngine.CharacterButtonActivation, MoreMountains.TopDownEngine.CharacterPause, MoreMountains.TopDownEngine.CharacterTimeControl, MoreMountains.TopDownEngine.CharacterRun, MoreMountains.TopDownEngine.CharacterAbilityNodeSwap, and MoreMountains.TopDownEngine.CharacterHandleSecondaryWeapon.
|
virtual |
This method is only used to display a helpbox text at the beginning of the ability's inspector.
Reimplemented in MoreMountains.TopDownEngine.CharacterSurfaceSounds, MoreMountains.TopDownEngine.CharacterHandleWeapon, MoreMountains.TopDownEngine.CharacterRotateCamera, MoreMountains.TopDownEngine.CharacterButtonActivation, MoreMountains.TopDownEngine.CharacterPause, MoreMountains.TopDownEngine.CharacterCrouch, MoreMountains.TopDownEngine.CharacterRun, and MoreMountains.TopDownEngine.CharacterStun.
|
protectedvirtual |
Gets and stores components for further use
Reimplemented in MoreMountains.TopDownEngine.CharacterGridMovement, MoreMountains.TopDownEngine.CharacterOrientation3D, MoreMountains.TopDownEngine.CharacterHandleWeapon, MoreMountains.TopDownEngine.CharacterPathfinder3D, MoreMountains.TopDownEngine.CharacterOrientation2D, MoreMountains.TopDownEngine.CharacterSurfaceSounds, MoreMountains.TopDownEngine.CharacterMovement, MoreMountains.TopDownEngine.CharacterRotation2D, MoreMountains.TopDownEngine.CharacterDirectionMarker, MoreMountains.TopDownEngine.CharacterDash3D, MoreMountains.TopDownEngine.CharacterInventory, MoreMountains.TopDownEngine.CharacterDash2D, MoreMountains.TopDownEngine.CharacterCrouch, MoreMountains.TopDownEngine.CharacterJump3D, MoreMountains.TopDownEngine.CharacterRotateCamera, MoreMountains.TopDownEngine.CharacterTimeControl, MoreMountains.TopDownEngine.CharacterSwitchModel, MoreMountains.TopDownEngine.CharacterJump2D, MoreMountains.TopDownEngine.CharacterPathfindToMouse3D, MoreMountains.TopDownEngine.CharacterPush3D, MoreMountains.TopDownEngine.CharacterButtonActivation, MoreMountains.TopDownEngine.CharacterSwap, MoreMountains.TopDownEngine.CharacterTank, MoreMountains.TopDownEngine.CharacterPersistence, MoreMountains.TopDownEngine.CharacterDamageDash3D, and MoreMountains.TopDownEngine.CharacterDamageDash2D.
|
protectedvirtual |
Adds required animator parameters to the animator parameters list if they exist
Reimplemented in MoreMountains.TopDownEngine.CharacterHandleWeapon, MoreMountains.TopDownEngine.CharacterGridMovement, MoreMountains.TopDownEngine.CharacterMovement, MoreMountains.TopDownEngine.CharacterOrientation2D, MoreMountains.TopDownEngine.CharacterOrientation3D, MoreMountains.TopDownEngine.CharacterCrouch, MoreMountains.TopDownEngine.CharacterRotation2D, MoreMountains.TopDownEngine.CharacterJump3D, MoreMountains.TopDownEngine.CharacterDash3D, MoreMountains.TopDownEngine.CharacterDash2D, MoreMountains.TopDownEngine.CharacterRun, MoreMountains.TopDownEngine.CharacterJump2D, MoreMountains.TopDownEngine.CharacterButtonActivation, MoreMountains.TopDownEngine.CharacterStun, MoreMountains.TopDownEngine.CharacterPush3D, MoreMountains.TopDownEngine.CharacterFallDownHoles2D, and MoreMountains.TopDownEngine.CharacterDamageDash3D.
|
protectedvirtual |
Internal method to check if an input manager is present or not
|
virtual |
The last of the 3 passes you can have in your ability. Think of it as LateUpdate()
|
protectedvirtual |
Override this to describe what should happen to this ability when the character respawns
Reimplemented in MoreMountains.TopDownEngine.CharacterHandleWeapon, MoreMountains.TopDownEngine.CharacterGridMovement, MoreMountains.TopDownEngine.CharacterMovement, MoreMountains.TopDownEngine.CharacterInventory, MoreMountains.TopDownEngine.CharacterButtonActivation, and MoreMountains.TopDownEngine.CharacterPersistence.
|
protectedvirtual |
On disable, we unbind our respawn delegate
Reimplemented in MoreMountains.TopDownEngine.CharacterMovement, MoreMountains.TopDownEngine.CharacterInventory, MoreMountains.TopDownEngine.CharacterRun, and MoreMountains.TopDownEngine.CharacterTimeControl.
|
protectedvirtual |
On enable, we bind our respawn delegate
Reimplemented in MoreMountains.TopDownEngine.CharacterInventory, MoreMountains.TopDownEngine.CharacterRotateCamera, MoreMountains.TopDownEngine.CharacterButtonActivation, MoreMountains.TopDownEngine.CharacterTimeControl, and MoreMountains.TopDownEngine.CharacterPersistence.
|
protectedvirtual |
Override this to describe what should happen to this ability when the character takes a hit
Reimplemented in MoreMountains.TopDownEngine.CharacterHandleWeapon.
|
protectedvirtual |
Override this to describe what should happen to this ability when the character respawns
Reimplemented in MoreMountains.TopDownEngine.CharacterHandleWeapon, MoreMountains.TopDownEngine.CharacterGridMovement, MoreMountains.TopDownEngine.CharacterMovement, and MoreMountains.TopDownEngine.CharacterInventory.
|
virtual |
Changes the status of the ability's permission
abilityPermitted | If set to true ability permitted. |
|
virtual |
Plays the ability start sound effect
|
virtual |
Plays the ability start sound effect
|
virtual |
Plays the ability stop sound effect
|
virtual |
Plays the ability stop sound effect
|
virtual |
Plays the ability used sound effect
|
protectedvirtual |
A method you can override to have an initialization before the actual initialization
Reimplemented in MoreMountains.TopDownEngine.CharacterHandleWeapon.
|
virtual |
The second of the 3 passes you can have in your ability. Think of it as Update()
Reimplemented in MoreMountains.TopDownEngine.CharacterGridMovement, MoreMountains.TopDownEngine.CharacterDash3D, MoreMountains.TopDownEngine.CharacterDash2D, MoreMountains.TopDownEngine.CharacterHandleWeapon, MoreMountains.TopDownEngine.CharacterOrientation3D, MoreMountains.TopDownEngine.CharacterPathfinder3D, MoreMountains.TopDownEngine.CharacterOrientation2D, MoreMountains.TopDownEngine.CharacterInventory, MoreMountains.TopDownEngine.CharacterMovement, MoreMountains.TopDownEngine.CharacterRotateCamera, MoreMountains.TopDownEngine.CharacterRotation2D, MoreMountains.TopDownEngine.CharacterSurfaceSounds, MoreMountains.TopDownEngine.CharacterJump3D, MoreMountains.TopDownEngine.CharacterDirectionMarker, MoreMountains.TopDownEngine.CharacterCrouch, MoreMountains.TopDownEngine.CharacterTimeControl, MoreMountains.TopDownEngine.CharacterRun, MoreMountains.TopDownEngine.CharacterJump2D, MoreMountains.TopDownEngine.CharacterPathfindToMouse3D, MoreMountains.TopDownEngine.CharacterPush3D, MoreMountains.TopDownEngine.CharacterTank, and MoreMountains.TopDownEngine.CharacterFallDownHoles2D.
|
protectedvirtual |
Registers a new animator parameter to the list
parameterName | Parameter name. |
parameterType | Parameter type. |
|
virtual |
Override this to reset this ability's parameters. It'll be automatically called when the character gets killed, in anticipation for its respawn.
Reimplemented in MoreMountains.TopDownEngine.CharacterMovement.
|
virtual |
Resets all input for this ability. Can be overridden for ability specific directives
|
virtual |
Changes the reference to the input manager with the one set in parameters
newInputManager |
|
protectedvirtual |
On Start(), we call the ability's intialization
|
virtual |
Stops the ability used sound effect
|
virtual |
Stops the ability used sound effect
|
virtual |
Override this to send parameters to the character's animator. This is called once per cycle, by the Character class, after Early, normal and Late process().
Reimplemented in MoreMountains.TopDownEngine.CharacterHandleWeapon, MoreMountains.TopDownEngine.CharacterGridMovement, MoreMountains.TopDownEngine.CharacterMovement, MoreMountains.TopDownEngine.CharacterOrientation2D, MoreMountains.TopDownEngine.CharacterOrientation3D, MoreMountains.TopDownEngine.CharacterCrouch, MoreMountains.TopDownEngine.CharacterRotation2D, MoreMountains.TopDownEngine.CharacterJump3D, MoreMountains.TopDownEngine.CharacterDash3D, MoreMountains.TopDownEngine.CharacterDash2D, MoreMountains.TopDownEngine.CharacterRun, MoreMountains.TopDownEngine.CharacterJump2D, MoreMountains.TopDownEngine.CharacterButtonActivation, MoreMountains.TopDownEngine.CharacterStun, MoreMountains.TopDownEngine.CharacterPush3D, MoreMountains.TopDownEngine.CharacterFallDownHoles2D, and MoreMountains.TopDownEngine.CharacterDamageDash3D.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
AudioClip MoreMountains.TopDownEngine.CharacterAbility.AbilityInProgressSfx |
the sound fx to play while the ability is running
bool MoreMountains.TopDownEngine.CharacterAbility.AbilityPermitted = true |
if true, this ability can perform as usual, if not, it'll be ignored. You can use this to unlock abilities over time for example
MMFeedbacks MoreMountains.TopDownEngine.CharacterAbility.AbilityStartFeedbacks |
the feedbacks to play when the ability starts
AudioClip MoreMountains.TopDownEngine.CharacterAbility.AbilityStartSfx |
the sound fx to play when the ability starts
MMFeedbacks MoreMountains.TopDownEngine.CharacterAbility.AbilityStopFeedbacks |
the feedbacks to play when the ability stops
AudioClip MoreMountains.TopDownEngine.CharacterAbility.AbilityStopSfx |
the sound fx to play when the ability stops
CharacterStates.CharacterConditions [] MoreMountains.TopDownEngine.CharacterAbility.BlockingConditionStates |
an array containing all the blocking condition states. If the Character is in one of these states and tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while dead, for example.
CharacterStates.MovementStates [] MoreMountains.TopDownEngine.CharacterAbility.BlockingMovementStates |
an array containing all the blocking movement states. If the Character is in one of these states and tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while Idle or Swimming, for example.
Weapon.WeaponStates [] MoreMountains.TopDownEngine.CharacterAbility.BlockingWeaponStates |
an array containing all the blocking weapon states. If one of the character's weapons is in one of these states and yet the character tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while attacking, for example.
AbilityEvent MoreMountains.TopDownEngine.CharacterAbility.OnAbilityStart |
AbilityEvent MoreMountains.TopDownEngine.CharacterAbility.OnAbilityStop |
|
get |
|
get |
whether or not this ability has been initialized