Version

menu_open
Wwise SDK 2023.1.4
ak.wwise.core.object.setStateProperties

Set the state properties of an object. Note, this will remove any previous state property, including the default ones.

Arguments

Name Type Description
object * any of: The ID (GUID), name, or path of the object to which to set the state properties.
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
stateProperties * array An array of state properties to set.
stateProperties [...] string The name of the property to set.

(Required *)

Arguments Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise