PlatformerPro.AnimationEventArgs Class Reference

Animation event arguments. More...

Inheritance diagram for PlatformerPro.AnimationEventArgs:

Public Member Functions
	AnimationEventArgs (AnimationState state, AnimationState previousState, string overrideState)
	Initializes a new instance of the AnimationEventArgs class. More...
virtual void	UpdateAnimationEventArgs (AnimationState state, AnimationState previousState, string overrideState)
	Updates the animation event arguments. More...
virtual void	UpdateAnimationEventArgs (AnimationState state, AnimationState previousState, string overrideState, int priority)
	Updates the animation event arguments. More...
virtual void	UpdateAnimationOverrideState (string overrideState)
	Updates the animation override state. More...

Properties
AnimationState	State [get, protected set]
	Gets the animation state. More...
AnimationState	PreviousState [get, protected set]
	Gets the previous animation state. More...
string	OverrideState [get, protected set]
	Gets the animation override state which can be maintained separately from base state and can be used for animation overrides like shooting or carrying. More...
int	Priority [get, protected set]
	Gets the animation priority. An animation with a higher priority will not be interrupted mid-loop by an animation with a lower priority. More...

Detailed Description

Animation event arguments.

Constructor & Destructor Documentation

AnimationEventArgs()

PlatformerPro.AnimationEventArgs.AnimationEventArgs	(	AnimationState	state,
		AnimationState	previousState,
		string	overrideState
	)

Initializes a new instance of the AnimationEventArgs class.

Parameters

state	Current state.
previousState	Previous state.
overrideState	Override state.

Member Function Documentation

UpdateAnimationEventArgs() [1/2]

virtual void PlatformerPro.AnimationEventArgs.UpdateAnimationEventArgs ( AnimationState  state, AnimationState  previousState, string  overrideState  )

virtual

Updates the animation event arguments.

Parameters

state	State.
previousState	Previous state.
overrideState	Override State.

UpdateAnimationEventArgs() [2/2]

virtual void PlatformerPro.AnimationEventArgs.UpdateAnimationEventArgs ( AnimationState  state, AnimationState  previousState, string  overrideState, int  priority  )

virtual

Updates the animation event arguments.

Parameters

state	State.
previousState	Previous state.
overrideState	Override State.
priority	Priority of the animation.

UpdateAnimationOverrideState()

virtual void PlatformerPro.AnimationEventArgs.UpdateAnimationOverrideState ( string  overrideState )

virtual

Updates the animation override state.

Parameters

overrideState

Override State

Property Documentation

OverrideState

string PlatformerPro.AnimationEventArgs.OverrideState

getprotected set

Gets the animation override state which can be maintained separately from base state and can be used for animation overrides like shooting or carrying.

PreviousState

AnimationState PlatformerPro.AnimationEventArgs.PreviousState

getprotected set

Gets the previous animation state.

The state of the previous.

Priority

int PlatformerPro.AnimationEventArgs.Priority

getprotected set

Gets the animation priority. An animation with a higher priority will not be interrupted mid-loop by an animation with a lower priority.

State

AnimationState PlatformerPro.AnimationEventArgs.State

getprotected set

Gets the animation state.

---

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

• D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/EventSystem/EventArgs/AnimationEventArgs.cs