3 - 予測

概要

ここでは、サーバー主導（Server Authoritative）のネットワークゲームでクライアントサイド予測を使用して、クライアントへ即時のフィードバックを与える方法を説明します。

この章では、予測で動くキネマティック（Kinematic）なボールをスポーンする方法を学びます。

キネマティックオブジェクト

まず、スポーンするオブジェクトのプレハブを作成しましょう。

新規で空のゲームオブジェクトを作成する
上記の名前をBallにする
上記にNetworkTransformコンポーネントを追加する
NetworkObjectが不足している警告が表示されるので、Add Network Objectを押す
Ballの子オブジェクトとして、Sphereを追加する
上記のスケールを0.2にする
上記からColliderを削除する
Ball側にSphereColliderを追加し、半径を0.1にすることでSphereと見た目を合わせる
Ballに新規スクリプトを追加し、名前をBall.csにする
上記オブジェクトをプロジェクトフォルダにドラッグし、プレハブを作成する
シーンを保存してネットワークオブジェクトをベイクし、シーンからBallを削除する

予測動作

目標は、全てのピア上でBallが同時に同様の挙動を取るようにすることです。

ここでいう「同時」とは「同じティック上で」という意味で、現実世界の時間での同時とは異なります。これを実現する方法は、以下の通りです。

サーバーは、一定の等間隔でシミュレーションを実行し、そのティックごとにFixedUpdateNetwork()を呼び出します。ティックを進める処理は、常にサーバーのみで行われます。これはUnity標準のFixedUpdate()と同じような挙動です。サーバーは各ティックで計算を終えた後、直前のティックとの状態の差分を圧縮し、ブロードキャストで送信します。
クライアントは、上記のスナップショットを定期的な間隔で受信しますが、当然サーバーより常に遅延したものになります。クライアントはスナップショットを受信すると、内部の状態をスナップショットのティックまで戻した後、すぐにそのティックからクライアントの現在ティックまでの再シミュレーションを実行します。
クライアントの現在ティックは、常にサーバーより十分な余裕をとって先行しています。ユーザーから収集した入力は、サーバーが（クライアントの現在ティックと）同じティックになる前にサーバーに到達するため、サーバー側で正しく入力が適用されることになります。

これは、いくつかの意味合いも含まれます。

クライアントは、フレームごとに何度もFixedUpdateNetwork()が実行されます。また、最新のスナップショットを受信するたびに、同一のティックのシミュレーションが何度も実行されます。ネットワーク上の状態はFixedUpdateNetwork()が呼び出される前にFusionによって直前のティックへ自動的にリセットされますが、ローカル上の状態はその限りではないので十分な注意が必要になります。
各ピアは、あらゆるオブジェクトの未来の状態（位置・速度・加速度・その他の決定論的なプロパティなど）を予測できます。他のプレイヤーの入力は予測できないため、その予測は失敗する可能性があります。
クライアントのローカルの入力は、すぐに適用されて即時のフィードバックを得られますが、状態を変更する権限があるわけではありません。ローカルの入力の適用はあくまで予測であり、最終的なスナップショットを生成するのはサーバーです。

上記を念頭に置いて、作業を進めていきましょう。Ballスクリプトを開き、MonoBehaviourをNetworkBehaviourに変更して、FixedUpdateNetwork()メソッドを追加してください。

今回のシンプルな例では、Ballは一定の速度で5秒間前進した後、自らをデスポーンします。まず以下のように、オブジェクトに単純な直線運動を追加しましょう。

using Fusion;
using UnityEngine;

public class Ball : NetworkBehaviour
{
    private const float Speed = 5f;

    public override void FixedUpdateNetwork()
    {
        transform.position += Speed * transform.forward * Runner.DeltaTime;
    }
}

これは通常のUnityのオブジェクトを移動させるコードとほぼ同じですが、タイムステップはTime.deltaTimeではなくティック間の時間に該当するRunner.DeltaTimeになっています。Unityのtransformの変更がネットワーク上で同期されているのはNetworkTransformのおかげです。NetworkTransformは、transformをネットワーク上の状態にするための便利なコンポーネントです。

