"description": "Data for the commands to be registered.\\n An array of command add-ons.",
"items": {
"type": "object",
"description": "Specify a command add-on.",
"properties": {
"id": {
"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."
},
"displayName": {
"type": "string",
"description": "Defines the name displayed in the user interface."
},
"program": {
"type": "string",
"description": "Defines the program or script to run when the command is executed. Arguments are specified in 'args'."
},
"startMode": {
"type": "string",
"enum": [
"SingleSelectionSingleProcess",
"MultipleSelectionSingleProcessSpaceSeparated",
"MultipleSelectionMultipleProcesses"
],
"description": "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."
},
"args": {
"type": "string",
"description": "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."
},
"cwd": {
"type": "string",
"description": "Defines the current working directory to execute the program."
},
"defaultShortcut": {
"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."
},
"redirectOutputs": {
"type": "boolean",
"description": "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."
},
"contextMenu": {
"type": "object",
"description": "If present, specify how the command is added to Wwise context menus. If empty, no context menu is added.",
"properties": {
"basePath": {
"type": "string",
"description": "Defines a forward-separated path for the parent sub menus. If empty, the menu is inserted at the first level."
},
"visibleFor": {
"type": "string",
"description": "Defines a comma-separated list of the object types for which the item is visible. Refer to \\ref wobjects_index for the list of types supported. If empty, any type is allowed."
},
"enabledFor": {
"type": "string",
"description": "Defines a comma-separated list of the object types for which the item is enabled. Refer to \\ref wobjects_index for the list of types supported. If empty, any type is allowed."
}
},
"additionalProperties": false
},
"mainMenu": {
"type": "object",
"description": "If present, specify how the command is added to Wwise main menus. If empty, no main menu entry is added.",
"properties": {
"basePath": {
"type": "string",
"description": "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": [
"basePath"
],
"additionalProperties": false
}
},
"required": [
"id",
"displayName"
],
"additionalProperties": false
}
}
},
"required": [
"commands"
],
"additionalProperties": false
}
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!