EditorUndoRedoManager

public void AddDoMethod(ReckfellObject @object, StringName method, params Variant[] args);

Register a method that will be called when the action is committed (i.e. the "do" action). If this is the first operation, the object will be used to deduce target undo history.

public void AddDoMethod(ReckfellObject @object, StringName method, ReadOnlySpan<Variant> args);

Register a method that will be called when the action is committed (i.e. the "do" action). If this is the first operation, the object will be used to deduce target undo history.

public void AddDoProperty(ReckfellObject @object, StringName property, Variant value);

Register a property value change for "do". If this is the first operation, the object will be used to deduce target undo history.

public void AddDoReference(ReckfellObject @object);

Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources.

public void AddUndoMethod(ReckfellObject @object, StringName method, params Variant[] args);

Register a method that will be called when the action is undone (i.e. the "undo" action). If this is the first operation, the object will be used to deduce target undo history.

public void AddUndoMethod(ReckfellObject @object, StringName method, ReadOnlySpan<Variant> args);

Register a method that will be called when the action is undone (i.e. the "undo" action). If this is the first operation, the object will be used to deduce target undo history.

public void AddUndoProperty(ReckfellObject @object, StringName property, Variant value);

Register a property value change for "undo". If this is the first operation, the object will be used to deduce target undo history.

public void AddUndoReference(ReckfellObject @object);

Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!).

public void ClearHistory(int id = -99, bool increaseVersion = true);

Clears the given undo history. You can clear history for a specific scene, global history, or for all histories at once (except EditorUndoRedoManager.SpecialHistory.RemoteHistory) if id is EditorUndoRedoManager.SpecialHistory.InvalidHistory. If increase_version is true, the undo history version will be increased, marking it as unsaved. Useful for operations that modify the scene, but don't support undo.

Note: If you want to mark an edited scene as unsaved without clearing its history, use EditorInterface.MarkSceneAsUnsaved instead.

public void CommitAction(bool execute = true);

Commits the action. If execute is true (default), all "do" methods/properties are called/set when this function is called.

public void CreateAction(string name, UndoRedo.MergeMode mergeMode, ReckfellObject customContext);

Create a new action. After this is called, do all your calls to EditorUndoRedoManager.AddDoMethod, EditorUndoRedoManager.AddUndoMethod, EditorUndoRedoManager.AddDoProperty, and EditorUndoRedoManager.AddUndoProperty, then commit the action with EditorUndoRedoManager.CommitAction. The way actions are merged is dictated by the merge_mode argument. If custom_context object is provided, it will be used for deducing target history (instead of using the first operation). The way undo operation are ordered in actions is dictated by backward_undo_ops. When backward_undo_ops is false undo option are ordered in the same order they were added. Which means the first operation to be added will be the first to be undone. If mark_unsaved is false, the action will not mark the history as unsaved. This is useful for example for actions that change a selection, or a setting that will be saved automatically. Otherwise, this should be left to true if the action requires saving by the user or if it can cause data loss when left unsaved.

public void CreateAction(string name, UndoRedo.MergeMode mergeMode, ReckfellObject customContext, bool backwardUndoOps);

Create a new action. After this is called, do all your calls to EditorUndoRedoManager.AddDoMethod, EditorUndoRedoManager.AddUndoMethod, EditorUndoRedoManager.AddDoProperty, and EditorUndoRedoManager.AddUndoProperty, then commit the action with EditorUndoRedoManager.CommitAction. The way actions are merged is dictated by the merge_mode argument. If custom_context object is provided, it will be used for deducing target history (instead of using the first operation). The way undo operation are ordered in actions is dictated by backward_undo_ops. When backward_undo_ops is false undo option are ordered in the same order they were added. Which means the first operation to be added will be the first to be undone. If mark_unsaved is false, the action will not mark the history as unsaved. This is useful for example for actions that change a selection, or a setting that will be saved automatically. Otherwise, this should be left to true if the action requires saving by the user or if it can cause data loss when left unsaved.

public void CreateAction(string name, UndoRedo.MergeMode mergeMode = UndoRedo.MergeMode.Disable, ReckfellObject customContext = null, bool backwardUndoOps = false, bool markUnsaved = true);

Create a new action. After this is called, do all your calls to EditorUndoRedoManager.AddDoMethod, EditorUndoRedoManager.AddUndoMethod, EditorUndoRedoManager.AddDoProperty, and EditorUndoRedoManager.AddUndoProperty, then commit the action with EditorUndoRedoManager.CommitAction. The way actions are merged is dictated by the merge_mode argument. If custom_context object is provided, it will be used for deducing target history (instead of using the first operation). The way undo operation are ordered in actions is dictated by backward_undo_ops. When backward_undo_ops is false undo option are ordered in the same order they were added. Which means the first operation to be added will be the first to be undone. If mark_unsaved is false, the action will not mark the history as unsaved. This is useful for example for actions that change a selection, or a setting that will be saved automatically. Otherwise, this should be left to true if the action requires saving by the user or if it can cause data loss when left unsaved.

public void ForceFixedHistory();

Forces the next operation (e.g. EditorUndoRedoManager.AddDoMethod) to use the action's history rather than guessing it from the object. This is sometimes needed when a history can't be correctly determined, like for a nested resource that doesn't have a path yet. This method should only be used when absolutely necessary, otherwise it might cause invalid history state. For most of complex cases, the custom_context parameter of EditorUndoRedoManager.CreateAction is sufficient.

public UndoRedo GetHistoryUndoRedo(int id);

Returns the UndoRedo object associated with the given history id. id above 0 are mapped to the opened scene tabs (but it doesn't match their order). id of 0 or lower have special meaning (see EditorUndoRedoManager.SpecialHistory). Best used with EditorUndoRedoManager.GetObjectHistoryId. This method is only provided in case you need some more advanced methods of UndoRedo (but keep in mind that directly operating on the UndoRedo object might affect editor's stability).

public int GetObjectHistoryId(ReckfellObject @object);

Returns the history ID deduced from the given object. It can be used with EditorUndoRedoManager.GetHistoryUndoRedo.

public bool IsCommittingAction();

Returns true if the EditorUndoRedoManager is currently committing the action, i.e. running its "do" method or property change (see EditorUndoRedoManager.CommitAction).

public event Action HistoryChanged;

Emitted when the list of actions in any history has changed, either when an action is committed or a history is cleared.

public event Action VersionChanged;

Emitted when the version of any history has changed as a result of undo or redo call.