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

Bridge which plays animations from overrides. More...

Inheritance diagram for PlatformerPro.MecanimOverrideAsAnimationBridge:
PlatformerPro.IAnimationBridge

Public Member Functions

virtual void Reset ()
 Reset the animation state. 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

IMob myCharacter
 Cached reference to the character. More...
 
Animator myAnimator
 Cached reference to the animator. More...
 
string currentOverride
 Stores currently playing override. More...
 

Properties

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

Detailed Description

Bridge which plays animations from overrides.

Member Function Documentation

◆ AnimationStateChanged()

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

Handles animation state changed.

Parameters
senderSender.
argsArguments.

◆ HandleGamePaused()

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

Handles the game being paused.

Parameters
senderSender.
eE.

◆ HandleGameUnPaused()

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

Handles the game being unpaused.

Parameters
senderSender.
eE.

◆ Init()

void PlatformerPro.MecanimOverrideAsAnimationBridge.Init ( )
protected

Initialise this animation bridge.

◆ Reset()

virtual void PlatformerPro.MecanimOverrideAsAnimationBridge.Reset ( )
virtual

Reset the animation state.

Implements PlatformerPro.IAnimationBridge.

Member Data Documentation

◆ currentOverride

string PlatformerPro.MecanimOverrideAsAnimationBridge.currentOverride
protected

Stores currently playing override.

◆ myAnimator

Animator PlatformerPro.MecanimOverrideAsAnimationBridge.myAnimator
protected

Cached reference to the animator.

◆ myCharacter

IMob PlatformerPro.MecanimOverrideAsAnimationBridge.myCharacter
protected

Cached reference to the character.

Property Documentation

◆ Animator

virtual Animator PlatformerPro.MecanimOverrideAsAnimationBridge.Animator
get

Gets the associated animator. Returns null if an animator is not being used.

The animator.


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