Audio Updater Role Parameters

Detailed Description

Collaboration diagram for Audio Updater Role Parameters:

Variables
constexpr const char *	AudioUpdaterConfig::audio = "audio"
constexpr const char *	AudioUpdaterConfig::audioPath = "audioPath"
constexpr const char *	AudioUpdaterConfig::decibels = "decibels"
constexpr const char *	AudioUpdaterConfig::gain = "gain"
constexpr const char *	AudioUpdaterConfig::is3d = "is3d"
constexpr const char *	AudioUpdaterConfig::looping = "looping"
constexpr const char *	AudioUpdaterConfig::sources = "sources"
constexpr const char *	AudioUpdaterConfig::stateAttribute = "stateAttribute"

Variable Documentation

audio

const char* AudioUpdaterConfig::audio = "audio"

constexpr

Parameter Name	audio
Parameter Description	Filename of the audio clip for a single source entry inside the sources table (resolved relative to audioPath).
Parameter Type	string
Parameter Default	N/A
Required?	Yes

Example Role Config Usage:

["audioUpdater"] = { 
   ... 
   audio = "example.wav"; 
   ... 
};

audioPath

const char* AudioUpdaterConfig::audioPath = "audioPath"

constexpr

Parameter Name	audioPath
Parameter Description	Base path for locating audio files used by configured sources.
Parameter Type	string
Parameter Default	"$(SHARED_DATA_DIR)/Audio/"
Required?	No

Example Role Config Usage:

["audioUpdater"] = { 
   ... 
   audioPath = "$(SHARED_DATA_DIR)/Audio/"; 
   ... 
};

decibels

const char* AudioUpdaterConfig::decibels = "decibels"

constexpr

Parameter Name	decibels
Parameter Description	Default decibel level applied to an audio source if not explicitly specified in its entry.
Parameter Type	float
Parameter Default	80.0
Required?	No

Example Role Config Usage:

["audioUpdater"] = { 
   ... 
   decibels = 80.0; 
   ... 
};

gain

const char* AudioUpdaterConfig::gain = "gain"

constexpr

Parameter Name	gain
Parameter Description	Default gain multiplier applied to an audio source if not explicitly specified in its entry.
Parameter Type	float
Parameter Default	1.0
Required?	No

Example Role Config Usage:

["audioUpdater"] = { 
   ... 
   gain = 1.0; 
   ... 
};

is3d

const char* AudioUpdaterConfig::is3d = "is3d"

constexpr

Parameter Name	is3d
Parameter Description	Whether an audio source is spatialized in 3D (position follows the entity) by default.
Parameter Type	bool
Parameter Default	true
Required?	No

Example Role Config Usage:

["audioUpdater"] = { 
   ... 
   is3d = true; 
   ... 
};

looping

const char* AudioUpdaterConfig::looping = "looping"

constexpr

Parameter Name	looping
Parameter Description	Whether an audio source should loop continuously when enabled by default.
Parameter Type	bool
Parameter Default	true
Required?	No

Example Role Config Usage:

["audioUpdater"] = { 
   ... 
   looping = true; 
   ... 
};

sources

const char* AudioUpdaterConfig::sources = "sources"

constexpr

Parameter Name	sources
Parameter Description	Table (list) of per-sound source configuration entries defining audio playback behavior.
Parameter Type	table
Parameter Default	""
Required?	No

Example Role Config Usage:

["audioUpdater"] = { 
   ... 
   sources = ""; 
   ... 
};

stateAttribute

const char* AudioUpdaterConfig::stateAttribute = "stateAttribute"

constexpr

Parameter Name	stateAttribute
Parameter Description	Name of the boolean state attribute that enables playback for a source entry (empty string means always enabled).
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["audioUpdater"] = { 
   ... 
   stateAttribute = ""; 
   ... 
};