イベントとコールバック

• イントロ
• フレームイベント
  • DSL構造
  • キーワード
    • Synced
    • Nothashed
    • ローカル、リモート
    • クライアント、サーバー
  • イベントの使用
    • イベントをトリガー
    • イベントデータの選択
    • Unityでのイベントサブスクリプション
    • イベントからサブスクライブを解除
    • CSharpでのイベントサブスクリプション
    • キャンセルされ、確認されたイベント
  • イベント実装を拡張
• コールバック
  • MonoBehaviour
  • 純粋なCSharp
• エンティティをインスタンス化する順序

イントロ

シミュレーション（Quantum）とビュー（Unity）を分けることで、ゲームステートとビジュアルの開発時にモジュール性を高めることができます。ただし、ビューは自身を更新するためにゲーム状態からの情報を必要とします。Quantumはそのために2つの方法を提供します。

• ゲームステートのポーリング
• イベント/コールバック

どちらも有効なアプローチではありますが、ユースケースは若干異なります。一般的に、UnityからのQuantum情報をポーリングすることは、継続的なビジュアルに適しています。一方、イベントは、ゲームシミュレーションがビューに反応をトリガーするような時間が重要な場合に使用されます。このドキュメントでは、フレームイベントとコールバックに焦点を当てます。

トップに戻る
 

フレームイベント

イベントは、シミュレーションからビューに情報を転送するためのファイア・アンド・フォゲットメカニズムです。ゲームステートの変更や更新に使ってはいけません（その用途にはSignalsを使用します）。イベントには予測やロールバックの際にイベントを管理するのに役立つ、理解すべきいくつかの重要な側面があります。

• イベントはクライアント間で同期を取らず、各クライアント自身のシミュレーションによって発生します。
• 同じFrameを複数回シミュレーションすることができるため（予測、ロールバック）、イベントが複数回トリガーされる可能性があります。重複するイベントを避けるために、Quantum はイベントデータ、イベント ID、tick に対してハッシュコード関数を使用して重複を識別します。詳しくは nothashed キーワードを参照してください。
• 通常のイベント（非同期イベント）は、イベントが発生した予測フレームが検証されると、キャンセルされるかまたは確認されます。詳しくは Canceled And Confirmed Events を参照してください。
• イベントは、すべてのFrameがシミュレートされた後、OnUpdateViewコールバックの直後にディスパッチされます。イベントは、起動された順番に呼び出されます。ただし、syncedされていないイベントは例外で、重複していると判断されるとスキップされます。このタイミングにより、対象となるEntityViewはすでに破壊されている可能性があります。

もっとも単純なEventとその使用は、以下のとおりです:

• Quantum DSLを使用してEventを定義

    event MyEvent {
    int Foo;
  }

• シミュレーションからEventをトリガー

    f.Events.MyEvent(2022);

• そしてUnityでイベントを購読して消費し、イベント用のクラスを生成します。接頭辞はEventとなります。

    QuantumEvent.Subscribe(listener: this, handler: (EventMyEvent e) => Debug.Log($"MyEvent {e.Foo}"));

トップに戻る
 

DSL構造

イベントとそのデータはqtnファイル内のQuantum DSLを使用して定義されます。プロジェクトをコンパイルし、シミュレーション内のFrame.EventsAPIによって、イベントとそのデータを使用できるようにします。

event MyEvent {
  FPVector3 Position;
  FPVector3 Direction;
  FP Length
}

クラス継承は、ベースイベントのクラスとメンバーの共有を許可します。

event MyBaseEvent {}
event SpecializedEventFoo : MyBaseEvent {}
event SpecializedEventBar : MyBaseEvent {}

抽象クラスを使用し、ベースイベントが直接トリガーされるのを防止します。

abstract event MyBaseEvent {}
event MyConcreteEvent : MyBaseEvent {}

DSLが生成した構造をEvent内で再利用します。

struct FooEventData {
  FP Bar;
  FP Par;
  FP Rap;
}

event FooEvent {
  FooEventData EventData;
}

トップに戻る
 

キーワード

• Synced
• Nothashed
• ローカル、リモート
• クライアント、サーバー

Synced

ロールバックによる誤検出を避けるために、イベントにはsyncedキーワードを付けることができます。これは、Frameの入力がサーバーによって確認されたときにのみ、イベントが（Unityに）ディスパッチされることを保証します。

