Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

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

Undo.RecordObject

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

public static method RecordObject(objectToUndo: Object, name: string): void;
public static void RecordObject(Object objectToUndo, string name);

Parameters

objectToUndo The reference to the object that you will be modifying.
name The title of the action to appear in the undo history (i.e. visible in the undo menu).

Description

Records any changes done on the object after the RecordObject function.

Almost all property changes can be recorded with this function. The transform parent, AddComponent, object destruction can not be recorded with this function, for that you should use the dedicated functions.

Internally this will create a temporary copy of the object's state and at the end of the frame Unity will diff the state and thus detect what exactly has changed. The changed properties are then recorded on the undo stack. If nothing has actually changed (Binary exact comparison is used for all properties), no undo operation will be stored on the stack.

This is an example of an editor script which allows you to change an effect radius variable. The Undo state is recorded, allowing you to revert the change using the undo system.

#pragma strict
//Name this script "EffectRadiusEditor"
@CustomEditor(EffectRadius)
public class EffectRadiusEditor extends Editor {
	public function OnSceneGUI() {
		var t: EffectRadius = (target as EffectRadius);
		EditorGUI.BeginChangeCheck();
		var areaOfEffect: float = Handles.RadiusHandle(Quaternion.identity, t.transform.position, t.areaOfEffect);
		if (EditorGUI.EndChangeCheck()) {
			Undo.RecordObject(target, "Changed Area Of Effect");
			t.areaOfEffect = areaOfEffect;
		}
	}
}
//Name this script "EffectRadiusEditor"
using UnityEngine;
using UnityEditor;

[CustomEditor(typeof(EffectRadius))] public class EffectRadiusEditor : Editor { public void OnSceneGUI() { EffectRadius t = (target as EffectRadius);

EditorGUI.BeginChangeCheck(); float areaOfEffect = Handles.RadiusHandle(Quaternion.identity, t.transform.position, t.areaOfEffect); if (EditorGUI.EndChangeCheck()) { Undo.RecordObject(target, "Changed Area Of Effect"); t.areaOfEffect = areaOfEffect; } } }

Place this script on a GameObject to see the area of effect handle, and change the value using the gizmo in the scene view.

#pragma strict
//Name this script "EffectRadius"
public class EffectRadius extends MonoBehaviour {
	public var areaOfEffect: float = 1;
}
//Name this script "EffectRadius"
using UnityEngine;
using System.Collections;

public class EffectRadius : MonoBehaviour {

public float areaOfEffect = 1;

}

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