MusicManager Interface Reference

Inheritance diagram for MusicManager:

Public Member Functions
proto external void	Play (string musicName)
	'Forces' a sound to play without taking into account the automated evaluation process
proto external void	Stop (string musicName)
	Stops either a specific Music that is playing by name OR stops whatever is currently playing (when the string is empty)
proto external void	MuteCategory (MusicCategory musicCategory, bool mute, bool stopNow)
	(Un)Mutes a category locally. Does not influence any categories muted from server side
proto external void	RequestServerMuteCategory (MusicCategory musicCategory, bool mute)
	Requests server (from any client) to mute a category on the server, this muted category is seperated from your own (locally) muted categories.
proto external bool	ServerIsCategoryMuted (MusicCategory musicCategory)
	Checks whether a given category is muted by the server (game master)
proto external void	SetManagerSignals ()
	Sets default used MusicManager signals.
proto external int	GetSignalIndex (string name)
	Get index for signal name. Return -1 if signal not found.
proto external void	SetSignalValue (int index, float value)
	Set signal value by 'index'. Index is obtained by GetSignalIndex method.
proto external void	SetSignalValueStr (string signal, float value)
	Set signal value by signal name.

Member Function Documentation

GetSignalIndex()

proto external int MusicManager.GetSignalIndex

(

string

name

)

Get index for signal name. Return -1 if signal not found.

MuteCategory()

proto external void MusicManager.MuteCategory	(	MusicCategory	musicCategory,
		bool	mute,
		bool	stopNow
	)

(Un)Mutes a category locally. Does not influence any categories muted from server side

Play()

proto external void MusicManager.Play

(

string

musicName

)

'Forces' a sound to play without taking into account the automated evaluation process

RequestServerMuteCategory()

proto external void MusicManager.RequestServerMuteCategory	(	MusicCategory	musicCategory,
		bool	mute
	)

Requests server (from any client) to mute a category on the server, this muted category is seperated from your own (locally) muted categories.

ServerIsCategoryMuted()

proto external bool MusicManager.ServerIsCategoryMuted

(

MusicCategory

musicCategory

)

Checks whether a given category is muted by the server (game master)

SetManagerSignals()

proto external void MusicManager.SetManagerSignals

(

)

Sets default used MusicManager signals.

SetSignalValue()

proto external void MusicManager.SetSignalValue	(	int	index,
		float	value
	)

Set signal value by 'index'. Index is obtained by GetSignalIndex method.

SetSignalValueStr()

proto external void MusicManager.SetSignalValueStr	(	string	signal,
		float	value
	)

Set signal value by signal name.

Stop()

proto external void MusicManager.Stop

(

string

musicName

)

Stops either a specific Music that is playing by name OR stops whatever is currently playing (when the string is empty)

---

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

• Game/generated/Entities/MusicManager.c