【Unity】【Photon】List<List<〇〇>>を含むクラスのシリアル化

Question

Photonのカスタムタイプを自作しようとしています。

実現したいこと

独自のクラスをシリアル化できるようにしたい。(RoomInfoをカスタムタイプとして登録したい。)
下記のコードでは、シリアル化できない、とエラーが出る。

コード

カスタムタイプを登録するためのクラス

using System;
using System.Collections.Generic;
using ExitGames.Client.Photon;
using UnityEngine;

public class MyCustomType : MonoBehaviour
{
    private static readonly byte[] bufferBoxInfo = new byte[4];

    public static void Register()
    {
        PhotonPeer.RegisterType(typeof(RoomInfo), (byte)'R', SerializeRoomInfo, DeserializeRoomInfo);
        PhotonPeer.RegisterType(typeof(BoxInfo), (byte)'B', SerializeBoxInfo, DeserializeBoxInfo);
    }

    public static short SerializeRoomInfo(StreamBuffer outStream, object customObject)
    {
        var roomInfo = (RoomInfo) customObject;
        var boxInfosBytes = Protocol.Serialize(roomInfo.BoxInfos);
        var bufferBoxInfos = new byte[boxInfosBytes.Length];
        var index = 0;
        lock (bufferBoxInfos)
        {
            Array.Copy(boxInfosBytes, 0, bufferBoxInfos, index, boxInfosBytes.Length);
            outStream.Write(bufferBoxInfos, 0, boxInfosBytes.Length);
        }
        return (short) boxInfosBytes.Length;
    }
    
    public static object DeserializeRoomInfo(StreamBuffer inStream, short length)
    {
        var boxInfos = new List<List<BoxInfo>>();
        var bufferBoxInfos = new byte[length];
        var index = 0;
        lock (bufferBoxInfos) 
        {
            inStream.Read(bufferBoxInfos, index, length);
            boxInfos = (List<List<BoxInfo>>)Protocol.Deserialize(bufferBoxInfos);
        }
        return new RoomInfo(boxInfos);
    }
    
    public static short SerializeBoxInfo(StreamBuffer outStream, object customObject)
    {
        var boxInfo = (BoxInfo) customObject;
        lock (bufferBoxInfo)
        {
            var bytes = bufferBoxInfo;
            var off = 0;
            Protocol.Serialize(boxInfo.PlayerId, bytes, ref off);
            outStream.Write(bytes, 0, 4);
            return 4;
        }
    }
    
    public static object DeserializeBoxInfo(StreamBuffer inStream, short length)
    {
        int playerId;
        lock (bufferBoxInfo)
        {
            inStream.Read(bufferBoxInfo, 0, length);
            var off = 0;
            Protocol.Deserialize(out playerId, bufferBoxInfo, ref off);
        }
        return new BoxInfo(playerId);
    }
}

RoomInfo

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

public class RoomInfo : MonoBehaviour
{

    private List<List<BoxInfo>> boxInfos;

    public RoomInfo(List<List<BoxInfo>> boxInfos)
    {
        this.boxInfos = boxInfos;
    }
    
    public RoomInfo()
    {
        this.boxInfos = new List<List<BoxInfo>>();
    }
       
    public RoomInfo(int height, int width)
    {
        this.boxInfos = new List<List<BoxInfo>>();
        for (var y = 0; y < height; y++)
        {
            var list = new List<BoxInfo>();
            for (var x = 0; x < width; x++)
            {
                var boxInfo = new BoxInfo();
                list.Add(boxInfo);
            }
            boxInfos.Add(list);
        }
    }
      
    public List<List<BoxInfo>> BoxInfos
    {
        get
        {
            return boxInfos;
        }
        set
        {
            boxInfos = value;
        }
    }

    private BoxInfo GetBoxInfo(int x, int y)
    {
        var target = boxInfos[x][y];
        if (target == null)
        {
            Debug.Log("exception " + x + " " + y);
            throw new IndexOutOfRangeException();
        }
        return target;
    }
    public int GetBoxInfoPlayerId(int x, int y)
    {
        return GetBoxInfo(x, y).PlayerId;
    }

