SCR_LocationMusic Interface Reference

Inheritance diagram for SCR_LocationMusic:

Public Member Functions
override void	Init ()
	Initialize called from MusicManager::EOnInit.
override void	OnDelete ()
	Delete called from MusicManager::OnDelete.
override bool	ShouldPlay ()
	Evaluation on whether the sound should play (upon automatic evaluation of music manager)
Public Member Functions inherited from ScriptedMusic
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.

Protected Member Functions
void	PlayerEnteredHQ (SCR_CampaignMilitaryBaseComponent base)
void	PlayerLeftHQ (SCR_CampaignMilitaryBaseComponent base)

Protected Attributes
bool	m_bPlayerIsInHQ = false

Member Function Documentation

Init()

override void SCR_LocationMusic.Init

(

)

Initialize called from MusicManager::EOnInit.

Implements ScriptedMusic.

OnDelete()

override void SCR_LocationMusic.OnDelete

(

)

Delete called from MusicManager::OnDelete.

Implements ScriptedMusic.

PlayerEnteredHQ()

void SCR_LocationMusic.PlayerEnteredHQ ( SCR_CampaignMilitaryBaseComponent  base )

protected

PlayerLeftHQ()

void SCR_LocationMusic.PlayerLeftHQ ( SCR_CampaignMilitaryBaseComponent  base )

protected

ShouldPlay()

override bool SCR_LocationMusic.ShouldPlay

(

)

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

Implements ScriptedMusic.

Member Data Documentation

m_bPlayerIsInHQ

bool SCR_LocationMusic.m_bPlayerIsInHQ = false

protected

---

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

• Game/Music/SCR_LocationMusic.c