godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add descriptions for the 'MergeMode's in 'UndoRedo' docs

This commit is contained in:
Michael Alexsander Silva Dias 2019-02-21 11:07:41 -03:00
parent ced77db950
commit 5dc4893f2e
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/classes/UndoRedo.xml
View File

@ -8,22 +8,22 @@
Common behavior is to create an action, then add do/undo calls to functions or property changes, then committing the action. 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 Godot editor's own 'undoredo':
[codeblock] [codeblock]
var undoredo = get_undo_redo() # method of EditorPlugin var undo_redo = get_undo_redo() # Method of EditorPlugin.
func do_something(): func do_something():
pass # put your code here pass # Put your code here.
func undo_something(): func undo_something():
pass # put here the code that reverts what's done by "do_something()" pass # Put here the code that reverts what's done by "do_something()".
func _on_MyButton_pressed(): func _on_MyButton_pressed():
var node = get_node("MyNode2D") var node = get_node("MyNode2D")
undoredo.create_action("Move the node") undo_redo.create_action("Move the node")
undoredo.add_do_method(self, "do_something") undo_redo.add_do_method(self, "do_something")
undoredo.add_undo_method(self, "undo_something") undo_redo.add_undo_method(self, "undo_something")
undoredo.add_do_property(node, "position", Vector2(100,100)) undo_redo.add_do_property(node, "position", Vector2(100,100))
undoredo.add_undo_property(node, "position", node.position) undo_redo.add_undo_property(node, "position", node.position)
undoredo.commit_action() undo_redo.commit_action()
[/codeblock] [/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. [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, and so it goes for properties. You can register more than one method/property.
@ -125,6 +125,7 @@
</argument> </argument>
<description> <description>
Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property], and [method add_undo_property], then commit the action with [method commit_action]. Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property], and [method add_undo_property], then commit the action with [method commit_action].
The way actions are merged is dictated by the [code]merge_mode[/code] argument. See [enum MergeMode] for details.
</description> </description>
</method> </method>
<method name="get_current_action_name" qualifiers="const"> <method name="get_current_action_name" qualifiers="const">
@ -159,10 +160,13 @@
</methods> </methods>
<constants> <constants>
<constant name="MERGE_DISABLE" value="0" enum="MergeMode"> <constant name="MERGE_DISABLE" value="0" enum="MergeMode">
Makes [code]do[/code]/[code]undo[/code] operations stay in separate actions.
</constant> </constant>
<constant name="MERGE_ENDS" value="1" enum="MergeMode"> <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.
</constant> </constant>
<constant name="MERGE_ALL" value="2" enum="MergeMode"> <constant name="MERGE_ALL" value="2" enum="MergeMode">
Makes subsequent actions with the same name be merged into one.
</constant> </constant>
</constants> </constants>
</class> </class>