Highroad Engine v1.3
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
MoreMountains.Tools.MMSoundManagerSoundControlEvent Struct Reference

An event used to control a specific sound on the MMSoundManager. You can either search for it by ID, or directly pass an audiosource if you have it. More...

Public Member Functions

 MMSoundManagerSoundControlEvent (MMSoundManagerSoundControlEventTypes eventType, int soundID, AudioSource source=null)
 

Static Public Member Functions

static void Trigger (MMSoundManagerSoundControlEventTypes eventType, int soundID, AudioSource source=null)
 

Public Attributes

int SoundID
 the ID of the sound to control (has to match the one used to play it) More...
 
MMSoundManagerSoundControlEventTypes MMSoundManagerSoundControlEventType
 the control mode More...
 
AudioSource TargetSource
 the audiosource to control (if specified) More...
 

Static Public Attributes

static MMSoundManagerSoundControlEvent e
 

Detailed Description

An event used to control a specific sound on the MMSoundManager. You can either search for it by ID, or directly pass an audiosource if you have it.

Example : MMSoundManagerSoundControlEvent.Trigger(MMSoundManagerSoundControlEventTypes.Stop, 33); will cause the sound(s) with an ID of 33 to stop playing

Constructor & Destructor Documentation

◆ MMSoundManagerSoundControlEvent()

MoreMountains.Tools.MMSoundManagerSoundControlEvent.MMSoundManagerSoundControlEvent ( MMSoundManagerSoundControlEventTypes  eventType,
int  soundID,
AudioSource  source = null 
)

Member Function Documentation

◆ Trigger()

static void MoreMountains.Tools.MMSoundManagerSoundControlEvent.Trigger ( MMSoundManagerSoundControlEventTypes  eventType,
int  soundID,
AudioSource  source = null 
)
static

Member Data Documentation

◆ e

MMSoundManagerSoundControlEvent MoreMountains.Tools.MMSoundManagerSoundControlEvent.e
static

◆ MMSoundManagerSoundControlEventType

MMSoundManagerSoundControlEventTypes MoreMountains.Tools.MMSoundManagerSoundControlEvent.MMSoundManagerSoundControlEventType

the control mode

◆ SoundID

int MoreMountains.Tools.MMSoundManagerSoundControlEvent.SoundID

the ID of the sound to control (has to match the one used to play it)

◆ TargetSource

AudioSource MoreMountains.Tools.MMSoundManagerSoundControlEvent.TargetSource

the audiosource to control (if specified)


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