バージョン
|
Wwise SDK 2023.1.3
|
アドオンのコマンドのアレイを、登録します。登録したコマンドは、Wwiseプロセスを終了するまで、残ります。コマンド登録の詳細は、 コマンドアドオンの定義 を参照してください。また、 ak.wwise.ui.commands.executed も参照してください。
| Name | タイプ | 概要 |
|---|---|---|
| commands * | array | 登録するコマンドのデータ。 コマンドのアドオンのアレイ。 |
| commands [...] | object | コマンドのアドオンを指定します。 |
| commands[...].id * | string | コマンドに、人間が読める固有IDを定義します。IDのコンフリクトの可能性を減らすために、作者名、プロダクト名、コマンド名のコンカチネーションを利用したIDにしてください。 |
| commands[...].displayName * | string | ユーザーインターフェースに表示される名前を定義します。 |
| commands[...].program | string | コマンドを実行したときに稼働するプログラム、またはスクリプトを定義します。引数は '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. 引数は '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 | Wwiseユーザーインターフェース側で複数選択した場合に、引数フィールドの変数をどのように拡張するのかを指定します。SingleSelectionSingleProcess: 単一選択のみに対応し、プログラムを1回だけ起動します。MultipleSelectionSingleProcessSpaceSeparated: プログラムは1回だけ起動し、変数が拡張され引数がスペースで区切られ、それぞれの引数をダブルクオーテーションマークで囲みます。MultipleSelectionMultipleProcesses: プログラムは選択したアイテム毎に1回ずつ、並行して起動します。稼働中の各インスタンスが、それぞれ選択されたアイテムを1つずつ受領します。可能な値:
|
| commands[...].args | string | 引数を定義します。サポートされているビルトイン変数に関しては、ドキュメンテーションを参照してください。なお、複数選択の場合は、startModeフィールドに従い変数を拡張します。Note that common directories variables can be used, such as ${CurrentCommandDirectory}. |
| commands[...].cwd | string | プログラムを実行するための、現在のワーキングディレクトリを定義します。Note that common directories variables can be used, such as ${CurrentCommandDirectory}. |
| commands[...].defaultShortcut | string | デフォルトでこのコマンドに使うショートカットを定義します。このショートカットでコンフリクトが発生する場合は、使用されません。このショートカットは、Keyboard Shortcut Managerで変更できます。 |
| commands[...].redirectOutputs | boolean | 終了時に、プログラムの標準アウトプットストリーム（stdout + stderr) をリダイレクトして、Wwiseにログするべきかを定義します。この値はブール型で、デフォルトはfalseです。 |
| commands[...].contextMenu | object | 存在すれば、コマンドをWwiseコンテキストメニューに追加する方法を指定します。空であれば、コンテキストメニューを追加しません。 |
| commands[...].contextMenu.basePath | string | 親のサブメニュー用に、forward-separatedパスを定義します。空の場合は、メニューが最初のレベルにインサートされます。 |
| commands[...].contextMenu.visibleFor | string | このアイテムを見ることができるオブジェクトタイプの、コンマ区切りのリストを定義します。対応しているタイプのリストについては、 Wwiseオブジェクトリファレンス を参照してください。空の場合は、すべてのタイプが許容されます。 |
| commands[...].contextMenu.enabledFor | string | このアイテムを有効にしたオブジェクトタイプの、コンマ区切りのリストを定義します。対応しているタイプのリストについては、 Wwiseオブジェクトリファレンス を参照してください。空の場合は、すべてのタイプが許容されます。 |
| commands[...].mainMenu | object | 存在すれば、コマンドをWwiseメインメニューに追加する方法を指定します。空であれば、メインメニューに項目を追加しません。 |
| commands[...].mainMenu.basePath * | string | 親のサブメニュー用に、forward-separatedパスを定義します。少なくとも、トップメニューに関連付けられたレベルを1つ、定義する必要があります。 |
（必須*）
Wwise Authoring APIの詳細は、 Wwise Authoring API (WAAPI)を使用する を参照してください。