버전

menu_open

ak.soundengine.setSwitch


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

(Required *)

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.


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", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}


Response :

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

Document version : 1


이 페이지가 도움이 되었나요?

지원이 필요하신가요?

질문이 있으신가요? 문제를 겪고 계신가요? 더 많은 정보가 필요하신가요? 저희에게 문의해주시면 도와드리겠습니다!

지원 페이지를 방문해 주세요

작업하는 프로젝트에 대해 알려주세요. 언제든지 도와드릴 준비가 되어 있습니다.

프로젝트를 등록하세요. 아무런 조건이나 의무 사항 없이 빠른 시작을 도와드리겠습니다.

Wwise를 시작해 보세요