目次
|
Wwise SDK 2018.1.11
|
ak.soundengine.postTrigger
Post the specified Trigger. See AK::SoundEngine::PostTrigger.
Supported by
Graphical User Interface.
Arguments
| Name | Type | Description |
|---|---|---|
| trigger * | Either the ID (GUID), name, or short ID of the Trigger. | |
| gameObject * | integer | Associated game object ID. |
(Required *)
Arguments Details
trigger
description : Either the ID (GUID), name, or short ID of the Trigger.
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 :
Posting a Trigger by name
Posts the specified "trigger" by name to be applied on "gameObject".
Arguments:
{
"trigger": "MyTrigger",
"gameObject": 1122334
}
Result:
{}
Posting a Trigger by GUID
Posts the specified "trigger" by GUID to be applied on "gameObject".
Arguments:
{
"trigger": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"gameObject": 1122334
}
Result:
{}
Detailed JSON Schema
Arguments :
{
"type": "object",
"properties": {
"trigger": {
"description": "Either the ID (GUID), name, or short ID of the Trigger.",
"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": [
"trigger",
"gameObject"
],
"additionalProperties": false
}
Options :
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Response :
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Document version : 1
