 |
Corgi Engine
v9.1
|
|
Corgi Engine
v9.1
|
Add this ability to a Character and you'll be able to define speed modifiers for each of its possible states This modifier will be applied to the horizontal speed of the character as long as the character is in that state You can also define a default speed multiplier to apply if none of the defined states were found Animator parameters : none More...
Public Attributes | |
| List< CharacterSpeedState > | States |
| a list of states and their corresponding speed modifiers More... | |
| bool | ApplyDefaultSpeedMultiplier = true |
| whether or not to apply the DefaultSpeedMultiplier when none of the above states is found More... | |
| float | DefaultSpeedMultiplier = 1f |
| the default speed multiplier to apply when no other state is found More... | |
 Public Attributes inherited from MoreMountains.CorgiEngine.CharacterAbility | |
| 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... | |
Protected Member Functions | |
| virtual void | LateUpdate () |
| On late update we check our states to see if we need to apply a speed multiplier More... | |
| virtual void | CheckStates () |
| Compares the current state against our list of speed modifiers and apply it if needed More... | |
| Protected Member Functions inherited from MoreMountains.CorgiEngine.CharacterAbility | |
| virtual void | Start () |
| On Start(), we call the ability's intialization More... | |
| virtual void | Initialization () |
| Gets and stores components for further use 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 | 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... | |
Additional Inherited Members | |
| Public Member Functions inherited from MoreMountains.CorgiEngine.CharacterAbility | |
| virtual string | HelpBoxText () |
| This method is only used to display a helpbox text at the beginning of the ability's inspector. More... | |
| virtual void | SetInputManager (InputManager inputManager) |
| Sets a new input manager for this ability to get input from More... | |
| virtual void | BindAnimator () |
| Binds the animator from the character and initializes the animator parameters 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 | 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... | |
| virtual void | RegisterAnimatorParameter (string parameterName, AnimatorControllerParameterType parameterType, out int parameter) |
| Registers a new animator parameter to the list More... | |
| Protected Attributes inherited from MoreMountains.CorgiEngine.CharacterAbility | |
| Character | _character |
| Transform | _characterTransform |
| Health | _health |
| CharacterHorizontalMovement | _characterHorizontalMovement |
| CorgiController | _controller |
| InputManager | _inputManager |
| CameraController | _sceneCamera |
| Animator | _animator |
| CharacterStates | _state |
| SpriteRenderer | _spriteRenderer |
| MMStateMachine< CharacterStates.MovementStates > | _movement |
| MMStateMachine< CharacterStates.CharacterConditions > | _condition |
| bool | _abilityInitialized = false |
| CharacterGravity | _characterGravity |
| float | _verticalInput |
| float | _horizontalInput |
| bool | _startFeedbackIsPlaying = false |
| List< CharacterHandleWeapon > | _handleWeaponList |
| Properties inherited from MoreMountains.CorgiEngine.CharacterAbility | |
| virtual bool | AbilityAuthorized [get] |
| virtual bool | AbilityInitialized [get] |
| true if the ability has already been initialized More... | |
Add this ability to a Character and you'll be able to define speed modifiers for each of its possible states This modifier will be applied to the horizontal speed of the character as long as the character is in that state You can also define a default speed multiplier to apply if none of the defined states were found Animator parameters : none
|
protectedvirtual |
Compares the current state against our list of speed modifiers and apply it if needed
|
protectedvirtual |
On late update we check our states to see if we need to apply a speed multiplier
| bool MoreMountains.CorgiEngine.CharacterSpeed.ApplyDefaultSpeedMultiplier = true |
whether or not to apply the DefaultSpeedMultiplier when none of the above states is found
| float MoreMountains.CorgiEngine.CharacterSpeed.DefaultSpeedMultiplier = 1f |
the default speed multiplier to apply when no other state is found
| List<CharacterSpeedState> MoreMountains.CorgiEngine.CharacterSpeed.States |
a list of states and their corresponding speed modifiers
1.8.18