カスタムイベント
カスタムイベントは他のグラフのイベントを呼び出すための機能です。
ワークフロー
定義
カスタムイベントを使用するには、まずカスタムイベントを定義します。
カスタムイベントの定義データを基に、イベントの受け取りと呼び出しが行えるようになります。
定義データには受け渡すパラメータの設定も行えます。
受け取り
次に、カスタムイベントの定義を紐づけたReceive Event Component
を使用して、イベントを受け取ります。
カスタムイベントの定義にパラメータが含まれている場合は、呼び出し時に受け渡したパラメータの値を出力できます。
呼び出し
カスタムイベントを呼び出すには、Invoke Event Action
を使用します。
カスタムイベントの定義にパラメータが含まれている場合は、呼び出し時に受け渡したいパラメータの値を入力できます。
定義できるオブジェクト
Logic Controller
Logic BehaviorやLogic AssetなどのLogic Controllerを内包するオブジェクトに、直接カスタムイベントを定義できます。
また、Event Interface Assetを関連付けることでグラフオブジェクトに依存しない汎用的なイベントの受け取りができるようになります。
詳細はLogic Controllerを参照してください。
Event Interface Asset
Event Interface Assetはカスタムイベントの定義のみを設定できるアセットです。
このアセットを介して、固有のグラフオブジェクトの定義に依存しない汎用的なイベントの呼び出しが可能です。
Logic Controllerへ関連付けることでイベントの受け取りができるようになります。
詳細はEvent Interface Assetを参照してください。
使用方法
カスタムイベントの定義
Logic EditorウィンドウのEventsタブや各オブジェクトのInspectorウィンドウで設定できます。
- Event Definitionsの「+」ボタンをクリック。
- 名前を入力し、
Enterキー
で確定。
パラメータの定義
イベントを呼び出す際に受け渡すパラメータを定義します。
- パラメータリストの「+」ボタンをクリック。
- 名前を入力して
Enterキー
で確定。 - 型のドロップダウンをクリック。
- 型選択メニューから受け渡したい型を選択。
Event Interface Assetの関連付け
Logic EditorウィンドウのEventsタブや各オブジェクトのInspectorウィンドウで設定できます。
- Event Interfacesの「+」ボタンをクリック。
- メニューから関連付けたいEvent Interface Assetを選択。
また、メニューから <Create> を選択することで、Event Interface Assetを新規作成できます。
カスタムイベントの受け取り
事前に、自グラフオブジェクトにカスタムイベントを定義する必要があります。
ノード作成メニュー
- グラフ上で
Spaceキー
を押しノード作成メニューを開く。 - Scriptsタブを選択。
- 検索欄に
Receive Events
と入力。 - メニューから イベント名 (ノードの種類) を選択。
- ノード名を入力し、
Enterキー
で確定。
ドラッグ&ドロップ
- Eventsタブのカスタムイベントの定義をドラッグ&ドロップし、ノード作成メニューを開く。
- メニューから Receive Event (ノードの種類) を選択。
- ノード名を入力し、
Enterキー
で確定。
カスタムイベントの呼び出し
事前に、呼び出し可能なカスタムイベントを定義する必要があります。
ノード作成メニュー
- グラフ上で
Spaceキー
を押しノード作成メニューを開く。 - Scriptsタブを選択。
- 検索欄に
Invoke Events
と入力。 - メニューから イベント名 (ノードの種類) を選択。
- ノード名を入力し、
Enterキー
で確定。
ドラッグ&ドロップ
- Logic Editorウィンドウ右上のロックアイコンをクリックして選択オブジェクトをロックする。
- 呼び出したいオブジェクトを選択する。
- Inspectorウィンドウのカスタムイベントの定義をドラッグ&ドロップし、ノード作成メニューを開く。
- メニューから Invoke Event (ノードの種類) を選択。
- ノード名を入力し、
Enterキー
で確定。 - 必要に応じてLogic Editorウィンドウのロックを解除する。