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

An 'animator' that plays animations when the character enters certain states. More...

Inheritance diagram for PlatformerPro.ParticleEffect_Bridge:
PlatformerPro.IAnimationBridge

Public Member Functions

void Reset ()
 Called when the animator is changed. More...
 

Public Attributes

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

Protected Member Functions

void Init ()
 Initialise this animation bridge. More...
 
void AnimationStateChanged (object sender, AnimationEventArgs args)
 Handles animation state changed. More...
 
void DoPlay (ParticleEffectMapping p)
 Plays the particle effect More...
 
IEnumerator RepeatEffect (ParticleEffectMapping p)
 Play the sound at an interval. More...
 

Protected Attributes

IMob myCharacter
 Cached reference to the character. More...
 

Properties

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

An 'animator' that plays animations when the character enters certain states.

Member Function Documentation

◆ AnimationStateChanged()

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

Handles animation state changed.

Parameters
senderSender.
argsArguments.

◆ DoPlay()

void PlatformerPro.ParticleEffect_Bridge.DoPlay ( ParticleEffectMapping  p)
protected

Plays the particle effect

◆ Init()

void PlatformerPro.ParticleEffect_Bridge.Init ( )
protected

Initialise this animation bridge.

◆ RepeatEffect()

IEnumerator PlatformerPro.ParticleEffect_Bridge.RepeatEffect ( ParticleEffectMapping  p)
protected

Play the sound at an interval.

◆ Reset()

void PlatformerPro.ParticleEffect_Bridge.Reset ( )

Called when the animator is changed.

Implements PlatformerPro.IAnimationBridge.

Member Data Documentation

◆ mappings

List<ParticleEffectMapping> PlatformerPro.ParticleEffect_Bridge.mappings

Maps from states to animator overrides.

◆ myCharacter

IMob PlatformerPro.ParticleEffect_Bridge.myCharacter
protected

Cached reference to the character.

Property Documentation

◆ Animator

Animator PlatformerPro.ParticleEffect_Bridge.Animator
get

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


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