ak.wwise.core.object.propertyChanged

Sent when the watched property of an object changes.

(Required *)

Supported by

Graphical User Interface, Command-Line Interface.

Options

Name	Type	Description
object *		The ID (GUID) or path of the object to watch.
property *	string	The property of the watched object to watch.
return	array	Data to be returned for every change on "property" of "object". Refer to Wwise Objects Reference for more information on the properties available.
platform	string	The ID (GUID) of the platform.

description : The ID (GUID) or path of the object to watch.
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 : ^\

property

type : string
pattern : ^[a-zA-Z]
description : The property of the watched object to watch.

return

description : Data to be returned for every change on "property" of "object". Refer to Wwise Objects Reference for more information on the properties available.
type : array

optionsSchema / return / ...

items

Possibilities, one of the following :

1) type : string
description : Specifies one or many of the built-in accessors for Wwise objects.
Possible values : "id", "name", "notes", "type", "shortId", "category", "filePath", "workunit", "parent", "owner", "path", "isPlayable", "childrenCount", "sound:convertedWemFilePath", "sound:originalWavFilePath", "soundbank:bnkFilePath", "music:transitionRoot", "music:playlistRoot", "workunit:isDefault", "workunit:type", "workunit:isDirty"

2) type : string
description : Specifies one or many property names for Wwise objects. Specifying a single @ returns the value of the property for the associated object. Specifying a double @ returns the value of the property for the source of override. Refer to Wwise Objects Reference.
pattern : ^@?[_a-zA-Z][_a-zA-Z0-9]*$

platform

description : The ID (GUID) of the platform.
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}$

Publications Format

Name	Type	Description
object	string	The ID (GUID) of the watched object.
property *	string	The watched property of the watched object.
old *
new *

Detailed JSON Schema

Options :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID) or path of the object to watch.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }, 
        "property": {
            "type": "string", 
            "pattern": "^[a-zA-Z]", 
            "description": "The property of the watched object to watch."
        }, 
        "return": {
            "description": "Data to be returned for every change on \"property\" of \"object\".", 
            "type": "array", 
            "items": {
                "anyOf": [
                    {
                        "type": "string", 
                        "description": "Specifies one or many of the built-in accessors for Wwise objects.", 
                        "enum": [
                            "id", 
                            "name", 
                            "notes", 
                            "type", 
                            "shortId", 
                            "category", 
                            "filePath", 
                            "workunit", 
                            "parent", 
                            "owner", 
                            "path", 
                            "isPlayable", 
                            "childrenCount", 
                            "sound:convertedWemFilePath", 
                            "sound:originalWavFilePath", 
                            "soundbank:bnkFilePath", 
                            "music:transitionRoot", 
                            "music:playlistRoot", 
                            "workunit:isDefault", 
                            "workunit:type", 
                            "workunit:isDirty"
                        ]
                    }, 
                    {
                        "type": "string", 
                        "description": "Specifies one or many property names for Wwise objects. Specifying a single @ returns the value of the property for the associated object. Specifying a double @@ returns the value of the property for the source of override.", 
                        "pattern": "^@@?[_a-zA-Z][_a-zA-Z0-9]*$"
                    }
                ]
            }
        }, 
        "platform": {
            "description": "The ID (GUID) of the platform.", 
            "type": "string", 
            "pattern": *Must be a valid GUID*
        }
    }, 
    "required": [
        "object", 
        "property"
    ], 
    "additionalProperties": false
}

Publication schema :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID) of the watched object.", 
            "type": "string", 
            "pattern": *Must be a valid GUID*
        }, 
        "property": {
            "type": "string", 
            "pattern": "^[a-zA-Z]+", 
            "description": "The watched property of the watched object."
        }, 
        "old": {
            "oneOf": [
                {
                    "type": "string"
                }, 
                {
                    "type": "number"
                }, 
                {
                    "type": "boolean"
                }
            ]
        }, 
        "new": {
            "oneOf": [
                {
                    "type": "string"
                }, 
                {
                    "type": "number"
                }, 
                {
                    "type": "boolean"
                }
            ]
        }
    }, 
    "required": [
        "id", 
        "property", 
        "old", 
        "new"
    ], 
    "additionalProperties": false
}

Document version : 1

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Get started with Wwise

Wwise SDK 2017.1.9