現状はボールが無限に飛んでいってしまうので、設定した時間が経過した後にオブジェクトをデスポーンするコードが必要です。FusionはTickTimerというタイマー用の便利な型を提供しています。現在の残り時間を格納するかわりに終了時間のティックを格納すると、タイマーは毎ティック同期する必要がなくなり、タイマー作成時一度のみの同期で済むようになります。

TickTimerを追加するために、BallにTickTimer型の_lifeという名前のプロパティを追加し、getterとsetterの空スタブと[Networked]属性を追加します。

[Networked] private TickTimer _life { get; set; }

[Networked]属性が付いたプロパティと{get; set;}スタブは、Fusionの（自動的な）シリアライゼーションのコード生成に使用されます。必ず上記パターンに従ったコードを記述してください。

タイマーはオブジェクトをスポーンする前に設定したい所ですが、Spawned()はローカル上でオブジェクトがスポーンした直後に呼び出されるため、ネットワーク上の状態の初期化の使用には適しません。

Spawned()のかわりに、プレイヤー側から呼び出すことができるInit()メソッドを作成し、_lifeプロパティを5秒先に設定する際に使用できるようにしておきます。これにはTickTimerのCreateFromeSeconds()という静的メソッドが最適です。

private const float LifetimeSeconds = 5f;

public void Init()
{
    _life = TickTimer.CreateFromSeconds(Runner, LifetimeSeconds);
}

最後に、FixedUpdateNetwork()でタイマーが切れているかどうかを確認します。
タイマーが切れたら、ボールのデスポーン処理を行います。

if(life.Expired(Runner))
  Runner.Despawn(Object);

完全なBallクラスは以下のようになります。

using Fusion;
using UnityEngine;

public class Ball : NetworkBehaviour
{
    private const float Speed = 5f;
    private const float LifetimeSeconds = 5f;

    [Networked]
    private TickTimer _life { get; set; }

    public void Init()
    {
        _life = TickTimer.CreateFromSeconds(Runner, LifetimeSeconds);
    }

    public override void FixedUpdateNetwork()
    {
        if (_life.Expired(Runner))
            Runner.Despawn(Object);
        else
            transform.position += Speed * transform.forward * Runner.DeltaTime;
    }
}

プレハブのスポーン

ボールプレハブのスポーンは、プレイヤーアバターのスポーンと同じです。ただし、プレイヤーアバターのスポーンはネットワークのイベント（プレイヤーのセッションへの参加）が起点になるのに対して、ボールのスポーンはユーザーの入力が起点になります。

これを動かすためには、入力構造体に追加のデータが必要です。以下の三つの手順を行ってください。

入力構造体にデータを追加する
Unity側の入力からデータを収集する
プレイヤーアバターのFixedUpdateNetwork()で入力を適用する

NetworkInputDataを開き、Buttonsという名前のNetworkButtonsフィールドを追加し、マウス左ボタンを指す定数を定義します。

using Fusion;
using UnityEngine;

public struct NetworkInputData : INetworkInput
{
    public const byte MouseButton0 = 1;

    public NetworkButtons Buttons;
    public Vector3 Direction;
}

NeyworkButtons型はFusionで定義されている型で、複数のボタン入力状態の追跡に便利で、帯域幅使用量も最適化されています。

BasicSpawnerを開きOnInput()メソッドに移動し、マウス左ボタン用のチェックを追加します。素早いクリックを見逃すことのないように、マウスボタンはUpdate()でサンプリングして、入力構造体に格納した後にリセットします。

private bool _mouseButton0;

private void Update()
{
    _mouseButton0 = _mouseButton0 | Input.GetMouseButton(0);
}

void INetworkRunnerCallbacks.OnInput(NetworkRunner runner, NetworkInput input)
{
    var data = new NetworkInputData();

    if (Input.GetKey(KeyCode.W))
        data.Direction += Vector3.forward;

    if (Input.GetKey(KeyCode.S))
        data.Direction += Vector3.back;

    if (Input.GetKey(KeyCode.A))
        data.Direction += Vector3.left;

    if (Input.GetKey(KeyCode.D))
        data.Direction += Vector3.right;

    data.Buttons.Set(NetworkInputData.MouseButton0, _mouseButton0);
    _mouseButton0 = false;

    input.Set(data);
}