Syncedイベントは、シミュレーションで発行された時（予測されたFrameの間）からビューに表示されるまでの間に遅延を追加し、プレイヤーに通知するために使用することができます。

synced event MyEvent {}

• Syncedイベントは、偽陽性や偽陰性を作成しません。 Syncedされないイベントは、Unity上で2回呼び出されることはありません。

トップに戻る
Back To "キーワード"
 

Nothashed

以前の予測されたフレームでビューによってすでに消費されたイベントが再びディスパッチされるのを防ぐために、ハッシュコードが各Eventインスタンスのために計算されます。Eventをディスパッチする前に、イベントが重複しているかどうかを確認するためにハッシュコードが使用されます。

これにより、以下のような状況が発生する可能性があります。最小のロールバックによって引き起こされた1つのイベントの位置変更が、2つの異なるイベントとして誤って解釈されます。

nothashedキーワードを使用すると、Eventデータの一部を無視して、Eventの一意性をテストするためにどのキー候補データを使用するかを管理できます。

abstract event MyEvent {
  nothashed FPVector2 Position;
  Int32 Foo;
}

トップに戻る
Back To "キーワード"
 

ローカル、リモート

イベントにplayer_refメンバーがある場合、特別なキーワードを使用することができます:remoteとlocalです。

このキーワードは、Unity でイベントがディスパッチされる前に、player_ref がlocalまたはremoteのプレイヤーに割り当てられているかどうかをチェックします。すべての条件が一致した場合、このクライアントでイベントがディスパッチされます。

event LocalPlayerOnly {
  local player_ref player;
}

event RemotePlayerOnly {
  remote player_ref player;
}

まとめると、シミュレーション自体はremoteやlocalという概念にとらわれません。キーワードは、特定のイベントが各クライアントのビューで発生した場合にのみ変化します。

イベントに複数のplayer_refパラメータがある場合、localとremoteを組み合わせることができます。このイベントはLocalPlayerをコントロールするクライアントと、RemotePlayerが別のプレイヤーにアサインされたときのみ発生します。

event MyEvent {
  local player_ref LocalPlayer;
  remote player_ref RemotePlayer;
  player_ref AnyPlayer;
}

クライアントが複数のプレイヤーを管理している場合（例：split-screen）、プレイヤーのplayer_refはすべてローカルとみなされます。

トップに戻る
Back To "キーワード"
 

クライアント、サーバー

Quantum 2.1以降

イベントは、clientとserverキーワードを使用して、実行場所を指定することができます。デフォルトでは、すべてのイベントはクライアントとサーバーでディスパッチされます。

server synced event MyServerEvent {}

client event MyClientEvent {}

トップに戻る
 

イベントの使用

• イベントをトリガー
• イベントデータの選択
• Unityでのイベントサブスクリプション
• イベントからサブスクライブを解除
• CSharpでのイベントサブスクリプション
• キャンセルされ、確認されたイベント

イベントをトリガー

イベントのタイプとシグネチャはFrame.FrameEvents構造にコード生成され、Frame.Eventsからアクセスできます。

public override void Update(Frame f) {
  f.Events.MyEvent(2022);
}

トップに戻る
Back To "イベントの使用"
 

イベントデータの選択

理想的には、Eventデータは自己完結し、サブスクライバがビュー上で処理するために必要な情報を運ぶべきです。

シミュレーションでEventが発生したFrameは、Eventが実際にビュー上で呼び出されたときに、すでに利用できない可能性があります。つまり、Eventの処理に必要なFrameから取得する情報が失われる可能性があります。

EventのQCollectionやQListは、実際にはFrameのヒープ上のメモリにPtrとして渡されるだけです。バッファがもう利用できないため、ポインタの解決が失敗する可能性があります。同じことが EntityRefs にも当てはまります。Eventがディスパッチされた時点で最新のFrameからComponent にアクセスする場合には、Eventが最初に呼び出された時点とデータが同一ではない可能性があります。

イベントデータをarrayやListでリッチ化する方法は以下のとおりです：

• コレクションデータのペイロードが既知で、かつ妥当な最大サイズである場合、fixed arrayを構造の中にラップしてEventに追加することができます。QCollectionsとは異なり、配列はデータをFrameヒープに保存せず、値自体に担わせます。

struct FooEventData {
  array<FP>[4] ArrayOfValues;
}
event FooEvent {
  FooEventData EventData;
}

