diff options
Diffstat (limited to 'doc/classes/UndoRedo.xml')
| -rw-r--r-- | doc/classes/UndoRedo.xml | 52 |
1 files changed, 37 insertions, 15 deletions
diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index c0b73cd8e3..7834719af6 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="UndoRedo" inherits="Object" category="Core" version="3.2"> <brief_description> - Helper to manage UndoRedo in the editor or custom tools. + Helper to manage undo/redo operations in the editor or custom tools. </brief_description> <description> - Helper to manage UndoRedo in the editor or custom tools. It works by registering methods and property changes inside 'actions'. + 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 Godot editor's own 'undoredo': + Here's an example on how to add an action to the Godot editor's own [UndoRedo], from a plugin: [codeblock] var undo_redo = get_undo_redo() # Method of EditorPlugin. @@ -26,7 +26,7 @@ undo_redo.commit_action() [/codeblock] [method create_action], [method add_do_method], [method add_undo_method], [method add_do_property], [method add_undo_property], and [method 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 [method add_do_method] and [method add_undo_method] out, and so it goes for properties. You can register more than one method/property. + If you don't need to register a method, you can leave [method add_do_method] and [method add_undo_method] out; the same goes for properties. You can also register more than one method/property. </description> <tutorials> </tutorials> @@ -52,7 +52,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Register a property value change for 'do'. + Register a property value change for "do". </description> </method> <method name="add_do_reference"> @@ -61,7 +61,7 @@ <argument index="0" name="object" type="Object"> </argument> <description> - 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. + 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. </description> </method> <method name="add_undo_method" qualifiers="vararg"> @@ -85,7 +85,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Register a property value change for 'undo'. + Register a property value change for "undo". </description> </method> <method name="add_undo_reference"> @@ -94,7 +94,7 @@ <argument index="0" name="object" type="Object"> </argument> <description> - 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!). + 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!). </description> </method> <method name="clear_history"> @@ -111,7 +111,7 @@ <return type="void"> </return> <description> - Commit the action. All 'do' methods/properties are called/set when this function is called. + Commit the action. All "do" methods/properties are called/set when this function is called. </description> </method> <method name="create_action"> @@ -130,44 +130,66 @@ <return type="String"> </return> <description> - Get the name of the current action. + Gets the name of the current action. </description> </method> <method name="get_version" qualifiers="const"> <return type="int"> </return> <description> - Get the version, each time a new action is committed, the version number of the UndoRedo is increased automatically. + 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. </description> </method> + <method name="has_redo"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if a "redo" action is available. + </description> + </method> + <method name="has_undo"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if an "undo" action is available. + </description> + </method> <method name="is_commiting_action" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the [UndoRedo] is currently committing the action, i.e. running its "do" method or property change (see [method commit_action]). </description> </method> <method name="redo"> <return type="bool"> </return> <description> - Redo last action. + Redo the last action. </description> </method> <method name="undo"> <return type="bool"> </return> <description> - Undo last action. + Undo the last action. </description> </method> </methods> + <signals> + <signal name="version_changed"> + <description> + Called when [method undo] or [method redo] was called. + </description> + </signal> + </signals> <constants> <constant name="MERGE_DISABLE" value="0" enum="MergeMode"> - Makes [code]do[/code]/[code]undo[/code] operations stay in separate actions. + Makes "do"/"undo" operations stay in separate actions. </constant> <constant name="MERGE_ENDS" value="1" enum="MergeMode"> - Makes so that the action's [code]do[/code] operation is from the first action created and the [code]undo[/code] operation is from the last subsequent action with the same name. + Makes so that the action's "do" operation is from the first action created and the "undo" operation is from the last subsequent action with the same name. </constant> <constant name="MERGE_ALL" value="2" enum="MergeMode"> Makes subsequent actions with the same name be merged into one. |