interface in UnityEngine
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.
CloseFor 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.
CloseInterface for receiving callbacks before serialization and after deserialization, to process datatypes that can't otherwise be serialized or deserialized.
The Unity serializer can automatically serialize most data types, but not all of them. In cases where a data type can't be serialized, you can use the serialization callbacks defined in this interface to manually process the data into a serializable form. For more information on when and why manual processing is necessary, refer to Custom serialization.
Unity invokes OnBeforeSerialize
just before an object is serialized. Inside this callback, you can transform your data into something Unity understands just before Unity serializes it. After the callback is complete, Unity serializes the arrays.
Unity invokes OnAfterDeserialize
after an object is deserialized. After Unity has written the data to your fields, use this callback to transform the deserialized data back into the form you want it to have at runtime.
Work performed in these callbacks must be done with care, as the Unity serializer runs on a different thread from most of the Unity API. It's recommended to process only fields that are directly owned by the object, to keep the processing burden as low as possible.
This interface supports serialization as reference, such as on objects decorated with the SerializeReference attribute. The order of callback execution between these objects isn't guaranteed. However, the following execution orders are guaranteed:
OnBeforeSerialize
is called on the host object before it's called on any of the host object's managed references.OnAfterDeserialize
is called on the host object before it's called on any of the host object's managed references.For a full explanation of the SerializeReference
attribute's behaviour, refer to SerializeReference. For more information on when and how Unity performs serialization, refer to Script serialization in the Manual.
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" };
// Create a Dictionary. The Unity serializer doesn't support Dictionary types. public Dictionary<int, string> myDictionary = new Dictionary<int, string>();
public void OnBeforeSerialize() { keys.Clear(); values.Clear(); // For each key/value pair in the dictionary, add the key to the keys list and the value to the values list foreach (var kvp in myDictionary) { keys.Add(kvp.Key); values.Add(kvp.Value); } }
public void OnAfterDeserialize() { myDictionary = new Dictionary<int, string>(); // Loop through the list of keys and values and add each key/value pair to the dictionary for (int i = 0; i != Math.Min(keys.Count, values.Count); i++) myDictionary.Add(keys[i], values[i]); }
void OnGUI() { // This callback displays the following output on three separate labels in the GameView: // "Key: 3 value: I" // "Key: 4 value: Love" // "Key: 5 value: Unity" foreach (var kvp in myDictionary) GUILayout.Label("Key: " + kvp.Key + " value: " + kvp.Value); } }
Additional resources: SerializeReference, SerializeField.
OnAfterDeserialize | Implement this callback to transform data back into runtime data types after an object is deserialized. |
OnBeforeSerialize | Implement this callback to transform data into serializable data types immediately before an object is serialized. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.