Version

    Other Documentation

menu_open
Wwise SDK 2022.1.11
ak.wwise.core.object.pasteProperties Arguments Schema

Schema

{
"type": "object",
"properties": {
"source": {
"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 source object."
},
"targets": {
"type": "array",
"description": "Array of target objects to paste into.",
"items": {
"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 target object."
}
},
"pasteMode": {
"type": "string",
"description": "Paste mode for lists. Default value is \"replaceEntire\". With \"replaceEntire\" all elements in the lists of a target object are removed and all selected elements from the source's lists are copied. Conversely, with \"addReplace\" and \"addKeep\" elements in a target which are not in the source are not removed. Elements in the source's list which are not in a target's list are added to the target. For elements which are common to the source and a target \"addReplace\" will copy the one from the source, replacing the target's element, whereas \"addKeep\" will retain the element in the target.",
"enum": [
"replaceEntire",
"addReplace",
"addKeep"
]
},
"inclusion": {
"type": "array",
"description": "Array of properties, references and lists to include in the paste operation. When not specified, all properties, references and lists are included, and the exclusion defines which ones to exclude",
"items": {
"type": "string",
"description": "property, reference or list name."
}
},
"exclusion": {
"type": "array",
"description": "Array of properties, references and lists to exclude from the paste operation. When not specified, no properties, references and lists are excluded.",
"items": {
"type": "string",
"description": "property, reference or list name."
}
}
},
"required": [
"source",
"targets"
],
"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