diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-01-12 15:50:09 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-12 15:50:09 +0100 |
| commit | 3bce846e0cdc172b8cb17370c5354dc61890bf91 (patch) | |
| tree | 823784e6add70d86ab4e07750e02ef70583513bb /doc/classes | |
| parent | bd07c5b7a8f6daa95a5cfa7a9f5c663a2553fd35 (diff) | |
| parent | 831247b39c90e0cae53b9dc691cad8aef31d9479 (diff) | |
Merge pull request #45126 from groud/improve_undo_redo
Improve UndoRedo class
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/UndoRedo.xml | 29 |
1 files changed, 27 insertions, 2 deletions
diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 2cc3e974e2..0e4a76a1a9 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -110,8 +110,10 @@ <method name="commit_action"> <return type="void"> </return> + <argument index="0" name="execute" type="bool" default="true"> + </argument> <description> - Commit the action. All "do" methods/properties are called/set when this function is called. + Commit the action. If [code]execute[/code] is true (default), all "do" methods/properties are called/set when this function is called. </description> </method> <method name="create_action"> @@ -126,11 +128,34 @@ The way actions are merged is dictated by the [code]merge_mode[/code] argument. See [enum MergeMode] for details. </description> </method> + <method name="get_action_name"> + <return type="String"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <description> + Gets the action name from its index. + </description> + </method> + <method name="get_current_action"> + <return type="int"> + </return> + <description> + Gets the index of the current action. + </description> + </method> <method name="get_current_action_name" qualifiers="const"> <return type="String"> </return> <description> - Gets the name of the current action. + Gets the name of the current action, equivalent to [code]get_action_name(get_current_action())[/code]. + </description> + </method> + <method name="get_history_count"> + <return type="int"> + </return> + <description> + Return how many element are in the history. </description> </method> <method name="get_version" qualifiers="const"> |