ak.wwise.core.object.setReference

Sets an object's reference value.

(Required *)

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name	Type	Description
object *		The ID (GUID) or path of the object which has the reference.
platform	string	The ID (GUID) or path of the platform to link the reference. Set to null-guid for unlinked reference.
reference *	string	The name of the reference to set. See the object's description in wobjects.xml for an object's possible references.
value *		The ID (GUID) or path of the object to be referred to.

description : The ID (GUID) or path of the object which has the reference.
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}$

reference

type : string
description : The name of the reference to set. See the object's description in wobjects.xml for an object's possible references.

value

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

Examples :

Setting an object reference

Arguments:

{
    "object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
    "platform": "{66666666-7777-8888-9999-AAAAAAAAAAAA}", 
    "reference": "OutputBus", 
    "value": "{FFFFFFFF-8888-4444-2222-111111111111}"
}

Result:

{}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID) or path of the object which has the reference.", 
            "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*
        }, 
        "reference": {
            "type": "string", 
            "description": "The name of the reference to set.  See the object's description in wobjects.xml for an object's possible references."
        }, 
        "value": {
            "description": "The ID (GUID) or path of the object to be referred to.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }
    }, 
    "required": [
        "object", 
        "reference", 
        "value"
    ], 
    "additionalProperties": false
}

Options :

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

Response :

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

Document version : 1

Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise

Wwise SDK 2017.1.9