• 現時点では、DSLでは通常のC#の List<T>型を含むEventを宣言することはできません。しかし、Eventは部分クラスを使って拡張することができます。詳しくはイベント実装の拡張 セクションを参照してください。

トップに戻る
Back To "イベントの使用"
 

Unityでのイベントサブスクリプション

Quantumは、QuantumEventによるUnityでの柔軟なEventサブスクリプションAPIをサポートしています。

QuantumEvent.Subscribe(listener: this, handler: (EventPlayerHit e) => Debug.Log($"Player hit in Frame {e.Tick}"));

上記の例では、リスナーは単純に現在のMonoBehaviourで、ハンドラーは無名関数です。別の方法として、デリゲート関数を渡すこともできます。

QuantumEvent.Subscribe<EventPlayerHit>(listener: this, handler: OnEventPlayerHit);

private void OnEventPlayerHit(EventPlayerHit e){
  Debug.Log($"Player hit in Frame {e.Tick}");
}

QuantumEvent.Subscribeは複数の任意のQoL引数を提供し、様々な方法でサブスクリプションを適格化しています。

// only invoked once, then removed
QuantumEvent.Subscribe(this, (EventPlayerHit e) => {}, once: true);

// not invoked if the listener is not active
// and enabled (Behaviour.isActiveAndEnabled or GameObject.activeInHierarchy is checked)
QuantumEvent.Subscribe(this, (EventPlayerHit e) => {}, onlyIfActiveAndEnabled: true);

// only called for runner with specified id
QuantumEvent.Subscribe(this, (EventPlayerHit e) => {}, runnerId: "SomeRunnerId");

// only called for a specific
QuantumEvent.Subscribe(this, (EventPlayerHit e) => {}, runner: runnerReference);

// custom filter, invoked only if player 4 is local
QuantumEvent.Subscribe(this, (EventPlayerHit e) => {}, filter: (QuantumGame game) => game.PlayerIsLocal(4));

// only for replays
QuantumEvent.Subscribe(this, (EventPlayerHit e) => {}, gameMode: DeterministicGameMode.Replay);

// not for replays (Quantum SDK v2.0)
QuantumEvent.Subscribe(this, (EventPlayerHit e) => {}, excludeGameMode: DeterministicGameMode.Replay);

// for all types except replays (Quantum SDK 2.1+)
QuantumEvent.Subscribe(this, (EventPlayerHit e) => {}, gameMode: DeterministicGameMode.Replay, exclude: true);
//=> The gameMode parameter accepts and array of DeterministicGameMode

トップに戻る
Back To "イベントの使用"
 

イベントからサブスクライブを解除

UnityはMonoBehavioursのライフタイムを管理し、リスナーは自動的にクリーンアップされるため登録解除する必要はありません。

より強力な管理が必要な場合、サブスクライブ解除は手動で処理できます。

var subscription = QuantumEvent.Subscribe();

// cancels this specific subscription
QuantumEvent.Unsubscribe(subscription);

// cancels all subscriptions for this listener
QuantumEvent.UnsubscribeListener(this);

// cancels all listeners to EventPlayerHit for this listener
QuantumEvent.UnsubscribeListener<EventPlayerHit>(this);

トップに戻る
Back To "イベントの使用"
 

CSharpでのイベントサブスクリプション

EventがMonoBehaviourの外部でサブスクライブされた場合には、サブスクリプションを手動で処理する必要があります。

var disposable = QuantumEvent.SubscribeManual((EventPlayerHit e) => {}); // subscribes to the event
// ...
disposable.Dispose(); // disposes the event subscription

トップに戻る
Back To "イベントの使用"
 

キャンセルされ、確認されたイベント

syncedされていないイベントは、検証されたフレームがシミュレーションされるとキャンセルされるか確認されます。Quantum はそれらに対応するため、CallbackEventCanceledおよびCallbackEventConfirmedというコールバックを提供します。

QuantumCallback.Subscribe(this, (Quantum.CallbackEventCanceled c) => Debug.Log($"Cancelled event {c.EventKey}"));
QuantumCallback.Subscribe(this, (Quantum.CallbackEventConfirmed c) => Debug.Log($"Confirmed event {c.EventKey}"));

EventインスタンスはEventKey構造によって識別されます。たとえば、このようにEventKeyを作成することで、以前受信したEventをディクショナリに追加できます。

