Version

menu_open
Wwise SDK 2023.1.5
ak.wwise.core.object.setRandomizer Arguments Schema

Schema

{
"type": "object",
"properties": {
"object": {
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture|Global):[a-zA-Z0-9_]+$",
"description": "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"
},
{
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"type": "string",
"pattern": "^\\\\",
"description": "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."
}
],
"description": "The ID (GUID), name, or path of the object owning the property."
},
"property": {
"type": "string",
"pattern": "^[:a-zA-Z0-9 _]+$",
"description": "The name of the property. For more information, refer to the property list of Wwise Objects listed in \\ref wobjects_index .\\n A property name. Refer to \\ref wobjects_index for information about the Wwise objects and their properties."
},
"platform": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z_]+[a-zA-Z_0-9()]*$",
"description": "The name of the object."
},
{
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
],
"description": "The ID (GUID) or unique name of the platform."
},
"enabled": {
"type": "boolean",
"description": "Enabled state of the randomizer."
},
"min": {
"type": "number",
"maximum": 0,
"description": "Minimum value that the randomizer can offset by."
},
"max": {
"type": "number",
"minimum": 0,
"description": "Maximum value that the randomizer can offset by."
}
},
"anyOf": [
{
"required": [
"object",
"property",
"enabled"
]
},
{
"required": [
"object",
"property",
"min"
]
},
{
"required": [
"object",
"property",
"max"
]
}
],
"additionalProperties": false
}

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