版本

menu_open

ak.wwise.core.object.move


Moves an object to the given parent.

(Required *)

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name Type Description
object *   The ID (GUID) or path of the object to be moved.
parent *   The ID (GUID) or path of the object's new parent.
onNameConflict string The action to take if "parent" already has a child with the same name. Default value is "fail".
Possible values : "rename", "replace", "fail"


Arguments Details


object

description : The ID (GUID) or path of the object to be moved.
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 : ^\

parent

description : The ID (GUID) or path of the object's new parent.
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 : ^\

onNameConflict

type : string
description : The action to take if "parent" already has a child with the same name. Default value is "fail".
Possible values : "rename", "replace", "fail"


Result

Name Type Description
id string The ID (GUID) of the object.
name string The name of the object.
notes string The notes of the object.
type string The type of the object. Refer to Wwise Objects Reference for more information on the types available.
path string The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'
parent object The parent of the object in the hierarchy.
owner object The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.
isPlayable boolean True if the object can be played in Transport.
shortId integer The short ID of the object.
category string The category of the object. Ex: 'Actor-Mixer Hierarchy'
filePath string The path to the file containing the object. The path can be a work-unit file, or a project file.
workunit object The parent workunit containing the object. The 'id' and the 'name' will be returned.
childrenCount number The number of children for the object.
music_transitionRoot object The music transition root containing all other music transitions recursively.
music_playlistRoot object The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.
sound_originalWavFilePath string Absolute path to the original wav file. Only valid for Sound and Audio Source objects.
sound_convertedWemFilePath string Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects.
soundbank_bnkFilePath string Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects.
workunit_isDefault boolean True if the work unit is the default.
workunit_type string The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders will have the workunit:type "folder".
Possible values : "folder", "rootFile", "nestedFile"
workunit_isDirty boolean True if the work unit is dirty. A Work Unit is dirty when it is being modified, and not saved.


Result Details


id

description : The ID (GUID) 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}$

name

type : string
description : The name of the object.

notes

type : string
description : The notes of the object.

type

type : string
description : The type of the object. Refer to Wwise Objects Reference for more information on the types available.

path

type : string
description : The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'

parent

type : object

Name Type Description
id string The ID (GUID) of the object.
name string The name of the object.


description : The parent of the object in the hierarchy.

owner

type : object

Name Type Description
id string The ID (GUID) of the object.
name string The name of the object.


description : The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.

isPlayable

type : boolean
description : True if the object can be played in Transport.

shortId

type : integer
description : The short ID of the object.

category

type : string
description : The category of the object. Ex: 'Actor-Mixer Hierarchy'

filePath

type : string
description : The path to the file containing the object. The path can be a work-unit file, or a project file.

workunit

type : object

Name Type Description
id string The ID (GUID) of the object.
name string The name of the object.


description : The parent workunit containing the object. The 'id' and the 'name' will be returned.

childrenCount

type : number
description : The number of children for the object.

music_transitionRoot

type : object

Name Type Description
id string The ID (GUID) of the object.


description : The music transition root containing all other music transitions recursively.

music_playlistRoot

type : object

Name Type Description
id string The ID (GUID) of the object.


description : The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.

sound_originalWavFilePath

type : string
description : Absolute path to the original wav file. Only valid for Sound and Audio Source objects.

sound_convertedWemFilePath

type : string
description : Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects.

soundbank_bnkFilePath

type : string
description : Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects.

workunit_isDefault

type : boolean
description : True if the work unit is the default.

workunit_type

type : string
description : The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders will have the workunit:type "folder".
Possible values : "folder", "rootFile", "nestedFile"

workunit_isDirty

type : boolean
description : True if the work unit is dirty. A Work Unit is dirty when it is being modified, and not saved.


Examples :

Move an object to a new parent.

Moves object "id" and makes it a child of "parent". The object will fail if "parent" already contains a child with the same name.

Arguments:

{
    "object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
    "parent": "{66666666-7777-8888-9999-AAAAAAAAAAAA}"
}

Result:

{
    "id": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
    "name": "myObjectName", 
    "type": "Sound", 
    "path": "\\Actor-Mixer Hierarchy\\Default Work Unit\\myObjectName", 
    "shortId": 12345
}

Move an object to a parent containing a child of the same name.

Moves object "id" and makes it a child of "parent". The object will be renamed if "parent" already contains a child with the same name.

Arguments:

{
    "object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
    "parent": "{66666666-7777-8888-9999-AAAAAAAAAAAA}", 
    "onNameConflict": "rename"
}

Result:

{
    "id": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
    "name": "new_object_name", 
    "type": "Sound", 
    "path": "\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1", 
    "shortId": 456678
}


Detailed JSON Schema


