Infinite Runner Engine v1.9
Public Attributes | Protected Member Functions | Protected Attributes | List of all members
MoreMountains.InfiniteRunnerEngine.PersistentBackgroundMusic Class Reference

Add this class to a GameObject to have it play a background music when instanciated. Careful : only one background music will be played at a time. More...

Inheritance diagram for MoreMountains.InfiniteRunnerEngine.PersistentBackgroundMusic:
MoreMountains.Tools.MMPersistentSingleton< PersistentBackgroundMusic >

Public Attributes

AudioClip SoundClip
 The audioclip to play. More...
 
- Public Attributes inherited from MoreMountains.Tools.MMPersistentSingleton< PersistentBackgroundMusic >
bool AutomaticallyUnparentOnAwake
 if this is true, this singleton will auto detach if it finds itself parented on awake More...
 

Protected Member Functions

virtual void Start ()
 Gets the AudioSource associated to that GameObject, and asks the GameManager to play it. More...
 
- Protected Member Functions inherited from MoreMountains.Tools.MMPersistentSingleton< PersistentBackgroundMusic >
virtual void Awake ()
 On awake, we check if there's already a copy of the object in the scene. If there's one, we destroy it. More...
 

Protected Attributes

AudioSource _source
 
- Protected Attributes inherited from MoreMountains.Tools.MMPersistentSingleton< PersistentBackgroundMusic >
bool _enabled
 

Additional Inherited Members

- Static Protected Attributes inherited from MoreMountains.Tools.MMPersistentSingleton< PersistentBackgroundMusic >
static T _instance
 
- Properties inherited from MoreMountains.Tools.MMPersistentSingleton< PersistentBackgroundMusic >
static bool HasInstance [get]
 
static T Current [get]
 
static T Instance [get]
 Singleton design pattern More...
 

Detailed Description

Add this class to a GameObject to have it play a background music when instanciated. Careful : only one background music will be played at a time.

Member Function Documentation

◆ Start()

virtual void MoreMountains.InfiniteRunnerEngine.PersistentBackgroundMusic.Start ( )
protectedvirtual

Gets the AudioSource associated to that GameObject, and asks the GameManager to play it.

Member Data Documentation

◆ _source

AudioSource MoreMountains.InfiniteRunnerEngine.PersistentBackgroundMusic._source
protected

◆ SoundClip

AudioClip MoreMountains.InfiniteRunnerEngine.PersistentBackgroundMusic.SoundClip

The audioclip to play.


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