Unity - Scripting API: FormerlySerializedAsAttribute

class in UnityEngine.Serialization

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.

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.

Your name Your email Suggestion*

Cancel

Description

Use this attribute to rename a field without losing its serialized value.

This is an Editor-only attribute and can't be used at runtime. For example, if you have a class like this:

using UnityEngine;public class MyMonster : MonoBehaviour
{
    public int hitpoints;
}

And you would now like to rename this field. You can achieve that by using this attribute:

using UnityEngine;
using UnityEngine.Serialization;public class MyMonster : MonoBehaviour
{
    [FormerlySerializedAs("hitpoints")]
    public int health;
}

Unity serializes public variables by default. To serialize private variables, use the SerializeField attribute. For more information, see the Script Serialization documentation.

Properties

Property	Description
oldName	The name of the field before the rename.