ワークフローによっては、SoundBank生成の直前、または直後に実行すべき処理やタスクがあるかもしれません。例えば、特定のSoundBank生成の前に、そのSoundBankファイルをソースコントロールシステムからチェックアウトする処理や、SoundBank生成直後に、ストリーム用ファイルをSoundBankのディレクトリにコピーする処理などです。
Wwiseでこのような種類のタスクを、SoundBankのプリジェネレーション(Pre-generation / 生成前)タスク、ポストジェネレーション(Post-generation / 生成後)タスクと呼び、コマンドラインを作成して定義します。Wwiseには、必要なコマンドラインを必要な数だけ簡単にビルドするための、専用のコマンドラインエディタがあります。処理をさらにシンプルにするために、コマンドラインで使える全てのWwise固有の変数やWindows環境変数のリストが、エディタに入っています。
カスタマイズしたコマンドラインを書くために使えるWwise変数を、下表に具体的に示します。
Command Line Variable |
内容 |
|||
---|---|---|---|---|
|
SoundBankが、設定された最大サイズを超過した場合、生成するか否かを示す。 Allow SoundBanks to exceed maximum sizeオプションを選択した場合、この変数は「true」に設定される。 |
|||
|
生成されるSoundBankのコンテンツファイルの、ファイルタイプを示す。以下が、可能な値。
|
|||
|
各SoundBankのコンテンツリストのファイルを作成するか否かを示す。コンテンツファイルには、イベント、バス、State、Switchの情報や、ストリーム用やメモリ用の全オーディオファイルのリストが含まれる。 Generate SoundBank content filesオプションを選択した場合、この変数は「true」に設定される。 |
|||
|
イベント、State、Switch、Game Parameterの名前をIDにマッピングしたヘッダファイルを、生成するか否かを示す。 Generate header fileオプションを選択した場合、この変数は「true」に設定される。 |
|||
|
イベントの最大減衰の情報を生成するか否かを示す。 Metadata Options: Max attenuation オプションが選択されている時、この変数は「True」に設定される。 |
|||
|
イベントに推定最長ならびに最短持続時間、および持続時間タイプ情報が生成するか否かを示す。 Metadata Options: Estimated Duration オプションが選択されている時、この変数は「True」に設定される。 |
|||
|
ヘッダファイルのフルパスで、具体的には: $(HeaderFilePath)\Wwise_IDs.h |
|||
|
ヘッダファイルを保存する、パスまたは場所。 このパスは、テキストボックスHeader file pathから取得される。 |
|||
|
現在のプラットフォームの、Infoファイルの完全なファイル名。 |
|||
|
Wwiseが、 |
|||
|
コマンドラインにパスされたランゲージのリスト、またはSoundBank Managerで選択されたランゲージのリスト。
|
|||
|
現在のプラットフォーム名。 |
|||
|
コマンドラインにパスされたSoundBankのリスト、またはSoundBank Managerで選択されたSoundBankのリスト。
|
|||
|
現在のプラットフォームのSoundBankが保存されている、パスまたは場所。 |
|||
|
生成されたSoundBankファイル(.bnk)の名前として、SoundBank名( Use SoundBank namesオプションを選択した場合、この変数は「 |
|||
|
Wwise実行ファイル(Wwise.exe)がある、ワークステーションのドライブレター。 |
|||
|
Wwise実行ファイル (Wwise.exe)のパスまたは場所。 |
|||
|
Wwise実行ファイル(Wwise.exe)の処理ID(Process ID)の数値 。 |
|||
|
Wwiseプロジェクトがある、ワークステーションのドライブレター。 |
|||
|
現在のプロジェクト名。 |
|||
|
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については36章ファイルパッケージの管理を参照してください。 ファクトリコマンドラインのロードについては「ファクトリコマンドラインや、カスタムコマンドラインのロード」を参照してください。
作成したコマンドラインをファイル(.wcmdline)に保存して、後で同じプロジェクトや別のプロジェクトで使用したり、他のユーザーとシェアしたりすることもできます。コマンド保存については 「カスタムコマンドラインを、ファイルに保存」を参照してください。
SoundBank生成前に行うタスクを設定するには:
以下のいずれかを行い、Project Settingsダイアログボックスを開く。
Projectメニューで、Project Settingsを選択する。
[Shift]+[K]を押す。
SoundBanksタブに切り替える。
グローバル(プロジェクト共通)Pre-Generation Stepを作成するにはBrowseボタン[...]をクリックしてGlobal Opening Step Editorを開く。
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生成後に行うタスクを設定するには:
以下のいずれかを行い、Project Settingsダイアログボックスを開く。
Projectメニューで、Project Settingsを選択する。
[Shift]+[K]を押す。
SoundBanksタブに切り替える。
グループボックスPPost-Generation Stepにおいて、デフォルトでコマンドラインCopy Streamed Filesが表示される。このコマンドラインを変更したり追加コマンドを追加するには、Browseボタン[...]のいずれかをクリックする。
Post-Generation Step Editorが開く。
テキストボックスDescriptionに、実行するステップやタスクの内容がよく分かる名前を入力する。
テキストボックスCommandsの、現在のコマンドライン末尾をクリックして、 Enterを押す。新規コマンドラインの作成を開始する。
注記 | |
---|---|
テキストボックスCommandsは、一般的なテキストエディタと同じように使えるので、Enterを押してテキストに新しい行を追加し、テキストを選択してからDeleteを押して削除することなどができます。 |
コマンドに、組み込みマクロや環境変数をインサートしたい場合は、以下を行う:
グループボックスMacrosで、以下のオプションを1つ選択する。
Built-in Macros - 組み込みマクロのことであり、Wwiseコマンドライン内で使える、Wwise固有の変数リストを表示。
Environment Variables - 環境変数のことであり、Wwiseコマンドライン内で使える、Windows固有の環境変数リストを表示。
コマンドラインに変数を追加するには、以下のいずれかを行う:
リストの変数をダブルクリックする。
リストの変数を選択して、Insertをクリックする。
必要に応じて、コマンドラインに変数を追加する。
プリジェネレーションのグローバルステップを追加する場合は、最初の行の終わりで、<e0>Enter</e0>を押し、新しいコマンドラインを入力する。
OKをクリックして、コマンドラインを保存して、Post-Generation Step Editorを閉じる。
注記 | |
---|---|
コマンドラインをファイルに保存する場合は、Editorの、Save As ボタンをクリックします。カスタムコマンドラインの保存については「カスタムコマンドラインを、ファイルに保存」を参照してください。 |
グローバルなクロージングステップや、プラットフォームごとのステップを追加するには、上記3〜8を繰り返す。
注記 | |
---|---|
ファクトリコマンドや保存したカスタムコマンドラインを、Editorにロードするには、Loadボタンをクリックします。ファクトリコマンドやカスタムコマンドのロードについては 「ファクトリコマンドラインや、カスタムコマンドラインのロード」を参照してください。 |