Arguments :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID) or path of the object to be moved.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }, 
        "parent": {
            "description": "The ID (GUID) or path of the object's new parent.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }, 
        "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"
            ]
        }
    }, 
    "required": [
        "object", 
        "parent"
    ], 
    "additionalProperties": false
}


Options :

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


Response :

{
    "description": "The moved object.", 
    "type": "object", 
    "properties": {
        "id": {
            "description": "The ID (GUID) of the object.", 
            "type": "string", 
            "pattern": *Must be a valid GUID*
        }, 
        "name": {
            "type": "string", 
            "description": "The name of the object."
        }, 
        "notes": {
            "type": "string", 
            "description": "The notes of the object."
        }, 
        "type": {
            "type": "string", 
            "description": "The type of the object."
        }, 
        "path": {
            "type": "string", 
            "description": "The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'"
        }, 
        "parent": {
            "type": "object", 
            "properties": {
                "id": {
                    "description": "The ID (GUID) of the object.", 
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                "name": {
                    "type": "string", 
                    "description": "The name of the object."
                }
            }, 
            "description": "The parent of the object in the hierarchy."
        }, 
        "owner": {
            "type": "object", 
            "properties": {
                "id": {
                    "description": "The ID (GUID) of the object.", 
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                "name": {
                    "type": "string", 
                    "description": "The name of the object."
                }
            }, 
            "description": "The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc."
        }, 
        "isPlayable": {
            "type": "boolean", 
            "description": "True if the object can be played in Transport."
        }, 
        "shortId": {
            "type": "integer", 
            "description": "The short ID of the object."
        }, 
        "category": {
            "type": "string", 
            "description": "The category of the object. Ex: 'Actor-Mixer Hierarchy'"
        }, 
        "filePath": {
            "type": "string", 
            "description": "The path to the file containing the object. The path can be a work-unit file, or a project file."
        }, 
        "workunit": {
            "type": "object", 
            "properties": {
                "id": {
                    "description": "The ID (GUID) of the object.", 
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                "name": {
                    "type": "string", 
                    "description": "The name of the object."
                }
            }, 
            "description": "The parent workunit containing the object. The 'id' and the 'name' will be returned."
        }, 
        "childrenCount": {
            "type": "number", 
            "description": "The number of children for the object."
        }, 
        "music:transitionRoot": {
            "type": "object", 
            "properties": {
                "id": {
                    "description": "The ID (GUID) of the object.", 
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }
            }, 
            "description": "The music transition root containing all other music transitions recursively."
        }, 
        "music:playlistRoot": {
            "type": "object", 
            "properties": {
                "id": {
                    "description": "The ID (GUID) of the object.", 
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }
            }, 
            "description": "The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only."
        }, 
        "sound:originalWavFilePath": {
            "type": "string", 
            "description": "Absolute path to the original wav file. Only valid for Sound and Audio Source objects."
        }, 
        "sound:convertedWemFilePath": {
            "type": "string", 
            "description": "Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects."
        }, 
        "soundbank:bnkFilePath": {
            "type": "string", 
            "description": "Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects."
        }, 
        "workunit:isDefault": {
            "type": "boolean", 
            "description": "True if the work unit is the default."
        }, 
        "workunit:type": {
            "type": "string", 
            "description": "The type of the Work Unit. Please note that, like Work Units, physical folders have the type \"WorkUnit\". Physical folders will have the workunit:type \"folder\".", 
            "enum": [
                "folder", 
                "rootFile", 
                "nestedFile"
            ]
        }, 
        "workunit:isDirty": {
            "type": "boolean", 
            "description": "True if the work unit is dirty. A Work Unit is dirty when it is being modified, and not saved."
        }
    }, 
    "patternProperties": {
        "^@@?[_a-zA-Z][_a-zA-Z0-9]*$": {
            "description": "Specifies the property or reference value. A single @ specifies the value of the property for the associated object. A double @@ specifies the value of the property using the source of override.", 
            "anyOf": [
                {
                    "type": "string"
                }, 
                {
                    "type": "number"
                }, 
                {
                    "type": "boolean"
                }, 
                {
                    "type": "object", 
                    "properties": {
                        "id": {
                            "description": "The ID (GUID) of the object.", 
                            "type": "string", 
                            "pattern": *Must be a valid GUID*
                        }, 
                        "name": {
                            "type": "string", 
                            "description": "The name of the object."
                        }
                    }
                }
            ]
        }
    }, 
    "additionalProperties": false
}

Document version : 1


此页面对您是否有帮助?

需要技术支持?

仍有疑问?或者问题?需要更多信息?欢迎联系我们,我们可以提供帮助!

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目,我们帮您快速入门,不带任何附加条件!

开始 Wwise 之旅