목차

Wwise SDK 2018.1.11
ak.wwise.core.object.delete


Deletes the specified object.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name Type Description
object *   The ID (GUID), name, or path of the object to be deleted.

(Required *)

Arguments Details


object

description : The ID (GUID), name, or path of the object to be deleted.
Possibilities, one of the following :

1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
description : The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported.

2) 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}\}$

3) type : string
pattern : ^\


Examples :

Deleting an object by GUID.

Deletes the object specified by GUID.

Arguments:

{
"object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}"
}

Result:

{}

Deleting an object by path.

Deletes the MyTone object specified by its path.

Arguments:

{
"object": "\\Actor-Mixer Hierarchy\\Default Work Unit\\MyTone"
}

Result:

{}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"object": {
"description": "The ID (GUID), name, or path of the object to be deleted.",
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$",
"description": "The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported."
},
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
}
},
"required": [
"object"
],
"additionalProperties": false
}


Options :

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


Response :

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

Document version : 1