Version
menu_open
Wwise SDK 2022.1.12
ak.wwise.core.object.create Arguments Schema

Schema

{
"localDefinitions": {
"children": {
"type": "array",
"description": "An array of child objects to be created.",
"items": {
"type": "object",
"description": "A child objects to be created.",
"properties": {
"type": {
"type": "string",
"description": "The type of the new object. Refer to \\ref wobjects_index for possible object types."
},
"name": {
"type": "string",
"description": "The name of the new object."
},
"notes": {
"type": "string",
"description": "The notes or comments of the new object."
},
"children": {
"type": "array",
"description": "An array of child objects to be created (Recursive).\\n An array of child objects to be created.",
"items": {
"type": "object",
"description": "A child objects to be created.",
"properties": {
"type": {
"type": "string",
"description": "The type of the new object. Refer to \\ref wobjects_index for possible object types."
},
"name": {
"type": "string",
"description": "The name of the new object."
},
"notes": {
"type": "string",
"description": "The notes or comments of the new object."
},
"children": {
"$ref": "#/localDefinitions/children",
"description": "An array of child objects to be created (Recursive)."
}
},
"patternProperties": {
"^@[:_a-zA-Z0-9]+$": {
"description": "Sets the value of property \\@propertyName. Refer to \\ref wobjects_index for property names.\\n The value of a property.",
"anyOf": [
{
"type": "null",
"description": "A null value. No reference to an object."
},
{
"type": "string",
"description": "A string value."
},
{
"type": "number",
"description": "A numerical value."
},
{
"type": "boolean",
"description": "A boolean value."
}
]
}
},
"required": [
"type",
"name"
],
"additionalProperties": false
}
}
},
"patternProperties": {
"^@[:_a-zA-Z0-9]+$": {
"description": "Sets the value of property \\@propertyName. Refer to \\ref wobjects_index for property names.\\n The value of a property.",
"anyOf": [
{
"type": "null",
"description": "A null value. No reference to an object."
},
{
"type": "string",
"description": "A string value."
},
{
"type": "number",
"description": "A numerical value."
},
{
"type": "boolean",
"description": "A boolean value."
}
]
}
},
"required": [
"type",
"name"
],
"additionalProperties": false
}
}
},
"type": "object",
"properties": {
"parent": {
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture|Global):[a-zA-Z0-9_]+$",
"description": "The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792"
},
{
"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}\\}$",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"type": "string",
"pattern": "^\\\\",
"description": "A project path to a Wwise object, including the category and the work-unit. For example: \\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\New Sound SFX."
}
],
"description": "The ID (GUID), name, or path of the parent of the new object."
},
"list": {
"type": "string",
"description": "The name of the list in which to insert the object. If this argument is set, the object gets inserted in a list owned by the parent and not as a child."
},
"onNameConflict": {
"type": "string",
"description": "The action to take if \"parent\" already has a child with the same name. Default value is \"fail\". Refer to \\ref waapi_create_objects_modes for more information.",
"enum": [
"rename",
"replace",
"fail",
"merge"
]
},
"platform": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z_]+[a-zA-Z_0-9()]*$",
"description": "The name of the 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}\\}$",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
],
"description": "The ID (GUID) or unique name of the platform used when setting properties via this command. Not specifying a platform sets the value for all linked platforms."
},
"autoAddToSourceControl": {
"type": "boolean",
"description": "Determines if Wwise automatically performs an Add or Checkout source control operation for affected work units. Defaults to false."
},
"type": {
"type": "string",
"description": "The type of the new object. Refer to \\ref wobjects_index for possible object types."
},
"name": {
"type": "string",
"description": "The name of the new object."
},
"notes": {
"type": "string",
"description": "The notes or comments of the new object."
},
"children": {
"type": "array",
"description": "An array of child objects to be created.",
"items": {
"type": "object",
"description": "A child objects to be created.",
"properties": {
"type": {
"type": "string",
"description": "The type of the new object. Refer to \\ref wobjects_index for possible object types."
},
"name": {
"type": "string",
"description": "The name of the new object."
},
"notes": {
"type": "string",
"description": "The notes or comments of the new object."
},
"children": {
"$ref": "#/localDefinitions/children",
"description": "An array of child objects to be created (Recursive)."
}
},
"patternProperties": {
"^@[:_a-zA-Z0-9]+$": {
"description": "Sets the value of property \\@propertyName. Refer to \\ref wobjects_index for property names.\\n The value of a property.",
"anyOf": [
{
"type": "null",
"description": "A null value. No reference to an object."
},
{
"type": "string",
"description": "A string value."
},
{
"type": "number",
"description": "A numerical value."
},
{
"type": "boolean",
"description": "A boolean value."
}
]
}
},
"required": [
"type",
"name"
],
"additionalProperties": false
}
}
},
"patternProperties": {
"^@[:_a-zA-Z0-9]+$": {
"description": "Sets the value of property \\@propertyName. Refer to \\ref wobjects_index for property names.\\n The value of a property.",
"anyOf": [
{
"type": "null",
"description": "A null value. No reference to an object."
},
{
"type": "string",
"description": "A string value."
},
{
"type": "number",
"description": "A numerical value."
},
{
"type": "boolean",
"description": "A boolean value."
}
]
}
},
"required": [
"type",
"name",
"parent"
],
"additionalProperties": false
}

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise