TopDown Engine  v4.2
MoreMountains.TopDownEngine.CharacterRun Class Reference

Add this component to a character and it'll be able to run Animator parameters : Running More...

Inheritance diagram for MoreMountains.TopDownEngine.CharacterRun:
MoreMountains.TopDownEngine.CharacterAbility MoreMountains.TopDownEngine.TopDownMonoBehaviour MoreMountains.Tools.MMMonoBehaviour

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 ()
 Every frame we make sure we shouldn't be exiting our run state More...
 
virtual void RunStart ()
 Causes the character to start running. More...
 
virtual void RunStop ()
 Causes the character to stop running. More...
 
override void UpdateAnimator ()
 At the end of each cycle, we send our Running status to the character's animator More...
 
- Public Member Functions inherited from MoreMountains.TopDownEngine.CharacterAbility
delegate void AbilityEvent ()
 
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 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 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

float RunSpeed = 16f
 the speed of the character when it's running More...
 
bool AutoRun = false
 whether or not run should auto trigger if you move the joystick far enough More...
 
float AutoRunThreshold = 0.6f
 the input threshold on the joystick (normalized) More...
 
- Public Attributes inherited from MoreMountains.TopDownEngine.CharacterAbility
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

override void HandleInput ()
 At the beginning of each cycle, we check if we've pressed or released the run button More...
 
virtual void HandleRunningExit ()
 Checks if we should exit our running state More...
 
virtual void StopFeedbacks ()
 Stops all run feedbacks More...
 
virtual void StopSfx ()
 Stops all run sounds More...
 
override void OnDisable ()
 On disable, we unbind our respawn delegate More...
 
override void InitializeAnimatorParameters ()
 Adds required animator parameters to the animator parameters list if they exist More...
 
- Protected Member Functions inherited from MoreMountains.TopDownEngine.CharacterAbility
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 InternalHandleInput ()
 Internal method to check if an input manager is present or not 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...
 

Protected Attributes

int _runningAnimationParameter
 
bool _runningStarted = false
 
- Protected Attributes inherited from MoreMountains.TopDownEngine.CharacterAbility
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
 

Static Protected Attributes

const string _runningAnimationParameterName = "Running"
 

Additional Inherited Members

- Properties inherited from MoreMountains.TopDownEngine.CharacterAbility
virtual bool AbilityAuthorized [get]
 
virtual bool AbilityInitialized [get]
 whether or not this ability has been initialized More...
 

Detailed Description

Add this component to a character and it'll be able to run Animator parameters : Running

Member Function Documentation

◆ HandleInput()

override void MoreMountains.TopDownEngine.CharacterRun.HandleInput ( )
protectedvirtual

At the beginning of each cycle, we check if we've pressed or released the run button

Reimplemented from MoreMountains.TopDownEngine.CharacterAbility.

◆ HandleRunningExit()

virtual void MoreMountains.TopDownEngine.CharacterRun.HandleRunningExit ( )
protectedvirtual

Checks if we should exit our running state

◆ HelpBoxText()

override string MoreMountains.TopDownEngine.CharacterRun.HelpBoxText ( )
virtual

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

Reimplemented from MoreMountains.TopDownEngine.CharacterAbility.

◆ InitializeAnimatorParameters()

override void MoreMountains.TopDownEngine.CharacterRun.InitializeAnimatorParameters ( )
protectedvirtual

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

Reimplemented from MoreMountains.TopDownEngine.CharacterAbility.

◆ OnDisable()

override void MoreMountains.TopDownEngine.CharacterRun.OnDisable ( )
protectedvirtual

On disable, we unbind our respawn delegate

Reimplemented from MoreMountains.TopDownEngine.CharacterAbility.

◆ ProcessAbility()

override void MoreMountains.TopDownEngine.CharacterRun.ProcessAbility ( )
virtual

Every frame we make sure we shouldn't be exiting our run state

Reimplemented from MoreMountains.TopDownEngine.CharacterAbility.

◆ RunStart()

virtual void MoreMountains.TopDownEngine.CharacterRun.RunStart ( )
virtual

Causes the character to start running.

◆ RunStop()

virtual void MoreMountains.TopDownEngine.CharacterRun.RunStop ( )
virtual

Causes the character to stop running.

◆ StopFeedbacks()

virtual void MoreMountains.TopDownEngine.CharacterRun.StopFeedbacks ( )
protectedvirtual

Stops all run feedbacks

◆ StopSfx()

virtual void MoreMountains.TopDownEngine.CharacterRun.StopSfx ( )
protectedvirtual

Stops all run sounds

◆ UpdateAnimator()

override void MoreMountains.TopDownEngine.CharacterRun.UpdateAnimator ( )
virtual

At the end of each cycle, we send our Running status to the character's animator

Reimplemented from MoreMountains.TopDownEngine.CharacterAbility.

Member Data Documentation

◆ _runningAnimationParameter

int MoreMountains.TopDownEngine.CharacterRun._runningAnimationParameter
protected

◆ _runningAnimationParameterName

const string MoreMountains.TopDownEngine.CharacterRun._runningAnimationParameterName = "Running"
staticprotected

◆ _runningStarted

bool MoreMountains.TopDownEngine.CharacterRun._runningStarted = false
protected

◆ AutoRun

bool MoreMountains.TopDownEngine.CharacterRun.AutoRun = false

whether or not run should auto trigger if you move the joystick far enough

◆ AutoRunThreshold

float MoreMountains.TopDownEngine.CharacterRun.AutoRunThreshold = 0.6f

the input threshold on the joystick (normalized)

◆ RunSpeed

float MoreMountains.TopDownEngine.CharacterRun.RunSpeed = 16f

the speed of the character when it's running


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