目次

Wwise SDK 2018.1.11
ak.wwise.core.object.isPropertyEnabled


Retrieves the status of a property.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name Type Description
object *   The ID (GUID), name, or path of the object to check.
platform * string The ID (GUID) 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 *)

Arguments Details


object

description : The ID (GUID), name, or path of the object to check.
Possibilities, one of the following :

1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
description : The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported.

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 : string
pattern : ^\

platform

description : The ID (GUID) 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}\}$

property

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 _]+$


Result

Name Type Description
return boolean Indicates if the property is enabled.

Result Details


return

type : boolean
description : Indicates if the property is enabled.


Examples :

Checking if a property is enabled.

Checks if a property is enabled.

Arguments:

{
"object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"platform": "{66666666-7777-8888-9999-AAAAAAAAAAAA}",
"property": "Volume"
}

Result:

{
"return": true
}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"object": {
"description": "The ID (GUID), name, or path of the object to check.",
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$",
"description": "The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported."
},
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
},
"platform": {
"description": "The ID (GUID) 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
}


Options :

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


Response :

{
"type": "object",
"properties": {
"return": {
"type": "boolean",
"description": "Indicates if the property is enabled."
}
},
"additionalProperties": false
}

Document version : 1