Plasma Engine  2.0
Loading...
Searching...
No Matches
plAudioSystemTriggerState Struct Reference

The state of an audio trigger. More...

#include <AudioSystemData.h>

Inheritance diagram for plAudioSystemTriggerState:

Public Types

enum  Enum : StorageType {
  Invalid = 0 , Playing = 1 , Ready = 2 , Loading = 3 ,
  Unloading = 4 , Starting = 5 , Stopping = 6 , Stopped = 7 ,
  Default = Invalid
}
 
using StorageType = plUInt8
 

Public Member Functions

 PL_ENUM_TO_STRING (Invalid, Playing, Ready, Loading, Unloading, Starting, Stopping, Stopped)
 

Detailed Description

The state of an audio trigger.

Member Enumeration Documentation

◆ Enum

enum plAudioSystemTriggerState::Enum : StorageType
Enumerator
Invalid 

The trigger have no state, this means it has not been loaded yet by the audio middleware.

Playing 

The trigger is activated and currently playing an event.

Ready 

The trigger is ready to be activated. This state is set after the trigger is loaded through LoadTrigger.

Loading 

The trigger is being loaded.

Unloading 

The trigger is being unloaded.

Starting 

The trigger is being activated.

Stopping 

The trigger is being stopped.

Stopped 

The trigger is stopped, and not playing an event.


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