Version: 2021.2
ビルトインのシリアル化
スクリプトのシリアル化に関連するエラー

カスタム製のシリアル化

シリアル化は、データ構造やオブジェクトの状態を、Unity に保存し、後で再構築できる形式に変換する自動プロセスです。(Unity のシリアル化の詳細については、スクリプトのシリアル化 に関するドキュメントを参照してください。)

Unity がサポートしていない形式のデータをシリアライズしたい場合があるかもしれません。多くの場合、最善の方法はシリアル化コールバックを使用することです。(シリアル化コールバックを使用したカスタムシリアライゼーションの詳細については、Unity のスクリプトリファレンス ISerializationCallbackReceiver を参照してください。)

シリアル化コールバックを使用すると、シリアライザーがフィールドからデータを読み取る前とフィールドへの書き込みが完了した後に通知を受けることができます。シリアル化コールバックを使用すると、ランタイムにシリアライズするのが難しいデータを、実際にシリアライズする形式にすることができます。

これを行うには、Unity がデータをシリアライズする直前に、Unity が理解できる形式に変換します。その後、Unity がデータをフィールドに書き込んだ直後に、シリアライズされた形式をランタイムにあるべき形式に戻します。

例えば、ツリーのデータ構造が必要だとします。Unity にデータ構造を直接シリアライズさせると、「null をサポートしない」という制限によってデータストリームが非常に大きくなり、多くのシステムでパフォーマンスが低下します。以下の例1がこのケースです。

例 1: Unity の直接シリアル化。パフォーマンスが低下の原因になります。


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

public class VerySlowBehaviourDoNotDoThis : MonoBehaviour {
    [Serializable]
    public class Node {
        public string interestingValue = "value";
        //The field below is what makes the serialization data become huge because
        //it introduces a 'class cycle'.
        public List<Node> children = new List<Node>();
    }
    //this gets serialized
    public Node root = new Node();
    void OnGUI() {
        Display (root);
    }
    void Display(Node node) {
        GUILayout.Label ("Value: ");
        node.interestingValue = GUILayout.TextField(node.interestingValue, GUILayout.Width(200));
        GUILayout.BeginHorizontal ();
        GUILayout.Space (20);
        GUILayout.BeginVertical ();
        foreach (var child in node.children) {
            Display (child);
        }
        if (GUILayout.Button ("Add child")) {
            node.children.Add (new Node ());
        }
        GUILayout.EndVertical ();
        GUILayout.EndHorizontal ();
    }
}

改善案として、Unity にツリーを直接シリアライズさせずに、別のフィールドを作り、ツリーを Unity に適したシリアライズした形式で保存します。以下の例 2 がこのケースです。

例 2: Unity の直接シリアル化を避け、パフォーマンスの低下を避けます。


using System.Collections.Generic;
using System;

public class BehaviourWithTree : MonoBehaviour, ISerializationCallbackReceiver {
    // Node class that is used at runtime.
    // This is internal to the BehaviourWithTree class and is not serialized.
    public class Node {
        public string interestingValue = "value";
        public List<Node> children = new List<Node>();
    }
    // Node class that we will use for serialization.
    [Serializable]
    public struct SerializableNode {
        public string interestingValue;
        public int childCount;
        public int indexOfFirstChild;
    }
    // The root node used for runtime tree representation. Not serialized.
    Node root = new Node();
    // This is the field we give Unity to serialize.
    public List<SerializableNode> serializedNodes;
    public void OnBeforeSerialize() {
        // Unity is about to read the serializedNodes field's contents.
        // The correct data must now be written into that field "just in time".
        if (serializedNodes == null) serializedNodes = new List<SerializableNode>();
        if (root == null) root = new Node ();
        serializedNodes.Clear();
        AddNodeToSerializedNodes(root);
        // Now Unity is free to serialize this field, and we should get back the expected 
        // data when it is deserialized later.
    }
    void AddNodeToSerializedNodes(Node n) {
        var serializedNode = new SerializableNode () {
            interestingValue = n.interestingValue,
            childCount = n.children.Count,
            indexOfFirstChild = serializedNodes.Count+1
        }
        ;
        serializedNodes.Add (serializedNode);
        foreach (var child in n.children) {
            AddNodeToSerializedNodes (child);
        }
    }
    public void OnAfterDeserialize() {
        //Unity has just written new data into the serializedNodes field.
        //let's populate our actual runtime data with those new values.
        if (serializedNodes.Count > 0) {
            ReadNodeFromSerializedNodes (0, out root);
        } else
        root = new Node ();
    }
    int ReadNodeFromSerializedNodes(int index, out Node node) {
        var serializedNode = serializedNodes [index];
        // Transfer the deserialized data into the internal Node class
        Node newNode = new Node() {
            interestingValue = serializedNode.interestingValue,
            children = new List<Node> ()
        }
        ;
        // The tree needs to be read in depth-first, since that's how we wrote it out.
        for (int i = 0; i != serializedNode.childCount; i++) {
            Node childNode;
            index = ReadNodeFromSerializedNodes (++index, out childNode);
            newNode.children.Add (childNode);
        }
        node = newNode;
        return index;
    }
    // This OnGUI draws out the node tree in the Game View, with buttons to add new nodes as children.
    void OnGUI() {
        if (root != null) {
            Display (root);
        }
    }
    void Display(Node node) {
        GUILayout.Label ("Value: ");
        // Allow modification of the node's "interesting value".
        node.interestingValue = GUILayout.TextField(node.interestingValue, GUILayout.Width(200));
        GUILayout.BeginHorizontal ();
        GUILayout.Space (20);
        GUILayout.BeginVertical ();
        foreach (var child in node.children) {
            Display (child);
        }
        if (GUILayout.Button ("Add child")) {
            node.children.Add (new Node ());
        }
        GUILayout.EndVertical ();
        GUILayout.EndHorizontal ();
    }
}




• 2017–05–15 Page published

ビルトインのシリアル化
スクリプトのシリアル化に関連するエラー