Version
-
-
-
-
Samples
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Creates an object of type 'type', as a child of 'parent'.
Graphical User Interface, Command-Line Interface.
| Name | Type | Description |
|---|---|---|
| parent * | The ID (GUID) or path of the parent of the new object. | |
| type * | string | The type of the new object. Refer to Wwise Objects Reference for possible object types. |
| name * | string | The name of the new object. |
| onNameConflict | string | The action to take if "parent" already has a child with the same name. Default value is "fail". Refer to Understanding the name conflict modes for more information. Possible values : "rename", "replace", "fail", "merge" |
| platform | string | The ID (GUID) or path of the platform used when setting properties via this command. Not specifying a platform sets the value for all linked platforms. |
| notes | string | |
| children | array | A list of child objects to be created. |
(Required *)
description : The ID (GUID) or path of the parent of the new object.
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 : ^\
type : string
description : The type of the new object. Refer to Wwise Objects Reference for possible object types.
type : string
description : The name of the new object.
type : string
description : The action to take if "parent" already has a child with the same name. Default value is "fail". Refer to Understanding the name conflict modes for more information.
Possible values : "rename", "replace", "fail", "merge"
description : The ID (GUID) or path of the platform used when setting properties via this command. Not specifying a platform sets the value for all linked platforms.
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}\}$
type : string
type : array
description : A list of child objects to be created.
argsSchema / children / ...
type : object
| Name | Type | Description |
|---|---|---|
| type * | string | The type of the new object. Refer to Wwise Objects Reference for possible object types. |
| name * | string | The name of the new object. |
| notes | string | |
| children |
(Required *)
argsSchema / children / items / ...
description : Sets the value of property @propertyName. Refer to Wwise Objects Reference for property names.
Possibilities, one of the following :
1) type : null
2) type : string
3) type : number
4) type : boolean
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the newly created Object. |
| name | string | The name of the newly created Object. |
| children | array |
description : The ID (GUID) of the newly created Object.
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}\}$
type : string
description : The name of the newly created Object.
type : array
Possible types : or object
resultSchema / children / ...
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}\}$
resultSchema / children / ...
type : string
resultSchema / children / ...
Reference : : See Arguments "children"
Create a new Sound object called 'Boom' under the specified parent.
{
"parent": "{7A12D08F-B0D9-4403-9EFA-2E6338C197C1}",
"type": "Sound",
"name": "Boom"
}
{
"id": "{66666666-7777-8888-9999-AAAAAAAAAAAA}",
"name": "Boom"
}
Create a new virtual folder called 'Guns' under the default work unit. If a folder with the same name already exists, it will automatically find a unique name.
{
"parent": "\\Actor-Mixer Hierarchy\\Default Work Unit",
"type": "Folder",
"name": "Guns",
"onNameConflict": "rename"
}
{
"id": "{66666666-7777-8888-9999-AAAAAAAAAAAA}",
"name": "Guns"
}
Create an event called 'Play_SFX' under the virtual folder 'WAAPI', with Play action on the SFX sound object.
{
"parent": "\\Events\\Default Work Unit",
"type": "Folder",
"name": "WAAPI",
"onNameConflict": "merge",
"children": [
{
"type": "Event",
"name": "Play_SFX",
"children": [
{
"name": "",
"type": "Action",
"@ActionType": 1,
"@Target": "\\Actor-Mixer Hierarchy\\Default Work Unit\\SFX"
}
]
}
]
}
{
"id": "{6114659F-9274-4031-B90E-F369568532E0}",
"name": "WAAPI",
"children": [
{
"id": "{F546017D-201A-49BD-8D4E-0A28F5DBB28D}",
"name": "Play_SFX",
"children": [
{
"id": "{400D0354-0FDB-48B4-B341-9DFA0B76078D}",
"name": ""
}
]
}
]
}
Create a Random Container called 'Boom' under the specified parent, with two Sound objects 'A' and 'B'.
{
"parent": "{7A12D08F-B0D9-4403-9EFA-2E6338C197C1}",
"type": "RandomSequenceContainer",
"name": "Boom",
"@RandomOrSequence": 1,
"children": [
{
"type": "Sound",
"name": "A"
},
{
"type": "Sound",
"name": "B"
}
]
}
{
"id": "{66666666-7777-8888-9999-AAAAAAAAAAAA}",
"name": "Boom",
"children": [
{
"id": "{46813545-2168-3547-8328-681AB678D6F5}",
"name": "A"
},
{
"id": "{68465134-2548-2377-3541-321354318ASD}",
"name": "B"
}
]
}
{
"type": "object",
"properties": {
"parent": {
"description": "The ID (GUID) or path of the parent of the new object.",
"anyOf": [
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
},
"type": {
"type": "string",
"description": "The type of the new object."
},
"name": {
"type": "string",
"description": "The name of the new object."
},
"onNameConflict": {
"type": "string",
"description": "The action to take if \"parent\" already has a child with the same name. Default value is \"fail\".",
"enum": [
"rename",
"replace",
"fail",
"merge"
]
},
"platform": {
"description": "The ID (GUID) or path of the platform used when setting properties via this command. Not specifying a platform sets the value for all linked platforms.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"notes": {
"type": "string"
},
"children": {
"type": "array",
"description": "A list of child objects to be created.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of the new object."
},
"name": {
"type": "string",
"description": "The name of the new object."
},
"notes": {
"type": "string"
},
"children": {
"$ref": "#/properties/children"
}
},
"patternProperties": {
"^@[_a-zA-Z0-9]+$": {
"description": "Sets the value of property \\@propertyName.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"required": [
"type",
"name"
],
"additionalProperties": false
}
}
},
"patternProperties": {
"^@[_a-zA-Z0-9]+$": {
"description": "Sets the value of property \\@propertyName.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"required": [
"type",
"name",
"parent"
],
"additionalProperties": false
}
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the newly created Object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the newly created Object."
},
"children": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string"
},
"children": {
"$ref": "#/properties/children"
}
}
}
]
}
}
}
Document version : 1
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise