Table of Contents

Wwise SDK 2018.1.11
ak.soundengine.setSwitch


Set the State of a Switch Group. See AK::SoundEngine::SetSwitch.

Supported by

Graphical User Interface.

Arguments

Name Type Description
switchGroup *   Either the ID (GUID), name, or short ID of the Switch Group.
switchState *   Either the ID (GUID), name, or short ID of the Switch State.
gameObject * integer Associated game object ID.

(Required *)

Arguments Details


switchGroup

description : Either the ID (GUID), name, or short ID of the Switch Group.
Possibilities, one of the following :

1) type : string
pattern : ^[a-zA-Z_]+[a-zA-Z_0-9]*$

2) 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}\}$

3) type : integer
minimum : 0
maximum : 4294967295

switchState

description : Either the ID (GUID), name, or short ID of the Switch State.
Possibilities, one of the following :

1) type : string
pattern : ^[a-zA-Z_]+[a-zA-Z_0-9]*$

2) 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}\}$

3) type : integer
minimum : 0
maximum : 4294967295

gameObject

description : Associated game object ID.
type : integer
minimum : 0
maximum : 18446744073709551615


Examples :

Setting the Switch Group to another State using names.

Sets "switchGroup" to the "switchState" for "gameObject".

Arguments:

{
"switchGroup": "Ground",
"switchState": "Gravel",
"gameObject": 1122334
}

Setting the Switch Group to another State using short IDs.

Sets "switchGroup" to the "switchState" for "gameObject".

Arguments:

{
"switchGroup": 1270826848,
"switchState": 1208172755,
"gameObject": 1122334
}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"switchGroup": {
"description": "Either the ID (GUID), name, or short ID of the Switch Group.",
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z_]+[a-zA-Z_0-9]*$"
},
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
]
},
"switchState": {
"description": "Either the ID (GUID), name, or short ID of the Switch State.",
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z_]+[a-zA-Z_0-9]*$"
},
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
]
},
"gameObject": {
"description": "Associated game object ID.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
}
},
"required": [
"switchGroup",
"switchState",
"gameObject"
],
"additionalProperties": false
}


Options :

{
"type": "object",
"properties": {},
"additionalProperties": false
}


Response :

{
"type": "object",
"properties": {},
"additionalProperties": false
}

Document version : 1