Version: 2018.3 (switch to 2019.1a or 2017.4)
LanguageEnglish
  • C#

FormerlySerializedAsAttribute

class in UnityEngine.Serialization

/

Implemented in:UnityEngine.CoreModule

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

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

Suppose you have a class like this:

using UnityEngine;

public class MyClass : MonoBehaviour { public string myValue; }

And you would like to create a property to encapsulate myValue without losing any data already assigned to instances of MyClass. You can achieve that by using this attribute:

using UnityEngine;
using UnityEngine.Serialization;

public class MyClass : MonoBehaviour { [FormerlySerializedAs("myValue")] string m_MyValue; public string myValue { get { return m_MyValue; } set { m_MyValue = value; } } }

Properties

oldNameThe name of the field before the rename.

Did you find this page useful? Please give it a rating: