ScriptedMusic Interface Reference

Inheritance diagram for ScriptedMusic:

Public Member Functions
proto external string	GetName ()
	Gets the sound event name.
proto external void	SetName (string name)
	Sets the name of the SoundEvent that will be played on evaluation/playing of the music.
bool	ShouldPlay ()
	Evaluation on whether the sound should play (upon automatic evaluation of music manager)
void	Init ()
	Initialize called from MusicManager::EOnInit.
void	Update (float dt)
	Update called from MusicManager::EOnFrame.
void	OnDelete ()
	Delete called from MusicManager::OnDelete.
void	OnPlay ()
	Callback that is called upon starting to play this music.
void	OnStop ()
	Callback that is called when this music has stopped playing.

Member Function Documentation

GetName()

proto external string ScriptedMusic.GetName

(

)

Gets the sound event name.

Init()

void ScriptedMusic.Init

(

)

Initialize called from MusicManager::EOnInit.

Implemented in SCR_BaseCaptureMusic, SCR_DeathMusic, SCR_EnterEnemyMilitaryBaseMusic, SCR_GameEndMusic, SCR_LocationMusic, SCR_RespawnMusic, and SCR_SpawnMusic.

OnDelete()

void ScriptedMusic.OnDelete

(

)

Delete called from MusicManager::OnDelete.

Implemented in SCR_BaseCaptureMusic, SCR_DeathMusic, SCR_EnterEnemyMilitaryBaseMusic, SCR_GameEndMusic, SCR_LocationMusic, SCR_RespawnMusic, and SCR_SpawnMusic.

OnPlay()

void ScriptedMusic.OnPlay

(

)

Callback that is called upon starting to play this music.

Implemented in SCR_RespawnMusic.

OnStop()

void ScriptedMusic.OnStop

(

)

Callback that is called when this music has stopped playing.

Implemented in SCR_RespawnMusic.

SetName()

proto external void ScriptedMusic.SetName

(

string

name

)

Sets the name of the SoundEvent that will be played on evaluation/playing of the music.

ShouldPlay()

bool ScriptedMusic.ShouldPlay

(

)

Evaluation on whether the sound should play (upon automatic evaluation of music manager)

Implemented in SCR_LocationMusic.

Update()

void ScriptedMusic.Update

(

float

dt

)

Update called from MusicManager::EOnFrame.

---

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

• Game/generated/Music/ScriptedMusic.c