DarkTonic.MasterAudio.ICustomEventReceiver Interface Reference

This interface is used by EventSounds and can be implemented on your custom classes to listen for Custom Events that are fired. More...

Public Member Functions
void	CheckForIllegalCustomEvents ()
	This checks for events that are not found in MasterAudio. It's a good idea to call this in Start (Awake is too early), and save yourself some troubleshooting time! Optional More...
void	ReceiveEvent (string customEventName, Vector3 originPoint)
	This receives the event when it's fired. More...
bool	SubscribesToEvent (string customEventName)
	This returns a bool of whether the specified custom event is subscribed to in this class More...
void	RegisterReceiver ()
	Registers the receiver with MasterAudio. Call this in OnEnable More...
void	UnregisterReceiver ()
	Unregisters the receiver with MasterAudio. Call this in OnDisable More...
IList< AudioEventGroup >	GetAllEvents ()
	Retrieves a list of all the events this receiver subscribes to More...

Detailed Description

This interface is used by EventSounds and can be implemented on your custom classes to listen for Custom Events that are fired.

Member Function Documentation

void DarkTonic.MasterAudio.ICustomEventReceiver.CheckForIllegalCustomEvents

(

)

This checks for events that are not found in MasterAudio. It's a good idea to call this in Start (Awake is too early), and save yourself some troubleshooting time! Optional

IList<AudioEventGroup> DarkTonic.MasterAudio.ICustomEventReceiver.GetAllEvents

(

)

Retrieves a list of all the events this receiver subscribes to

void DarkTonic.MasterAudio.ICustomEventReceiver.ReceiveEvent	(	string	customEventName,
		Vector3	originPoint
	)

This receives the event when it's fired.

void DarkTonic.MasterAudio.ICustomEventReceiver.RegisterReceiver

(

)

Registers the receiver with MasterAudio. Call this in OnEnable

bool DarkTonic.MasterAudio.ICustomEventReceiver.SubscribesToEvent

(

string

customEventName

)

This returns a bool of whether the specified custom event is subscribed to in this class

void DarkTonic.MasterAudio.ICustomEventReceiver.UnregisterReceiver

(

)

Unregisters the receiver with MasterAudio. Call this in OnDisable

---

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

• Assets/Plugins/DarkTonic/MasterAudio/Scripts/Settings/ICustomEventReceiver.cs