バージョン
Retrieves the status of a property.
Graphical User Interface, Command-Line Interface.
| Name | Type | Description |
|---|---|---|
| object * | The ID (GUID) or path of the object to check. | |
| platform * | string | The ID (GUID) or path of the platform to link the reference. Set to null-guid for unlinked reference. |
| property * | string | The name of the property. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference. |
(Required *)
description : The ID (GUID) or path of the object to check.
Possibilities, one of the following :
1) 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}\}$
2) type : string
pattern : ^\
description : The ID (GUID) or path of the platform to link the reference. Set to null-guid for unlinked reference.
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}\}$
type : string
description : The name of the property. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference.
pattern : ^[a-zA-Z0-9 _]+$
| Name | Type | Description |
|---|---|---|
| return | boolean | Indicates if the property is enabled. |
type : boolean
description : Indicates if the property is enabled.
Checks if a property is enabled.
{
"object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"platform": "{66666666-7777-8888-9999-AAAAAAAAAAAA}",
"property": "Volume"
}
{
"return": true
}
{
"type": "object",
"properties": {
"object": {
"description": "The ID (GUID) or path of the object to check.",
"anyOf": [
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
},
"platform": {
"description": "The ID (GUID) or path of the platform to link the reference. Set to null-guid for unlinked reference.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"property": {
"type": "string",
"description": "The name of the property.",
"pattern": "^[a-zA-Z0-9 _]+$"
}
},
"required": [
"object",
"platform",
"property"
],
"additionalProperties": false
}
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"return": {
"type": "boolean",
"description": "Indicates if the property is enabled."
}
},
"additionalProperties": false
}
Document version : 1