ワークフローによってはSoundBank生成の直前、または直後に実行すべきステップやタスクがあるかもしれません。例えば、特定のSoundBank生成の前にそのSoundBankファイルをソース管理システムからチェックアウトする処理や、SoundBank生成直後にストリーム用ファイルをSoundBankのディレクトリにコピーする処理などです。この情報は通常プロジェクト全体を対象に設定しますが、場合によってはこれをオーバーライドして個別のカスタム設定を行うこともあります。
Wwiseではこのような種類のタスクをコマンドラインを作成して設定します。Wwiseには、必要なコマンドラインを必要な数だけ簡単にビルドするための、専用のコマンドラインエディタがあります。処理をさらにシンプルにするために、コマンドラインで使える全てのWwise固有の変数やWindows環境変数のリストが、エディタに入っています。
![[注釈]](/images/2022.1.14_8476/?source=Help&id=note.png) | 注釈 |
|---|---|
ビルドプロセスはある外部ツールからエラーが返された場合や見つからない場合、中断されることがあります。該当するログの重大度レベル（Severity level）を、ログの設定で、Fatal Errorとすることで、これが実現されます。詳しくは「ログに表示されるメッセージの管理」を参照。 カスタム設定したGlobal opening step（グローバルなオープニングステップ）が失敗すると、ビルドプロセス全体が中断され、SoundBankは一切生成されません。一方、1つのプラットフォーム専用の、1つのカスタムステップで失敗が発生すると、そのプラットフォームだけをスキップされます。ただし、Global closing step（グローバルなクロージングステップ） は、プロセスの一部が成功しなかったため、スキップします。失敗と判断されるのは、外部プロセスが「0」以外の数値を返した時です。 |
カスタマイズしたコマンドラインを書くために使えるWwise変数を、下表に具体的に示します。
|
Command Line Variable |
内容 | |||
|---|---|---|---|---|
|
$(AllowExceedMaximum) |
SoundBankが、設定された最大サイズを超過した場合、生成するか否かを示す。 Allow SoundBanks to exceed maximumオプションを選択した場合、この変数は「true」に設定される。 | |||
|
$(GenerateContentFile) |
各SoundBankのコンテンツリストのファイルを生成するか否かを示す。コンテンツファイルには、イベント、バス、State、Switchの情報や、ストリーム用やメモリ用の全オーディオファイルのリストが含まれる。 Generate SoundBank content filesオプションを選択した場合、この変数は「true」に設定される。 | |||
|
$(GenerateHeaderFile) |
イベント、State、Switch、Game Parameterの名前をIDにマッピングしたヘッダファイルを、生成するか否かを示す。 Generate header fileオプションを選択した場合、この変数は「true」に設定される。 | |||
|
$(GenerateMaxAttenuationInfo) |
イベントの最大減衰の情報を生成するか否かを示す。 Metadata Options: Max attenuation オプションが選択されている時、この変数は「True」に設定される。 | |||
|
$(GenerateEstimatedDuration) |
イベントに推定最長ならびに最短持続時間、および持続時間タイプ情報が生成するか否かを示す。 Metadata Options: Estimated Duration オプションが選択されている時、この変数は「True」に設定される。 | |||
|
$(HeaderFileFullFilePath) |
ヘッダファイルのフルパスで、具体的には: $(HeaderFilePath)\Wwise_IDs.h | |||
|
$(HeaderFilePath) |
ヘッダファイルを保存する、パスまたは場所。 このパスは、テキストボックスHeader file pathから取得される。 | |||
|
$(InfoFilePath) |
現在のプラットフォームの、Infoファイルの完全なファイル名。 | |||
|
$(IsRunningFromCmdLine) |
Wwiseが、-generatesoundbanksフラグ付きのコマンドラインから起動されたか否かを示す。 | |||
|
$(LanguageList) |
コマンドラインにパスされたランゲージのリスト、またはSoundBank Managerで選択されたランゲージのリスト。
| |||
|
$(Platform) |
現在のプラットフォーム名。 | |||
|
$(SoundBankList) |
コマンドラインにパスされたSoundBankのリスト、またはSoundBank Managerで選択されたSoundBankのリスト。
| |||
|
|
コマンドラインにパスされたSoundBankのリスト、またはSoundBank Managerで選択されたSoundBankのリストを含むテキストファイル。長いSoundBankのリストを扱う場合に便利です。
| |||
|
$(SoundBankPath) |
現在のプラットフォームのSoundBankが保存されている、パスまたは場所。 | |||
|
$(UseSoundBankNames) |
生成されたSoundBankファイル（.bnk）の名前として、SoundBank名（true）とID（false）のどちらを使用するかを指定し、これはSoundBank内から他のSoundBankのメディアをレファレンスする時にも、適用される。 Use SoundBank namesオプションを選択した場合、この変数は「true」に設定される。 | |||
|
$(WwiseExeDriveLetter) |
Wwise実行ファイル（Wwise.exe）がある、ワークステーションのドライブレター。 | |||
|
$(WwiseExePath) |
Wwise実行ファイル (Wwise.exe）のパスまたは場所。 | |||
|
$(WwiseExeProcessID) |
Wwise実行ファイル（Wwise.exe）の処理ID（Process ID）の数値 。 | |||
|
$(WwiseProjectDriveLetter) |
Wwiseプロジェクトがある、ワークステーションのドライブレター。 | |||
|
$(WwiseProjectName) |
現在のプロジェクト名。 | |||
|
$(WwiseProjectPath) |
Wwiseプロジェクトのパスまたは場所。 | |||
|
|
WAAPIがWAMPプロトコル用に使うポート。 | |||
|
|
WAAPIがHTTPプロトコル用に使うポート。 |
| 注釈 |
|---|---|
環境変数は自動的に、$(WWISESDK) のようにマッピングされます。 |
柔軟性を高めるために、Wwiseでは以下の種類のステップに対して、異なるコマンドラインを設定できます:
Global opening step - 全プラットフォームにグローバル（全体的）に適用し、他のどのステップよりも前に実行するコマンドライン。
Platform-specific pre-generation step - 特定プラットフォームに適用し、SoundBank生成前に実行するコマンドライン。
Platform-specific post-generation step - 特定プラットフォームに適用し、SoundBank生成後に実行するコマンドライン。
Global closing step - 全プラットフォームにグローバル（全体的）に適用し、全てのステップの後に実行するコマンドライン。
ポストジェネレーション（生成後）のデフォルトのステップとして、プラットフォームごとに、ストリーミングファイルをSoundBankのディレクトリにコピーするステップが、プロジェクトに必ず入っています。なお、他にもコマンドラインを設定して、どのような種類のタスクでも自動化できます。またWwiseには、SoundBankの中の全てのデータやメディアが入ったパッケージをFile Packager（ファイルパッケージャ）機能で生成する、別のファクトリコマンドラインも同梱されています。File Packagerについてはファイルパッケージの管理を参照してください。 ファクトリコマンドラインのロードについては「ファクトリコマンドラインや、カスタムコマンドラインのロード」を参照してください。
作成したコマンドラインをファイル（.wcmdline）に保存して、後で同じプロジェクトや別のプロジェクトで使用したり、他のユーザーとシェアしたりすることもできます。コマンド保存については 「カスタムコマンドラインを、ファイルに保存」を参照してください。
プロジェクトのプリジェネレーションステップをオーバーライドするには:
SoundBank ManagerツールバーでSoundBank Settingsツールをクリックします:
ユーザによるオーバーライドがすでに設定されている場合は、ツールにオレンジの背景色が適用されます。
メニューからUser SoundBank Settingsを選択します。
SoundBanksタブでOverride Project SoundBank Settingsを選択します。
Override Project Pre-Generation Stepオプションを選択する。
Project Settingsダイアログボックスで設定したプリジェネレーションに適用するGlobal opening stepに対し、追加や変更を行うには、該当するEditボタン(...)をクリックする。
Pre-Generation Step Editorが開く。
テキストボックスDescription に、実行するステップやタスクの内容がよく分かる名前を入力する。
テキストボックスCommandsで必要に応じて、新規コマンドラインを書くか、既存コマンドラインを編集する。
注釈 テキストボックスCommandsは、一般的なテキストエディタと同じように使えるので、Enterを押してテキストに新しい行を追加し、テキストを選択してからDeleteを押して削除することなどができます。
コマンドに、組み込みマクロや環境変数をインサートしたい場合は、以下を行う:
グループボックスMacrosで、以下のオプションを1つ選択する。
Built-in Macros - 組み込みマクロのことであり、Wwiseコマンドライン内で使える、Wwise固有の変数リストを表示。
Environment Variables - 環境変数のことであり、Wwiseコマンドライン内で使える、Windows固有の環境変数リストを表示。
コマンドラインに変数を追加するには、以下のいずれかを行う:
リストの変数をダブルクリックする。
リストの変数を選択して、Insertをクリックする。
必要に応じて、コマンドラインに変数を追加する。
プリジェネレーションのステップを追加する場合は、最初の行の終わりで、Enterを押し、新しいコマンドラインを入力する。
OKをクリックして、コマンドラインを保存して、Pre-Generation Step Editorを閉じる。
注釈 コマンドラインをファイルに保存する場合は、Editorの、Save Asボタンをクリックします。カスタムコマンドラインの保存については「カスタムコマンドラインを、ファイルに保存」を参照してください。
既存のプラットフォーム別プリジェネレーションステップに、追加または変更を行うには、プラットフォームごとに上記3〜8を繰り返す。
注釈 ファクトリコマンドや保存したカスタムコマンドラインをEditorにロードするには、Loadボタンをクリックします。ファクトリコマンドやカスタムコマンドのロードについては 「ファクトリコマンドラインや、カスタムコマンドラインのロード」を参照してください。
プロジェクトのポストジェネレーションステップをオーバーライドするには:
SoundBank ManagerツールバーでSoundBank Settingsツールをクリックします:
ユーザによるオーバーライドがすでに設定されている場合は、ツールにオレンジの背景色が適用されます。
メニューからUser SoundBank Settingsを選択します。
Override Project Post-Generation Step（ポストジェネレーションステップをオーバーライド）オプションを選択する。
Project Settingsダイアログボックスで設定した既存のポストジェネレーションステップに対し、追加や変更を行うには、該当するEditボタンをクリックする。
Post-Generation Step Editorが開く。
テキストボックスDescriptionに、実行するステップやタスクの内容がよく分かる名前を入力する。
テキストボックスCommandsで必要に応じて、新規コマンドラインを書くか、既存コマンドラインを編集する。
注釈 テキストボックスCommandsは、一般的なテキストエディタと同じように使えるので、Enterを押してテキストに新しい行を追加し、テキストを選択してからDeleteを押して削除することなどができます。
コマンドに、組み込みマクロや環境変数をインサートしたい場合は、以下を行う:
グループボックスMacrosで、以下のオプションを1つ選択する。
Built-in Macros - 組み込みマクロのことであり、Wwiseコマンドライン内で使える、Wwise固有の変数リストを表示。
Environment Variables - 環境変数のことであり、Wwiseコマンドライン内で使える、Windows固有の環境変数リストを表示。
コマンドラインに変数を追加するには、以下のいずれかを行う:
リストの変数をダブルクリックする。
リストの変数を選択して、Insertをクリックする。
必要に応じて、コマンドラインに変数を追加する。
プリジェネレーションのステップを追加する場合は、最初の行の終わりで、Enterを押し、新しいコマンドラインを入力する。
OKをクリックして、コマンドラインを保存して、Post-Generation Step Editorを閉じる。
注釈 コマンドラインをファイルに保存する場合は、Editorの、Save Asボタンをクリックします。カスタムコマンドラインの保存については「カスタムコマンドラインを、ファイルに保存」を参照してください。
グローバルなクロージングステップや、プラットフォームごとのステップを追加するには、上記3〜8を繰り返す。
注釈 ファクトリコマンドや保存したカスタムコマンドラインをEditorにロードするには、Loadボタンをクリックします。ファクトリコマンドやカスタムコマンドのロードについては 「ファクトリコマンドラインや、カスタムコマンドラインのロード」を参照してください。