ak.soundengine.unregisterGameObj

Unregister a game object. Registering a game object twice does nothing. Unregistering it once unregisters it no matter how many times it has been registered. Unregistering a game object while it is in use is allowed, but the control over the parameters of this game object is lost. For example, say a sound associated with this game object is a 3D moving sound. It will stop moving when the game object is unregistered, and there will be no way to regain control over the game object. See AK::SoundEngine::UnregisterGameObj.

Supported by

Graphical User Interface.

Arguments

(Required *)

Arguments Details

gameObject

description : ID of the game object to be unregistered. Use AK_INVALID_GAME_OBJECT to unregister all game objects.
type : integer
minimum : 0
maximum : 18446744073709551615

Examples :

Unregistering a game object

Unregisters "gameObject".

Arguments:

{
    "gameObject": 1122334
}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "gameObject": {
            "description": "ID of the game object to be unregistered. Use \\c AK_INVALID_GAME_OBJECT to unregister all game objects.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }
    }, 
    "required": [
        "gameObject"
    ], 
    "additionalProperties": false
}

Options :

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

Response :

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

Document version : 1