ak.wwise.core.object.isPropertyEnabled

Retrieves the status of a property.

(Required *)

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

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. Refer to the property list for more information. See also Wwise Objects Reference .

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

platform

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}$

property

type : string
description : The name of the property. Refer to the property list for more information. See also Wwise Objects Reference .
pattern : ^[a-zA-Z]

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) 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. Refer to the property list for more information.", 
            "pattern": "^[a-zA-Z]"
        }
    }, 
    "required": [
        "object", 
        "platform", 
        "property"
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}

Response :

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

Document version : 1

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

지원이 필요하신가요?

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

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

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

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

Wwise를 시작해 보세요

Wwise SDK 2017.1.9