版本
-
Wwise 帮助
-
-
-
-
-
-
Wwise SDK 2018.1.11
|
Register an array of add-on UI commands.
Graphical User Interface.
Name | Type | Description |
---|---|---|
commands * | array | Data for the commands to be registered. |
(Required *)
description : Data for the commands to be registered.
type : array
argsSchema / commands / ...
type : object
Name | Type | Description |
---|---|---|
id * | string | Defines a human readable unique ID for the command. To reduce risk of ID conflicts, please use a concatenation of the author name, the product name and the command name. |
displayName * | string | Defines the name displayed in the user interface. |
program | string | Defines the program or script to run when the command is executed. Arguments are specified in 'args'. |
startMode | string | Specifies how to expand variables in the arguments field in case of multiple selection in Wwise user interface. SingleSelectionSingleProcess: only support single selection, will start the program once. MultipleSelectionSingleProcessSpaceSeparated: program is started once with variables expanded to space separated arguments, each enclosed in double-quotes. MultipleSelectionMultipleProcesses: program is started once per item selected, in parallel. Each running instance receives one selected item. Possible values : "SingleSelectionSingleProcess", "MultipleSelectionSingleProcessSpaceSeparated", "MultipleSelectionMultipleProcesses" |
args | string | Defines the arguments. Refer to documentation for the built-in variables supported. Note that in case of multiple selection, the variables are expanded based on the startMode field. |
cwd | string | Defines the current working directory to execute the program. |
defaultShortcut | string | Defines the shortcut to use by default for this command. If the shortcut conflicts, it won't be used. This shortcut can be changed in the Keyboard Shortcut Manager. |
contextMenu | object | |
mainMenu | object |
(Required *)
argsSchema / commands / items / ...
type : string
description : Defines a human readable unique ID for the command. To reduce risk of ID conflicts, please use a concatenation of the author name, the product name and the command name.
argsSchema / commands / items / ...
type : string
description : Defines the name displayed in the user interface.
argsSchema / commands / items / ...
type : string
description : Defines the program or script to run when the command is executed. Arguments are specified in 'args'.
argsSchema / commands / items / ...
type : string
Possible values : "SingleSelectionSingleProcess", "MultipleSelectionSingleProcessSpaceSeparated", "MultipleSelectionMultipleProcesses"
description : Specifies how to expand variables in the arguments field in case of multiple selection in Wwise user interface. SingleSelectionSingleProcess: only support single selection, will start the program once. MultipleSelectionSingleProcessSpaceSeparated: program is started once with variables expanded to space separated arguments, each enclosed in double-quotes. MultipleSelectionMultipleProcesses: program is started once per item selected, in parallel. Each running instance receives one selected item.
argsSchema / commands / items / ...
type : string
description : Defines the arguments. Refer to documentation for the built-in variables supported. Note that in case of multiple selection, the variables are expanded based on the startMode field.
argsSchema / commands / items / ...
type : string
description : Defines the current working directory to execute the program.
argsSchema / commands / items / ...
type : string
description : Defines the shortcut to use by default for this command. If the shortcut conflicts, it won't be used. This shortcut can be changed in the Keyboard Shortcut Manager.
argsSchema / commands / items / ...
type : object
Name | Type | Description |
---|---|---|
basePath | string | Defines a forward-separated path for the parent sub menus. If empty, the menu is insert at first level. |
visibleFor | string | Defines a comma-separated list of the object types for which the item is visible. Refer to Wwise Objects Reference for the list of types supported. If empty, any type is allowed. |
enabledFor | string | Defines a comma-separated list of the object types for which the item is enabled. Refer to Wwise Objects Reference for the list of types supported. If empty, any type is allowed. |
argsSchema / commands / items / ...
type : object
Name | Type | Description |
---|---|---|
basePath * | string | Defines a forward-separated path for the parent sub menus. It must at least define one level, which is associated to the top menu. |
(Required *)
Registers a command that has no program. Typically used as a callback in Waapi. Simplest example.
Registering a command that's shown in a new Extra menu.
Registering a command that's shown in the contextual menu only
Document version : 1