UndoRedo

    Helper to manage undo/redo operations in the editor or custom tools.

    Helper to manage undo/redo operations in the editor or custom tools. It works by registering methods and property changes inside “actions”.

    Common behavior is to create an action, then add do/undo calls to functions or property changes, then committing the action.

    Here’s an example on how to add an action to the Godot editor’s own , from a plugin:

    , add_do_method, , add_do_property, , and commit_action should be called one after the other, like in the example. Not doing so could lead to crashes.

    If you don’t need to register a method, you can leave and add_undo_method out; the same goes for properties. You can also register more than one method/property.

    • version_changed ( )

    Called when or redo was called.

    enum MergeMode:

    • MERGE_DISABLE = 0 —- Makes “do”/“undo” operations stay in separate actions.
    • MERGE_ALL = 2 —- Makes subsequent actions with the same name be merged into one.
    • void add_do_method ( object, String method, … ) vararg
    • void add_do_property ( object, String property, value )

    Register a property value change for “do”.

    • void add_do_reference ( Object 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.

    • void add_undo_method ( object, String method, … ) vararg

    Register a method that will be called when the action is undone.

    • void add_undo_property ( object, String property, value )

    Register a property value change for “undo”.

    • void add_undo_reference ( Object 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!).

    Clear the undo/redo history and associated references.

    Passing false to increase_version will prevent the version number to be increased from this.

    • void commit_action ( )

    Commit the action. All “do” methods/properties are called/set when this function is called.

    • void create_action ( name, MergeMode merge_mode=0 )

    The way actions are merged is dictated by the argument. See for details.

    • String get_current_action_name ( ) const

    Gets the name of the current action.

    • get_version ( ) const

    Gets the version. Every time a new action is committed, the UndoRedo‘s version number is increased automatically.

    This is useful mostly to check if something changed from a saved version.

    Returns true if a “redo” action is available.

    • has_undo ( )

    Returns if an “undo” action is available.

    • bool is_commiting_action ( ) const

    Returns true if the UndoRedo is currently committing the action, i.e. running its “do” method or property change (see ).

    Redo the last action.