VCI Event Creator

このツールについて

VCI Event Creator は、VirtualCast の VCI アイテムに搭載する Lua スクリプトを、 コードを一切書かずにビジュアル操作だけで作成できる Unity エディタ拡張ツールです。

RPGツクールのイベントエディタと同じような「コマンドを積み上げる」方式のインターフェースで、 「アイテムを掴んだら音を鳴らす」「ボタンを押したらアニメーションを再生する」といった動作を 直感的に組み立てることができます。

作成した設定は保存され、Unity から「スクリプト更新」ボタンを押すだけで VCI に必要な .lua ファイルが自動出力されます。

更新履歴

必要なもの

• VCToolKit プロジェクト版（Unity プロジェクト形式のもの）
• Unity 6000 以降（VCToolKit 推奨バージョンに準ずる）
• 本ツールの .unitypackage ファイル（Google Drive からダウンロード）

インストール手順

1. unitypackage のダウンロード

Google Drive（配布フォルダ） からファイルをダウンロードしてください。

2. VCToolKit プロジェクトを Unity で開く

Unity Hub から VCToolKit のプロジェクトを開いてください。 すでに開いている場合はそのままで構いません。

3. unitypackage をインポートする

1. unitypackageをインポート ダウンロードしたVciEventCreator.unitypackageをUnityにドラッグ＆ドロップする。(Projectウィンドウにドラッグ)
2. インポート確認ダイアログで「Import」を押す インポートするファイルの一覧が表示されます。すべてにチェックが入っていることを確認して、右下の Import ボタンを押してください。
   
3. コンパイル完了を待つ Unity がスクリプトのコンパイルを自動的に行います。画面下部のプログレスバーが消えたら完了です。

確認 インポート後、Unity の Project ウィンドウに Assets/VciEventCreator/ フォルダが作成されていれば成功です。

基本的な使い方

Step 1 — VCI オブジェクトを作成する

Hierarchy ウィンドウの空白部分を右クリックし、 VCI Event Creator テンプレート作成 → 空の VCI オブジェクト を選択します。

ファイル保存ダイアログが開きます。ファイル名がそのまま VCI の Title になるため、 アイテム名を入力して保存先を決めてください（日本語も使用できます）。

保存すると、Hierarchy に以下の構成が自動で生成されます。

• （VCI名） — ルートオブジェクト（VCIObject・VciEventCreator コンポーネント付き）
• SubItem — 子オブジェクト（VCISubItem・Rigidbody・Cube 付き）

Step 2 — イベントエディタを開く

Hierarchy でルートオブジェクトを選択し、Inspector に表示される 「VCI Event Editor を開く」 ボタンをクリックします。

Step 3 — イベントを作成する

左側の「イベント一覧」パネルから、対応するトリガーを選んでクリックします。 たとえば「OnUse」を選ぶと「サブアイテムをUseした時」のイベントになります。

次に、対象となるサブアイテムを Hierarchy からドラッグ＆ドロップして登録し、 そのサブアイテムの行を選択してコマンドを追加していきます。

Step 4 — コマンドを追加する

1. コマンド欄を右クリックする コマンド一覧の空き領域（既存コマンドがない場所）を右クリックすると、メニューが表示されます。 既存コマンドを右クリックした場合は、そのコマンドの直後に挿入できます。
2. 「コマンドを追加」を選ぶ メニューから「コマンドを追加」を選ぶと「コマンド追加画面」が開きます。
   
3. 実行したいコマンドを選ぶ 左側のカテゴリから絞り込んだり、右上の検索欄でキーワード検索したりして、 目的のコマンドをクリックして追加します。 詳しくは「コマンドリファレンス」を参照してください。
   
4. パラメータを設定する 追加されたコマンドをクリックすると右側にパラメータ設定パネルが開きます。 対象オブジェクトを Hierarchy からドラッグしたり、数値・テキストを入力したりして設定します。
   

Step 5 — スクリプトを更新する

コマンドの設定が完了したら、「スクリプト更新」 を実行します。 以下のどちらかから実行できます。

• Inspector — VciEventCreator コンポーネントの 「スクリプト更新」 ボタン
• VCI Event Editor ウィンドウ — ツールバーの 「スクリプト更新」 ボタン

