Version: 5.5 (switch to 5.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ISerializationCallbackReceiver

interface in UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Interface to receive callbacks upon serialization and deserialization.

Unity's serializer is able to serialize most datatypes, but not all of them. In these cases, there are two callbacks available for you to manually process these datatypes so that Unity can serialize and deserialise them.

Care needs to be taken whilst within these callbacks, as Unity's serializer runs on a different thread to most of the Unity API. It's advisable to only process the manipulation of datatypes, keeping the processing burden as low as possible.

Serialization can occur during all kinds of operations. For example, when using Instantiate() to clone an object, Unity serializes and deserializes the original object in order to find internal references to the original object, so that it can replace them with references to the cloned object. In this situation, you can also employ the callbacks to update any internal references using types that Unity can't serialize.

Currently the callback interface only works with classes; it won't work with structs.

no example available in JavaScript
using UnityEngine;
using System;
using System.Collections.Generic;

public class SerializationCallbackScript : MonoBehaviour, ISerializationCallbackReceiver { public List<int> _keys = new List<int> { 3, 4, 5 }; public List<string> _values = new List<string> { "I", "Love", "Unity" };

//Unity doesn't know how to serialize a Dictionary public Dictionary<int,string> _myDictionary = new Dictionary<int,string>();

public void OnBeforeSerialize( ) { _keys.Clear( ); _values.Clear( );

foreach( var kvp in _myDictionary ) { _keys.Add( kvp.Key ); _values.Add( kvp.Value ); } }

public void OnAfterDeserialize( ) { _myDictionary = new Dictionary<int, string>( );

for( int i = 0; i != Math.Min( _keys.Count, _values.Count ); i++ ) _myDictionary.Add( _keys[i], _values[i] ); }

void OnGUI( ) { foreach( var kvp in _myDictionary ) GUILayout.Label( "Key: " + kvp.Key + " value: " + kvp.Value ); } }

Public Functions

OnAfterDeserializeImplement this method to receive a callback after Unity deserializes your object.
OnBeforeSerializeImplement this method to receive a callback before Unity serializes your object.