Multiplayer-VR-First

はじめに

Unity Japan が公開している「Netcode for GameObjectsを使ってみよう - Unityステーション」を手順通りにやってみた。

Relay サーバを使う前までの内容まとめなど。

このリポジトリの Scene/first の内容。

インストール

• Package Manager から com.unity.netcode.gameobjects を name で指定して追加
  • 今回のバージョンは1.7.1
• com.unity.netcode.adapter.utp が必要？

デモキャラの設定

• 適当なオブジェクトに移動用 Script を設定

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class PlayerMove_KB : Unity.Netcode.NetworkBehaviour
{
  private float speed = 1.0f;
  private Vector3 moveInput;

  void Update()
  {
    if(this.IsOwner){
      float x = Input.GetAxis("Horizontal");
      float z = Input.GetAxis("Vertical");
      moveInput = new Vector3(x, 0, z);
      Move();
    }
    
    // 復帰処理
    if(transform.position.y < -10)
    {
      transform.position = new Vector3(Random.Range(-5, 5), 0, Random.Range(-5, 5));
    }
  }

  private void Move()
  {
    var delta = new Vector3(moveInput.x, 0, moveInput.z);

    transform.position += delta * speed * Time.deltaTime;
  }
}

NetworkManager の追加

• Empty Object を追加し、Network Manager Component を追加
• 黄色警告マークのところから Unity Transport を選択
• 接続ポートの設定などをここで行う

オブジェクトの同期の設定

• 同期したいオブジェクト (プレイヤーなど) を Prefab 化する
• Prefab に Network Object Component を追加
• 先ほど追加した Network Manager の Player Prefab にこの Prefab を追加する
• この状態で Play し、NM の中にある Start Host をクリックすると、Player Prefab が自動で追加されるはず

Host/Client のUI追加

• Button を2つ追加する
• 下記の Script を用意する

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class NetworkUI : MonoBehaviour
{
  public void StartHost()
  {
    Unity.Netcode.NetworkManager.Singleton.StartHost();
  }

  public void StartClient()
  {
    Unity.Netcode.NetworkManager.Singleton.StartClient();
  }
}

• 適当な Empty Object (ここでは NetworkUI としておく) に Script をアタッチし、ボタンの On Click にそれぞれ割り当てる

動作確認

• いったん Build してみる
  • Windowed にしておくとやりやすい
• Editor と exe でそれぞれ走らせられる
• Host を立ち上げて Client で入って2つ出てくればOK
• 操作が分割されなかったり、移動が同期されていなかったりしても問題ない

位置の同期 (サーバ→ホスト)

• Player Prefab に Network Transform Component を追加する
• サーバ (ホスト)→クライアントの一方通行で位置情報が送信されるようになる

移動の操作権限の管理

• 移動関連のスクリプトの継承元を MonoBehaviour から Unity.Netcode.NetworkBehaviour に変更し、一部変更する

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class PlayerMove_KB : Unity.Netcode.NetworkBehaviour
{
  private float speed = 1.0f;
  private Vector3 moveInput;

  void Update()
  {
    if(this.IsOwner){
      float x = Input.GetAxis("Horizontal");
      float z = Input.GetAxis("Vertical");
      moveInput = new Vector3(x, 0, z);
      Move();
    
      // 復帰処理
      if(transform.position.y < -10)
      {
        transform.position = new Vector3(Random.Range(-5, 5), 0, Random.Range(-5, 5));
      }
    }
  }

  private void Move()
  {
    var delta = new Vector3(moveInput.x, 0, moveInput.z);

    transform.position += delta * speed * Time.deltaTime;
  }
}

• これで Host の移動に関しては同期されるようになるが、Client は動かなくなる (進めなくなる)

位置の同期 (クライアント→サーバ)

• RPCという仕組みを用いて、サーバに対して情報を送信する処理を追加する
• 移動スクリプトを以下のように書き換える

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class PlayerMove_KB : Unity.Netcode.NetworkBehaviour
{
  private float speed = 1.0f;
  private Vector3 moveInput;

  // Start is called before the first frame update
  void Start()
  {
      
  }

  // Update is called once per frame
  void Update()
  {
    if(this.IsOwner){
      float x = Input.GetAxis("Horizontal");
      float z = Input.GetAxis("Vertical");
      MoveServerRpc(x, z);
    }

    if(this.IsServer){
      Move();
    
      // 復帰処理
      if(transform.position.y < -10)
      {
        transform.position = new Vector3(Random.Range(-5, 5), 0, Random.Range(-5, 5));
      }
    }
  }

  [Unity.Netcode.ServerRpc]
  private void MoveServerRpc(float x, float z)
  {
    this.moveInput = new Vector3(x, 0, z);
  }
  private void Move()
  {
    var delta = new Vector3(moveInput.x, 0, moveInput.z);

    transform.position += delta * speed * Time.deltaTime;
  }
}

動作確認

• Host/Client で操作が分かれていること、位置が双方向に同期されることを確認する

Animator の同期

• 現在の状態だと Animator が反映されないので、同期するように設定する
• Player Prefab に Network Animator Component を追加する
• Animator には自分自身を設定しておく