Corgi Engine  v9.1
MoreMountains.CorgiEngine.CharacterGlide Class Reference

Add this ability to a Character and it'll be able to glide through the air, slowing its fall when pressing the Glide button (by default the same binding as the Jump button, but separated for convenience) More...

Inheritance diagram for MoreMountains.CorgiEngine.CharacterGlide:
MoreMountains.CorgiEngine.CharacterAbility MoreMountains.CorgiEngine.CorgiMonoBehaviour

Public Member Functions

override string HelpBoxText ()
 This method is only used to display a helpbox text at the beginning of the ability's inspector. More...
 
override void ProcessAbility ()
 Stops the character from gliding if needed More...
 
override void UpdateAnimator ()
 At the end of each cycle, we send our character's animator the current gliding status More...
 
override void ResetAbility ()
 On reset ability, we cancel all the changes made More...
 
- Public Member Functions inherited from MoreMountains.CorgiEngine.CharacterAbility
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 LateProcessAbility ()
 The last of the 3 passes you can have in your ability. Think of it as LateUpdate() 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 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...
 

Public Attributes

float VerticalForce = 0.1f
 the force to apply when gliding More...
 
bool GlideOnlyIfNoJumpsLeft = true
 whether or not the glide will wait for jumps to be exhausted 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

override void Initialization ()
 On Start we grab our components More...
 
override void HandleInput ()
 Looks for glide related inputs More...
 
virtual void GlideStart ()
 When pressing the glide button we make sure we can glide, and initiate it More...
 
virtual void GlideStop ()
 Stops the character from gliding More...
 
override void InitializeAnimatorParameters ()
 Adds required animator parameters to the animator parameters list if they exist More...
 
- Protected Member Functions inherited from MoreMountains.CorgiEngine.CharacterAbility
virtual void Start ()
 On Start(), we call the ability's intialization More...
 
virtual void InternalHandleInput ()
 Internal method to check if an input manager is present or not 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

bool _gliding
 
CharacterJump _characterJump
 
CharacterWalljump _characterWallJump
 
CharacterSwim _characterSwim
 
CharacterLedgeHang _characterLedgeHang
 
int _glidingAnimationParameter
 
- 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
 

Static Protected Attributes

const string _glidingAnimationParameterName = "Gliding"
 

Additional Inherited Members

- Properties inherited from MoreMountains.CorgiEngine.CharacterAbility
virtual bool AbilityAuthorized [get]
 
virtual bool AbilityInitialized [get]
 true if the ability has already been initialized More...
 

Detailed Description

Add this ability to a Character and it'll be able to glide through the air, slowing its fall when pressing the Glide button (by default the same binding as the Jump button, but separated for convenience)

Animator parameters : Gliding (bool)

Member Function Documentation

◆ GlideStart()

virtual void MoreMountains.CorgiEngine.CharacterGlide.GlideStart ( )
protectedvirtual

When pressing the glide button we make sure we can glide, and initiate it

◆ GlideStop()

virtual void MoreMountains.CorgiEngine.CharacterGlide.GlideStop ( )
protectedvirtual

Stops the character from gliding

◆ HandleInput()

override void MoreMountains.CorgiEngine.CharacterGlide.HandleInput ( )
protectedvirtual

Looks for glide related inputs

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ HelpBoxText()

override string MoreMountains.CorgiEngine.CharacterGlide.HelpBoxText ( )
virtual

This method is only used to display a helpbox text at the beginning of the ability's inspector.

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ Initialization()

override void MoreMountains.CorgiEngine.CharacterGlide.Initialization ( )
protectedvirtual

On Start we grab our components

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ InitializeAnimatorParameters()

override void MoreMountains.CorgiEngine.CharacterGlide.InitializeAnimatorParameters ( )
protectedvirtual

Adds required animator parameters to the animator parameters list if they exist

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ ProcessAbility()

override void MoreMountains.CorgiEngine.CharacterGlide.ProcessAbility ( )
virtual

Stops the character from gliding if needed

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ ResetAbility()

override void MoreMountains.CorgiEngine.CharacterGlide.ResetAbility ( )
virtual

On reset ability, we cancel all the changes made

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ UpdateAnimator()

override void MoreMountains.CorgiEngine.CharacterGlide.UpdateAnimator ( )
virtual

At the end of each cycle, we send our character's animator the current gliding status

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

Member Data Documentation

◆ _characterJump

CharacterJump MoreMountains.CorgiEngine.CharacterGlide._characterJump
protected

◆ _characterLedgeHang

CharacterLedgeHang MoreMountains.CorgiEngine.CharacterGlide._characterLedgeHang
protected

◆ _characterSwim

CharacterSwim MoreMountains.CorgiEngine.CharacterGlide._characterSwim
protected

◆ _characterWallJump

CharacterWalljump MoreMountains.CorgiEngine.CharacterGlide._characterWallJump
protected

◆ _gliding

bool MoreMountains.CorgiEngine.CharacterGlide._gliding
protected

◆ _glidingAnimationParameter

int MoreMountains.CorgiEngine.CharacterGlide._glidingAnimationParameter
protected

◆ _glidingAnimationParameterName

const string MoreMountains.CorgiEngine.CharacterGlide._glidingAnimationParameterName = "Gliding"
staticprotected

◆ GlideOnlyIfNoJumpsLeft

bool MoreMountains.CorgiEngine.CharacterGlide.GlideOnlyIfNoJumpsLeft = true

whether or not the glide will wait for jumps to be exhausted

◆ VerticalForce

float MoreMountains.CorgiEngine.CharacterGlide.VerticalForce = 0.1f

the force to apply when gliding


The documentation for this class was generated from the following file: