Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.MecanimAnimationBridge_2D Class Reference

An animator that plays animations directly on a mecanim controller. Typically used for 2D sprites. More...

Inheritance diagram for PlatformerPro.MecanimAnimationBridge_2D:
PlatformerPro.IAnimationBridge

Public Member Functions

virtual void Reset ()
 Reset the animation state. More...
 

Public Attributes

List< AnimatorControllerMappingmappings
 Maps from states to animator overrides. More...
 

Protected Member Functions

void Init ()
 Initialise this animation bridge. More...
 
virtual void HandleGameUnPaused (object sender, System.EventArgs e)
 Handles the game being unpaused. More...
 
virtual void HandleGamePaused (object sender, System.EventArgs e)
 Handles the game being paused. More...
 
void AnimationStateChanged (object sender, AnimationEventArgs args)
 Handles animation state changed. More...
 

Protected Attributes

Dictionary< string, AnimatorOverrideController > animationStateOverrideLookup
 Lookup table of attack states to animator overrides. More...
 
RuntimeAnimatorController defaultController
 Store default controller. More...
 
IMob myCharacter
 Cached reference to the character. More...
 
Animator myAnimator
 Cached reference to the animator. More...
 
AnimationState state
 The state currently playing. More...
 
Queue< AnimationStatequeuedStates
 The animation state that should play next. More...
 
int priority
 The current states priority. More...
 
PriorityQueue queuedPriorities
 The queued states priority. More...
 

Properties

virtual Animator Animator [get]
 
- Properties inherited from PlatformerPro.IAnimationBridge
Animator Animator [get]
 Gets the associated animator. Returns null if an animator is not being used. More...
 

Detailed Description

An animator that plays animations directly on a mecanim controller. Typically used for 2D sprites.

Member Function Documentation

◆ AnimationStateChanged()

void PlatformerPro.MecanimAnimationBridge_2D.AnimationStateChanged ( object  sender,
AnimationEventArgs  args 
)
protected

Handles animation state changed.

Parameters
senderSender.
argsArguments.

◆ HandleGamePaused()

virtual void PlatformerPro.MecanimAnimationBridge_2D.HandleGamePaused ( object  sender,
System.EventArgs  e 
)
protectedvirtual

Handles the game being paused.

Parameters
senderSender.
eE.

◆ HandleGameUnPaused()

virtual void PlatformerPro.MecanimAnimationBridge_2D.HandleGameUnPaused ( object  sender,
System.EventArgs  e 
)
protectedvirtual

Handles the game being unpaused.

Parameters
senderSender.
eE.

◆ Init()

void PlatformerPro.MecanimAnimationBridge_2D.Init ( )
protected

Initialise this animation bridge.

◆ Reset()

virtual void PlatformerPro.MecanimAnimationBridge_2D.Reset ( )
virtual

Reset the animation state.

Implements PlatformerPro.IAnimationBridge.

Member Data Documentation

◆ animationStateOverrideLookup

Dictionary<string, AnimatorOverrideController> PlatformerPro.MecanimAnimationBridge_2D.animationStateOverrideLookup
protected

Lookup table of attack states to animator overrides.

◆ defaultController

RuntimeAnimatorController PlatformerPro.MecanimAnimationBridge_2D.defaultController
protected

Store default controller.

◆ mappings

List<AnimatorControllerMapping> PlatformerPro.MecanimAnimationBridge_2D.mappings

Maps from states to animator overrides.

◆ myAnimator

Animator PlatformerPro.MecanimAnimationBridge_2D.myAnimator
protected

Cached reference to the animator.

◆ myCharacter

IMob PlatformerPro.MecanimAnimationBridge_2D.myCharacter
protected

Cached reference to the character.

◆ priority

int PlatformerPro.MecanimAnimationBridge_2D.priority
protected

The current states priority.

◆ queuedPriorities

PriorityQueue PlatformerPro.MecanimAnimationBridge_2D.queuedPriorities
protected

The queued states priority.

◆ queuedStates

Queue<AnimationState> PlatformerPro.MecanimAnimationBridge_2D.queuedStates
protected

The animation state that should play next.

◆ state

AnimationState PlatformerPro.MecanimAnimationBridge_2D.state
protected

The state currently playing.

Property Documentation

◆ Animator

virtual Animator PlatformerPro.MecanimAnimationBridge_2D.Animator
get

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