    public void SetBoxInfoPlayerId(int x, int y, int playerId)
    {
        GetBoxInfo(x, y).PlayerId = playerId;
    }
}

BoxInfo

using System;
//using static RoomProperty;

public class BoxInfo
{
    private int playerId { get; set; }

    public int PlayerId
    {
        get
        {
            return playerId;
        }
        set
        {
            playerId = value;
        }
    }

    public BoxInfo(int playerId)
    {
        this.playerId = playerId;
    }

     public BoxInfo()
    {
        // RoomPrepertyでNullPlayerId = -1と定義しています
        this.playerId = NullPlayerId;
    }
}

エラーメッセージ

Exception: cannot serialize(): System.Collections.Generic.List`1[System.Collections.Generic.List`1[BoxInfo]]
ExitGames.Client.Photon.Protocol16.Serialize (ExitGames.Client.Photon.StreamBuffer dout, System.Object serObject, System.Boolean setType) (at <11e9abbca912444aa80ed58a280369fc>:0)

参考

Photonでの直列化 | Photon Engine

開発環境

Unity 2018.4.19f1 Personal
PUN 2.18.1

Comments

[bboydaisuke]

「RoomInfoをカスタムタイプとして登録したい」ということは、MyCustomType 内に 2 つ出てくる Protocol.Serialize() の内、先に出てくる方でエラーになっているということでよいですか？
この辺は、コードを全部読まなくてもわかるように書いて欲しいです。

using ディレクティブを省いていますが、Protocol クラスの完全修飾名が ExitGames.Client.Photon.Protocol であることとかはきちんと覚えていないので、using ディレクティブは省かないでください。完全修飾名がわからないとリファレンスを探せないためです。エラーメッセージを見ればわかるだろうと考えているんだと思いますが、最後まで読んで戻らないといけないのは面倒です。

[melonplus]

SerializeRoomInfoでエラーが発生していると思われます。以後、気を付けたいと思います。

Answer 1

多分 JsonUtility のようなノリで値を渡すとシリアライズして返してくれることを期待してコーディングしたんだと思いますが、参考として挙げている「Photonでの直列化」というドキュメントを見るとそうじゃないみたいですよ。どうやってシリアル化するかを基本型まで自分で分解して決めていく、みたいなことが書かれています。

その証拠に該当の関数にこんなものを渡しても同じエラーになります。

using UnityEngine;
using ExitGames.Client.Photon;

[System.Serializable]
public class TestClass
{
    public float x;

    public TestClass()
    {
        this.x = 0;
    }
}

public class TestPhotonSerialize : MonoBehaviour
{
    void Start()
    {
        byte[] bArray;

        TestClass t = new TestClass();
        bArray = Protocol.Serialize(t);
    }
}

もちろん Vector2, Vector3 などを渡しても同じエラーになります。
あとは何のためにシリアライズしたいのかもう一度考えるといいと思います。Event とか RPC に使う時は Photon では object で渡せるので、自分でシリアライズする必要はなかったと思います。

Comments

[melonplus]

ルームのCustomPropertiesにRoomInfoを渡しているのですが、Objectで渡すとはどういうことでしょうか？

[bboydaisuke]

それは「Event とか RPC に使う時は」の話で、大事なのは「何のためにシリアライズしたいのか」です。それをどうしてもやらなければならないならしっかりドキュメントを読み込んで自分のカスタムクラスにシリアライズの処理を追加しなければなりません。

[melonplus]

ルーム情報の同期を行うため、ルーム情報をまとめたクラスをカスタムプロパティにセットしています。この方法では、やはりシリアル化が必要なようです。どこを探しても多次元リストをシリアル化しているものは見つかりませんでしたので、その方法についての質問に至りました。もう少し考えて見ることにします。ありがとうございました。