インゲームプレビュー

CRI Atom Craftは、オーサリングツール（ユーザーインターフェース）と、プレビューアー（サウンド出力）の2つのコンポーネントで構成されています。
オーサリングツール上でプレビュー再生を行うと、オーサリングツールはプレビューアーに対してTCP/IP経由でデータの送信やパラメーター設定、再生指示を行います。

オーサリングツールとプレビューアーは、切り離して動作させることも可能です。
例えば、プレビューアーをオーサリングツールとは別のターゲット機で起動させた場合、オーサリング結果を異なるマシン上でプレビューすることも可能です。

プレビューアーの機能は「モニターライブラリ」としてランタイム用にも提供されています。
アプリケーションにモニターライブラリをリンクすることで、「インゲームプレビュー」が実現できます。

ゲームに組み込んだプレビュープログラムをオーサリングツールのプレビューターゲットに指定することで、ゲーム中で再生中の効果音のパラメーターをオーサリングツールからリアルタイムに変更したり、波形データを差し替えて再生することが可能となります。

インゲームプレビュー手順

インゲームプレビューを行う場合、以下の3つのステップを踏むことになります。

• データの作成
• アプリケーション側の準備
• インゲームプレビュー実行

各手順の詳細を次ページ以降に記載します。

データの作成

インゲームプレビュー用バイナリの廃止について

Atomライブラリ Ver.2.31.00 以降では、インゲームプレビュー用バイナリ以外のバイナリファイルもインゲームプレビューに用いることが出来るようになりました 。
それに伴い、インゲームプレビュー用バイナリは CRI Atom Craft Ver.3.57.00 にて廃止されました。
過去バージョンのツールでビルドされた通常のバイナリファイルもインゲームプレビューに使用可能です。(ACB Ver.1.26.00 以降に限る)

インゲームプレビュー用設定項目

インゲームプレビュー時に参照される設定は以下の通りです。

インゲーム時のプレビューデータ更新

キューシートの設定項目です。 この設定を有効化したキューシートは、インゲームプレビュー中にデータ更新できます。

ACBの拡張領域余白サイズ

全体設定の項目です。 インゲームプレビュー時に必要となるACBの拡張領域余白サイズを指定します。
キューシートのデータ更新時、この設定値を上回ってACBのサイズが増加する場合、データ更新が出来ません。

アプリケーション側の準備

アプリケーションがリンクするライブラリ

インゲームプレビューを行う場合、ゲームは通常のAtomライブラリではなく、ツールとの通信機能を内包したAtomMonitorライブラリをリンクします。
AtomMonitorライブラリついては、「 CriAtomExMonitor API 」をご覧ください。

インゲームプレビューモジュールの実行

インゲームプレビューを開始するには criAtomEx_Initialize_WASAPI 関数呼び出し後に、
criAtomExMonitor_Initialize 関数を呼び出してモニター機能の初期化を行います。
モニター機能についての、定期実行関数は今のところありません。
初期化後、モジュールはツールからの接続待ち状態になります。

アプリケーションがロードするデータ

モニター機能はモニターライブラリ初期化後にACFファイル、ACBファイルをロードした場合に、ロード処理をフックしてCRI Atom Craft にバイナリを要求します。
また、ロード時点でCRI Atom Craft との通信が確立していない場合は、送信要求リストにつまれ、接続が確立した時点でCRI Atom Craft によりデータの更新が行われます。この時に、更新対象のACBデータを使用している音声は全て停止します。（ACFファイルの更新の場合は、全ての再生中の音声が停止します。）

インゲームプレビューモジュールの終了

インゲームプレビューを終了するには criAtomExMonitor_Finalize 関数呼び出して機能を終了します。

インゲームプレビュー実行

インゲームプレビューの開始

インゲームプレビューの通信機能はアプリケーション側がサーバー、CRI Atom Craft 側がクライアントとなっているため、以下の手順で起動、接続を行います。

1. アプリケーション内でモニター機能の初期化。
   
2. CRI Atom Craftの[F10]キーでゲーム内の通信モジュールと接続し、インゲームプレビューを開始。
   通信が確立すると、プレビューウインドウが表示されます。
   
   

接続先の設定

CRI Atom Craftの「ツール」メニューの「プロパティ」項目を選択し、プロパティウインドウを開きます。
「PC」タブを選択し、接続先PCのIPアドレスを設定します。

インゲームプレビューの終了

インゲームプレビューの終了は以下のいずれかの方法で行います。

1. アプリケーション内でモニター機能を終了する。
   
2. CRI Atom Craftの[Ctrl＋F10]キーで接続解除。もしくは、プレビューウインドウ内の接続解除ボタンをクリック。
   
   

インゲームプレビュー中のデータ更新

インゲームプレビュー対象のキューシートはプレビューウインドウに一覧表示されます。
表示されているキューシートの内容を変更すると、変更内容が部分的に送信されゲームに反映されます。これはその変更がデータサイズ変更を伴わないパラメーターの単純変更の場合に限ります。この場合は、再生中の音声は停止せず、変更がリアルタイムに反映されます。
データサイズ変更を伴う変更を行った場合は、ACBの全体更新が必要になります。このときプレビューウインドウ内の接続項目のチェックが消え、以降部分更新を含めたACBの更新処理が行われなくなります。ACBの全体更新を行うにはプレビューウインドウ内の接続項目をクリックします。全体更新中は再生中の音声は停止します。
また、現バージョンのインゲームプレビュー機能ではインゲームプレビュー中はPCによるプレビュー機能を使用することが出来ません。この機能は今後のバージョンで修正予定です。

インゲームプレビューで行えないこと

以下の変更はインゲームプレビューに対応していません。

1. ストリーム用波形の追加削除。
   
2. ストリーム用波形の編集。
   このような編集作業を行った場合、キューシートのリビルドを行い、アプリケーションが読み込む ACB/AWB ファイルを更新してください。
   

Next:デバッグログ機能