public void OnEvent(MyEvent e) {
  EventKey eventKey = (EventKey)e;
  // ...
}

トップに戻る
 

イベント実装を拡張

EventはQListの使用をサポートしていますが、リストを解決する際、対応するFrameはもう利用できないかもしれません。追加のデータ型は、部分的なクラス宣言を使用して追加することができます。

event ListEvent {
  Int32 Foo;
}

public partial class EventListEvent {
  public List<Int32> ListOfFoo;
}

カスタマイズされたEventをFrame.Event APIで発生できるようにするには、FrameEvents構造を拡張します。

 f.Events.TestListEvent(f, 1, new List<FP>() {2, 3, 4});.

namespace Quantum {
  public partial class Frame {
    public partial struct FrameEvents {
      public EventListEvent ListEvent(Frame f, Int32 foo, List<Int32> listOfFoo) {
        var ev = f.Events.ListEvent(foo);
        ev.ListOfFoo = listOfFoo;
        return ev;
      }
    }
  }
}

トップに戻る
 

コールバック

コールバックはQuantum Coreによって内部的にトリガーされる、特別な種類のイベントです。ユーザーが利用できるコールバックは以下です：

トップに戻る
 

MonoBehaviour

コールバックは、前述のFrame Eventと同様にサブスクライブ/サブスクライブ解除されます。ただし、QuantumEventではなくQuantumCallbackでおこないます。

var subscription = QuantumCallback.Subscribe(...);
QuantumCallback.Unsubscribe(subscription); // cancels this specific subscription
QuantumCallback.UnsubscribeListener(this); // cancels all subscriptions for this listener
QuantumCallback.UnsubscribeListener<CallbackPollInput>(this); // cancels all listeners to CallbackPollInput for this listener

Unityはオブジェクトのライフタイムを管理します。このため、Quantumはリスナーの生死を判定できます。「死んだ」リスナーは、LateUpdateや特定のイベントタイプのイベントを呼び出すたびに削除されます。

たとえば、PollInputをサブスクライブしプレイヤーの入力をセットアップするには、以下の手順が必要です：

public class LocalInput : MonoBehaviour
{
    private void Start() {
        QuantumCallback.Subscribe<CallbackPollInput>(this, PollInput);
    }

    private void PollInput(CallbackPollInput pollInput) {
    Input i = new Input();
    // add input values
        pollInput.SetInput(i, DeterministicInputFlags.Repeatable);
    }
}

トップに戻る
 

純粋なCSharp

コールバックがMonoBehaviourの外部でサブスクライブされた場合、サブスクリプションを手動で処理する必要があります。

var disposable = QuantumCallback.SubscribeManual((CallbackPollInput pollInput) => {}); // subscribes to the callback
// ...
disposable.Dispose(); // disposes the callback subscription

トップに戻る
 

エンティティをインスタンス化する順序

Frame.Create()を使用してエンティティを作成し、またFrameシミュレーションが完了している場合には、以下のコールバックが順番に実行されます：

1. OnUpdateView、新たに作成されたエンティティのビューがインスタンス化されます。
2. Monobehaviour.Awake
3. Monobehaviour.OnEnabled
4. EntityView.OnEntityInstantiated
5. Frame.Eventsが呼び出されます。

EventおよびCallbackサブスクリプションは、Monobehaviour.OnEnabledまたはEntityView.OnEntityInstantiatedでおこなわれます。

• MonoBehaviour.OnEnabled、ここでのコードでイベントにサブスクライブすることができます。ただし、EntityViewのEntityRefとAsset GUIDはまだ設定されていません。
• EntityView.OnEntityInstantiatedは、EntityViewコンポーネントのUnityEvent部分です。これは、エディター内のメニューでサブスライブできます。OnEntityInstantiatedが呼び出されると、EntityRefとEntityViewのAsset GUIDは設定されることが保証されます。イベントサブスクリプションまたはカスタムロジックがこれらのパラメータのいずれかを必要とすると、この時点で実行される必要があります。

イベントまたはコールバックからサブスクライブ解除するには、補足機能を使用します：

• OnEnabledで作成されたすべてのサブスクリプションについて、OnDisabled でサブスクライブ解除します。
• OnEntityInstantiatedで作成されたすべてのサブスクリプションについて、OnEntityDestroyedでサブスクライブ解除します。
  

ドキュメントのトップへ戻る