Playerクラスを開き、GetInput()の中でボタンの押下をチェックして、プレハブをスポーンします。プレハブは、Unityのインスペクターからアタッチされる[SerializeField]で渡されます。プレイヤーアバターの向いている方向にボールをスポーンできるようにするため、変数に記録した直前の移動方向をボールの進行方向に使用します。

[SerializeField]
private Ball _prefabBall;

private Vector3 _forward = Vector3.forward;
...
if (GetInput(out NetworkInputData data))
{
    ...
    if (data.Direction.sqrMagnitude > 0)
        _forward = data.Direction;

    if (data.Buttons.IsSet(NetworkInputData.MouseButton0))
    {
        Runner.Spawn(
            _prefabBall,
            transform.position + _forward,
            Quaternion.LookRotation(_forward),
            Object.InputAuthority
        );
    }
    ...
}
...

ボールのスポーン頻度を制限するため、スポーンごとに制限タイマーを設定します。タイマーはボタンの押下を検出した時にリセットします。

[Networked] private TickTimer _delay { get; set; }
...
if (HasStateAuthority && _delay.ExpiredOrNotRunning(Runner))
{
    if (data.Buttons.IsSet(NetworkInputData.MouseButton0))
    {
        _delay = TickTimer.CreateFromSeconds(Runner, ShootDelay);
        Runner.Spawn(
            _prefabBall,
            transform.position + _forward,
            Quaternion.LookRotation(_forward),
            Object.InputAuthority
        );
    }
}
...

NetworkObjectをスポーンできるのはStateAuthorityを持つホストのみなので、StateAuthorityのチェックが必要です。プレイヤーアバターの移動とは異なり、ボールのスポーンのクライアントサイド予測は行われません。

まだボールの初期化処理を行っていないため、Spawnの呼び出しに微調整が必要です。具体的には、先ほど定義したInit()メソッドを呼び出して、タイマーを適切に初期化しなければなりません。

Spawn()の引数には、プレハブがインスタンス化された後かつ、プレハブが同期される前に呼び出されるコールバックが提供されています。

まとめると、クラスの実装は以下のようになります。

using Fusion;
using UnityEngine;

public class Player : NetworkBehaviour
{
    private const float MoveSpeed = 5f;
    private const float ShootDelay = 0.5f;

    [SerializeField]
    private Ball _prefabBall;

    private NetworkCharacterController _cc;
    private Vector3 _forward = Vector3.forward;

    [Networked]
    private TickTimer _delay { get; set; }

    private void Awake()
    {
        _cc = GetComponent<NetworkCharacterController>();
    }

    public override void FixedUpdateNetwork()
    {
        if (GetInput(out NetworkInputData data))
        {
            data.Direction.Normalize();
            _cc.Move(MoveSpeed * data.Direction * Runner.DeltaTime);

            if (data.Direction.sqrMagnitude > 0)
                _forward = data.Direction;

            if (HasStateAuthority && _delay.ExpiredOrNotRunning(Runner))
            {
                if (data.Buttons.IsSet(NetworkInputData.MouseButton0))
                {
                    _delay = TickTimer.CreateFromSeconds(Runner, ShootDelay);
                    Runner.Spawn(
                        _prefabBall,
                        transform.position + _forward,
                        Quaternion.LookRotation(_forward),
                        Object.InputAuthority,
                        (runner, o) => { o.GetComponent<Ball>().Init(); }
                    );
                }
            }
        }
    }
}

テストを行う前に、Playerプレハブの_prefabBallにボールプレハブをアタッチしておくことを忘れないようにしましょう。プロジェクトのPlayerPrefabを選択して、Ballプレハブを_prefabBallにドラッグしてください。

次はホストモード入門 4 - 物理

概要
キネマティックオブジェクト
予測動作
プレハブのスポーン