Scaleform Studio Lua API Reference: scaleform.SoundComponent object reference
scaleform.SoundComponent object reference
Description
An interface to sound component for Wwise audio.
Inheritance 
Constructors and accessors
Related help topics
Functions
Parameters
Returns
owner : |
The owner actor of the component. | |
sound_bank : | string? |
Sound bank name. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
event_name : | string? |
Sound event name. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
lang : | string? |
Current language. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
The newly created SoundComponent. |
Parameters
Returns
self : |
The sound component. |
string |
Returns sound event name. |
Parameters
Returns
self : |
The sound component. |
string |
Returns current language. |
Parameters
Returns
self : |
The sound component. | |
sound_bank : | string |
Sound bank name. |
boolean |
Returns if the sound bank was successfully loaded. |
Parameters
Returns
self : |
The sound component. |
boolean |
Returns true if success and false otherwise. |
Parameters
Returns
self : |
The sound component. |
boolean |
Returns true if success and false otherwise. |
Parameters
Returns
self : |
The sound component. | |
event_name : | string |
The event name to trigger |
| This function does not return any values. |
Parameters
Returns
self : |
The sound component. | |
param_name : | string |
Parameter name. |
param_value : | number |
Parameter value. |
global : | boolean? |
Specifies if parameter is global. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
boolean |
Returns true if success and false otherwise. |
Parameters
Returns
self : |
The sound component. |
string |
Returns sound bank name. |
Parameters
Returns
self : |
The sound component. |
boolean |
Returns true if success and false otherwise. |
scaleform.ComponentThe root type of all actor components.
scaleform.SoundComponent.create (owner, sound_bank, event_name, lang) : scaleform.SoundComponentCreates a new sound component.
owner : scaleform.ActorThe owner actor of the component.
sound_bank : string?Sound bank name.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
event_name : string?Sound event name.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
lang : string?Current language.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.SoundComponentThe newly created SoundComponent.
scaleform.ActorGeneric objects located in a scene. A string of characters.
scaleform.SoundComponentAn interface to sound component for Wwise audio.
scaleform.SoundComponent.event_name (self) : stringReturns sound event name.
self : scaleform.SoundComponentThe sound component.
stringReturns sound event name.
scaleform.SoundComponent.language (self) : stringReturns current language.
self : scaleform.SoundComponentThe sound component.
stringReturns current language.
scaleform.SoundComponent.load_sound_bank (self, sound_bank) : booleanCreates a new sound component.
self : scaleform.SoundComponentThe sound component.
sound_bank : stringSound bank name.
booleantrue or false. scaleform.SoundComponent.pause_event (self) : booleanPauses playback of an active event.
self : scaleform.SoundComponentThe sound component.
boolean scaleform.SoundComponent.resume_event (self) : booleanResumes playback of an active event.
self : scaleform.SoundComponentThe sound component.
boolean scaleform.SoundComponent.set_event (self, event_name) Sets the event that the sound component will trigger.
self : scaleform.SoundComponentThe sound component.
event_name : stringThe event name to trigger
scaleform.SoundComponent.set_parameter (self, param_name, param_value, global) : booleanSets the value of a real-time parameter control.
self : scaleform.SoundComponentThe sound component.
param_name : stringParameter name.
param_value : numberParameter value.
global : boolean?Specifies if parameter is global.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
booleanA numeric value. scaleform.SoundComponent.sound_bank (self) : stringReturns sound bank name.
self : scaleform.SoundComponentThe sound component.
stringReturns sound bank name.
scaleform.SoundComponent.stop_event (self) : booleanStops playback of an active event.
self : scaleform.SoundComponentThe sound component.
boolean scaleform.SoundComponent.trigger_event (self) : booleanAsynchronously trigger an event in the sound engine.
self : scaleform.SoundComponentThe sound component.
booleanIndicates a table. This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.