Master Audio - AAA Sound Solution!  v2022
The ultimate AAA audio config tool
DarkTonic.MasterAudio.PlaySoundResult Class Reference

This class is returned from MasterAudio.PlaySound methods unless you choose one of the 'AndForget' methods. It tells you whether the sound was played, scheduled or neither. It also contains a reference to the Variation used to play the sound. More...

Properties

bool SoundPlayed [get, set]
 This property will tell you whether the sound was played or not. More...
 
bool SoundScheduled [get, set]
 This property will tell you whether the sound was scheduled or not. More...
 
SoundGroupVariation ActingVariation [get, set]
 This property will give you a reference to the Variation chosen, so you can do things to it like fade out, get notified of completion, etc. More...
 

Detailed Description

This class is returned from MasterAudio.PlaySound methods unless you choose one of the 'AndForget' methods. It tells you whether the sound was played, scheduled or neither. It also contains a reference to the Variation used to play the sound.

Property Documentation

SoundGroupVariation DarkTonic.MasterAudio.PlaySoundResult.ActingVariation
getset

This property will give you a reference to the Variation chosen, so you can do things to it like fade out, get notified of completion, etc.

bool DarkTonic.MasterAudio.PlaySoundResult.SoundPlayed
getset

This property will tell you whether the sound was played or not.

bool DarkTonic.MasterAudio.PlaySoundResult.SoundScheduled
getset

This property will tell you whether the sound was scheduled or not.


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