PrefabUtility.RecordPrefabInstancePropertyModifications

Parameters

Description

Causes modifications made to the Prefab instance to be recorded.

Note that the recommended method of enabling instances of prefabs to record changes is to use SerializedProperty and SerializedObject. This enables instances to record changes and automatically includes changes in the undo system.

Call this method after making modifications to an instance of a Prefab to record those changes in the instance. If this method is not called, changes made to the instance are lost. Note that if you are not using SerializedProperty/SerializedObject, changes to the object are not recorded in the undo system whether or not this method is called.

See Also: SerializedObject SerializedProperty.

// The following Editor script looks for an existing instance of the TheCube prefab, records the property
// modification and marks the scene as dirty so that the user can save the scene afterwards and keep
// the changes.
[MenuItem("TestPrefab/ModifyAndSaveInstance")]
static void ModifyCubeInstanceAndSave()
{
    GameObject cubeInstance = GameObject.Find("TheCube01");
    Undo.RecordObject(cubeInstance.transform, "Change scale");
    cubeInstance.transform.localScale = new Vector3(2, 2, 2);

    // Notice that if the call to RecordPrefabInstancePropertyModifications is not present,
    // all changes to scale will be lost when saving the scene, and reopening the scene
    // would revert the scale back to its previous value.
    PrefabUtility.RecordPrefabInstancePropertyModifications(cubeInstance.transform);

    // Optional step in order to save the scene changes permanently.
    EditorSceneManager.SaveScene(EditorSceneManager.GetActiveScene());
}