Add this ability to a Character and it'll be part of a pool of characters in a scene to swap from. You'll need a CharacterSwapManager in your scene for this to work.
More...
|
| virtual void | SwapToThisCharacter () |
| | Called by the CharacterSwapManager, changes this character's type and sets its input manager.
|
| virtual void | ResetCharacterSwap () |
| | Called when another character replaces this one as the active one, resets its type and player ID and kills its input.
|
| virtual bool | Current () |
| | Returns true if this character is the currently active swap character.
|
| delegate void | AbilityEvent () |
| virtual string | HelpBoxText () |
| | This method is only used to display a helpbox text at the beginning of the ability's inspector.
|
| virtual void | ForceInitialization () |
| | Call this any time you want to force this ability to initialize (again)
|
| virtual void | ResetInput () |
| | Resets all input for this ability. Can be overridden for ability specific directives.
|
| virtual void | EarlyProcessAbility () |
| | The first of the 3 passes you can have in your ability. Think of it as EarlyUpdate() if it existed.
|
| virtual void | ProcessAbility () |
| | The second of the 3 passes you can have in your ability. Think of it as Update()
|
| virtual void | LateProcessAbility () |
| | The last of the 3 passes you can have in your ability. Think of it as LateUpdate()
|
| 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().
|
| virtual void | PermitAbility (bool abilityPermitted) |
| | Changes the status of the ability's permission.
|
| virtual void | Flip () |
| | Override this to specify what should happen in this ability when the character flips.
|
| 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.
|
| virtual void | SetInputManager (InputManager newInputManager) |
| | Changes the reference to the input manager with the one set in parameters.
|
| virtual void | PlayAbilityStartSfx () |
| | Plays the ability start sound effect.
|
| virtual void | PlayAbilityUsedSfx () |
| | Plays the ability used sound effect.
|
| virtual void | StopAbilityUsedSfx () |
| | Stops the ability used sound effect.
|
| virtual void | PlayAbilityStopSfx () |
| | Plays the ability stop sound effect.
|
| virtual void | PlayAbilityStartFeedbacks () |
| | Plays the ability start sound effect.
|
| virtual void | StopStartFeedbacks () |
| | Stops the ability used sound effect.
|
| virtual void | PlayAbilityStopFeedbacks () |
| | Plays the ability stop sound effect.
|
|
| int | Order = 0 |
| | the order in which this character should be picked
|
| string | PlayerID = "Player1" |
| | the playerID to put back in the Character class once this character gets swapped
|
| bool | ResetAIBrainOnSwap = true |
| | if this is true, the AI Brain (if there's one on this character) will reset on swap
|
| AudioClip | AbilityStartSfx |
| | the sound fx to play when the ability starts
|
| AudioClip | AbilityInProgressSfx |
| | the sound fx to play while the ability is running
|
| AudioClip | AbilityStopSfx |
| | the sound fx to play when the ability stops
|
| MMFeedbacks | AbilityStartFeedbacks |
| | the feedbacks to play when the ability starts
|
| MMFeedbacks | AbilityStopFeedbacks |
| | the feedbacks to play when the ability stops
|
| 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
|
| 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.
|
| 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.
|
| 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.
|
| AbilityEvent | OnAbilityStart |
| AbilityEvent | OnAbilityStop |
|
| override void | Initialization () |
| | On init, we grab our character type and playerID and store them for later.
|
| virtual void | Awake () |
| | On awake we proceed to pre initializing our ability.
|
| virtual void | Start () |
| | On Start(), we call the ability's intialization.
|
| virtual void | PreInitialization () |
| | A method you can override to have an initialization before the actual initialization.
|
| virtual void | BindAnimator () |
| | Binds the animator from the character and initializes the animator parameters.
|
| virtual void | InitializeAnimatorParameters () |
| | Adds required animator parameters to the animator parameters list if they exist.
|
| virtual void | InternalHandleInput () |
| | Internal method to check if an input manager is present or not.
|
| 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.
|
| virtual void | RegisterAnimatorParameter (string parameterName, AnimatorControllerParameterType parameterType, out int parameter) |
| | Registers a new animator parameter to the list.
|
| virtual void | OnRespawn () |
| | Override this to describe what should happen to this ability when the character respawns.
|
| virtual void | OnDeath () |
| | Override this to describe what should happen to this ability when the character respawns.
|
| virtual void | OnHit () |
| | Override this to describe what should happen to this ability when the character takes a hit.
|
| virtual void | OnEnable () |
| | On enable, we bind our respawn delegate.
|
| virtual void | OnDisable () |
| | On disable, we unbind our respawn delegate.
|
Add this ability to a Character and it'll be part of a pool of characters in a scene to swap from. You'll need a CharacterSwapManager in your scene for this to work.
◆ Current()
| virtual bool MoreMountains.TopDownEngine.CharacterSwap.Current |
( |
| ) |
|
|
virtual |
Returns true if this character is the currently active swap character.
- Returns
◆ Initialization()
| override void MoreMountains.TopDownEngine.CharacterSwap.Initialization |
( |
| ) |
|
|
protectedvirtual |
◆ ResetCharacterSwap()
| virtual void MoreMountains.TopDownEngine.CharacterSwap.ResetCharacterSwap |
( |
| ) |
|
|
virtual |
Called when another character replaces this one as the active one, resets its type and player ID and kills its input.
◆ SwapToThisCharacter()
| virtual void MoreMountains.TopDownEngine.CharacterSwap.SwapToThisCharacter |
( |
| ) |
|
|
virtual |
◆ _savedCharacterType
◆ _savedPlayerID
| string MoreMountains.TopDownEngine.CharacterSwap._savedPlayerID |
|
protected |
◆ Order
| int MoreMountains.TopDownEngine.CharacterSwap.Order = 0 |
the order in which this character should be picked
◆ PlayerID
| string MoreMountains.TopDownEngine.CharacterSwap.PlayerID = "Player1" |
the playerID to put back in the Character class once this character gets swapped
◆ ResetAIBrainOnSwap
| bool MoreMountains.TopDownEngine.CharacterSwap.ResetAIBrainOnSwap = true |
if this is true, the AI Brain (if there's one on this character) will reset on swap
The documentation for this class was generated from the following file:
- H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Common/Scripts/Characters/CharacterAbilities/CharacterSwap.cs
1.14.0