Wwise SDK 2018.1.11

Register a game object. Registering a game object twice does nothing. Unregistering it once unregisters it no matter how many times it has been registered. See AK::SoundEngine::RegisterGameObj.

Supported by

Graphical User Interface.

Arguments

Name	Type	Description
gameObject *	integer	ID of the game object to be registered.
name *	string	Name of the game object (for monitoring purpose).

(Required *)

Arguments Details

gameObject

description : ID of the game object to be registered.
type : integer
minimum : 0
maximum : 18446744073709551615

name

type : string
description : Name of the game object (for monitoring purpose).

Examples :

Registering a game object

Registers the "MyGameObjectName" game object.

Arguments:

{
    "gameObject": 1122334, 
    "name": "MyGameObjectName"
}

Result:

{}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "gameObject": {
            "description": "ID of the game object to be registered.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }, 
        "name": {
            "type": "string", 
            "description": "Name of the game object (for monitoring purpose)."
        }
    }, 
    "required": [
        "gameObject", 
        "name"
    ], 
    "additionalProperties": false
}

Options :

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

Response :

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

Document version : 1