Version

menu_open
Wwise SDK 2023.1.2
ak.wwise.ui.commands.register

Registers 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[...].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.
commands[...].displayName * string Defines the name displayed in the user interface.
commands[...].program string Defines the program or script to run when the command is executed. Arguments are specified in 'args'. Note that common directories variables can be used, such as ${CurrentCommandDirectory}.
commands[...].luaScript string Defines a lua script file path to run inside Wwise process when the command is executed. Arguments are specified in 'args'. Note that common directories variables can be used, such as ${CurrentCommandDirectory}.
commands[...].luaPaths array Defines an array of paths to be used to load additional lua scripts. Here is an example of a lua path 'C:/path_to_folder/?.lua'. Note that common directories variables can be used, such as ${CurrentCommandDirectory}.
Several values provided for the option.
commands[...].luaPaths [...] string A value for the option.
commands[...].luaSelectedReturn array Specifies an array of return expressions for the selected objects in Wwise. This will be available to the script in a lua table array in wa_args.selected.
Several values provided for the option.
commands[...].luaSelectedReturn [...] string A value for the option.
commands[...].startMode string Specifies how to expand variables in the arguments field in case of multiple selection in the Wwise user interface. SingleSelectionSingleProcess: only support single selection, starts 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 selected item, in parallel. Each running instance receives one selected item. Possible values:
  • SingleSelectionSingleProcess
  • MultipleSelectionSingleProcessSpaceSeparated
  • MultipleSelectionMultipleProcesses
commands[...].args string Defines the arguments. Refer to the documentation for the list of supported built-in variables. Note that in the event of a multiple selection, the variables are expanded based on the startMode field. Note that common directories variables can be used, such as ${CurrentCommandDirectory}.
commands[...].cwd string Defines the current working directory to execute the program. Note that common directories variables can be used, such as ${CurrentCommandDirectory}.
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[...].redirectOutputs boolean Defines if the standard output streams of the program (stdout + stderr) should be redirected and logged to Wwise on termination. The value is of boolean type and false by default.
commands[...].contextMenu object If present, specify how the command is added to Wwise context menus. If empty, no context menu is added.
commands[...].contextMenu.basePath string Defines a forward-separated path for the parent sub menus. If empty, the menu is inserted at the first level.
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.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[...].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.

(Required *)

Arguments Schema

See Also

Examples

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


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