PlatformerPro.SoundEffect_Bridge Class Reference

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

Inheritance diagram for PlatformerPro.SoundEffect_Bridge:

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

Public Attributes
List< SoundEffectMapping >	mappings
	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...
IEnumerator	RepeatSound (SoundEffectMapping se)
	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 sounds when the character enters certain states.

Member Function Documentation

AnimationStateChanged()

void PlatformerPro.SoundEffect_Bridge.AnimationStateChanged ( object  sender, AnimationEventArgs  args  )

protected

Handles animation state changed.

Parameters

sender	Sender.
args	Arguments.

Init()

void PlatformerPro.SoundEffect_Bridge.Init ( )

protected

Initialise this animation bridge.

RepeatSound()

IEnumerator PlatformerPro.SoundEffect_Bridge.RepeatSound ( SoundEffectMapping  se )

protected

Play the sound at an interval.

Parameters

effect	Effect to play.
time	The interval.

Reset()

void PlatformerPro.SoundEffect_Bridge.Reset

(

)

Called when the animator is changed.

Implements PlatformerPro.IAnimationBridge.

Member Data Documentation

mappings

List<SoundEffectMapping> PlatformerPro.SoundEffect_Bridge.mappings

Maps from states to animator overrides.

myCharacter

IMob PlatformerPro.SoundEffect_Bridge.myCharacter

protected

Cached reference to the character.

Property Documentation

Animator

Animator PlatformerPro.SoundEffect_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:

• D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Audio/SoundEffect_Bridge.cs