実行すると、作業フォルダの main.lua と VCIObject の Scripts が同時に更新されます。 作業フォルダの main.lua を更新することで、VirtualCast アプリ上の VCI にスクリプトの変更が反映されます。

バックアップについて main.lua の更新時には、上書き前のファイルが自動的にバックアップとして保存されます。 バックアップは最大 10 件まで保持され、それを超えると古いものから自動削除されます。

VCI Event Editor ウィンドウの「Lua全体プレビュー」ボタンを押すと、生成される Lua コードをプレビューで確認できます。

アイテムグループについて

「アイテムグループ」とは、同じ種類のオブジェクトを複数まとめて管理する機能です。 グループには「現在選択中のインデックス」があり、「次へ進む」「前へ戻る」「ランダム」などで インデックスを動かしながら、対象オブジェクトを順番に切り替えて操作できます。
複数の弾丸オブジェクトを順番に発射、スライドショーのページ切り替え、ランダムにおみくじを引くなど。

使用例：銃の発射（弾丸を順番に1発ずつ発射する）

弾丸オブジェクト（Bullet_1〜Bullet_6）を6個用意し、掴んだ銃を使うたびに 次の弾丸を取り出して発射するしくみを作る例です。

① アイテムグループに弾丸を登録する

1. ツールバーの 「アイテムグループ」 ボタンを開き、グループを新規作成する（例：グループ名「Bullets」）。
2. グループに弾丸オブジェクト（Bullet_1〜Bullet_6）を順番にドラッグして登録する。
   登録した順に弾丸番号 1～6 になる。
   

② OnUse イベントにコマンドを登録する

銃の SubItem に OnUse トリガーのイベントを作成し、以下の2つのコマンドを順番に追加します。

1. アイテムグループのアイテムIDを選択
   対象グループ：「Bullets」／変更方法：「次へ」を選択する。
   これで発射イベントのたびに使用する弾丸番号が 1→2→3→… と進む。
   
2. オブジェクトを発射 / スポーン
   発射するオブジェクトの欄で 「アイテムグループ」→「Bullets」 を選び、
   発射元には銃口オブジェクトを指定する。
   必要に応じて発射方向や発射速度などを設定します。

変数について

変数管理では2種類の変数を扱えます。
IFでの条件分岐や、テキストへの表示などに使用できます。

タイマーについて

「タイマー」パネルでタイマーを登録しておくと、OnTimerComplete（タイマー終了時）や OnTimerReached（指定秒数到達時）のイベントを使えるようになります。 カウントダウンゲームの制限時間管理などに利用できます。

イベントトリガー一覧

「イベント」とは、「どんなきっかけで処理を実行するか」を決めるものです。 以下の種類から選択してコマンドを組み立てます。

SubItem マッチングモード（接触・Use 系）

SubItem を持つトリガーでは、各 SubItem 行のマッチング方式を選べます。

部分一致の使用例 Bullet1〜Bullet6 のいずれかに触れた時を1つのイベントでまとめて処理したい場合、 部分一致パターンに Bullet と入力します。 すると Bullet1・Bullet2・… すべてが同じイベントのトリガーとして反応します。 完全一致で6件個別に登録する手間が省け、後からオブジェクトを増やした場合も自動的に対応されます。

IF 条件分岐について

「IF（条件分岐）」コマンドは、特定の条件を満たすときだけ後続のコマンドを実行する仕組みです。 RPGツクールの「条件分岐」と同じイメージです。

IF コマンドを選択したときのパラメータ欄で 「条件を満たさないときの分岐を作成」 にチェックを入れると、 条件を満たさなかった場合の処理（ELSE ブロック）を追加できます。

「全員に適用する」オプション

Transform 系・サウンド系・エフェクト系など多くのコマンドには、 「全員に適用する」（broadcastToAll）チェックボックスがあります。

VCI ではデフォルトでは自分の画面にしか反映されないアクションがあります。 このオプションをオンにすると、コマンドを実行したプレイヤーの操作が 部屋にいる全員の画面に同期されます。

サンプルテンプレートから始める

一からセットアップするのが大変な場合は、付属のサンプルテンプレートを使うと すぐに動く VCI の雛形を配置できます。

Hierarchy の右クリックメニューから VCI Event Creator テンプレート作成 からサンプルを選んで サンプルを作成できます。
以下はテンプレートの一部です。