Table of Contents

ak.wwise.ui.commands.register

Register an array of add-on commands. Registered commands remain until the Wwise process is terminated. Refer to Defining Command Add-ons for more information about registering commands. Also refer to ak.wwise.ui.commands.executed.

Arguments

Name Type Description
commands * array Data for the commands to be registered.
An array of command add-ons.
commands[...] object Specify a command add-on.
commands[...].displayName * string Defines the name displayed in the user interface.
commands[...].contextMenu object If present, specify how the command is added to Wwise context menus. If empty, no context menu is added.
commands[...].contextMenu.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.
commands[...].contextMenu.basePath string Defines a forward-separated path for the parent sub menus. If empty, the menu is insert at first level.
commands[...].contextMenu.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.
commands[...].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.
commands[...].mainMenu object If present, specify how the command is added to Wwise main menus. If empty, no main menu entry is added.
commands[...].mainMenu.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.
commands[...].cwd string Defines the current working directory to execute the program.
commands[...].program string Defines the program or script to run when the command is executed. Arguments are specified in 'args'.
commands[...].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.
commands[...].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
commands[...].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.

(Required *)

Arguments Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about WAAPI.