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

Inheritance diagram for MoreMountains.TopDownEngine.CharacterRun:

Public Member Functions
override string	HelpBoxText ()
	This method is only used to display a helpbox text at the beginning of the ability's inspector.
override void	ProcessAbility ()
	Every frame we make sure we shouldn't be exiting our run state.
virtual void	RunStart ()
	Causes the character to start running.
virtual void	RunStop ()
	Causes the character to stop running.
override void	UpdateAnimator ()
	At the end of each cycle, we send our Running status to the character's animator.
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)
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	LateProcessAbility ()
	The last of the 3 passes you can have in your ability. Think of it as LateUpdate()
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.

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

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

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

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:

H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Common/Scripts/Characters/CharacterAbilities/CharacterRun.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ HandleInput()

◆ HandleRunningExit()

◆ HelpBoxText()

◆ InitializeAnimatorParameters()

◆ OnDisable()

◆ ProcessAbility()

◆ RunStart()

◆ RunStop()

◆ StopFeedbacks()

◆ StopSfx()

◆ UpdateAnimator()

Member Data Documentation

◆ _runningAnimationParameter

◆ _runningAnimationParameterName

◆ _runningStarted

◆ AutoRun

◆ AutoRunThreshold

◆ RunSpeed