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

Clarify UndoRedo MergeMode and add_*_reference docs

This commit is contained in:
Jordyfel 2024-04-05 16:41:05 +03:00
parent 7e4c150573
commit 491d3a2740
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/classes/UndoRedo.xml
View File

@ -112,7 +112,8 @@
<return type="void" /> <return type="void" />
<param index="0" name="object" type="Object" /> <param index="0" name="object" type="Object" />
<description> <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 to an object that will be erased if the "do" history is deleted. This is useful for objects added by the "do" action and removed by the "undo" action.
When the "do" history is deleted, if the object is a [RefCounted], it will be unreferenced. Otherwise, it will be freed. Do not use for resources.
[codeblock] [codeblock]
var node = Node2D.new() var node = Node2D.new()
undo_redo.create_action("Add node") undo_redo.create_action("Add node")
@ -143,7 +144,8 @@
<return type="void" /> <return type="void" />
<param index="0" name="object" type="Object" /> <param index="0" name="object" type="Object" />
<description> <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 to an object that will be erased if the "undo" history is deleted. This is useful for objects added by the "undo" action and removed by the "do" action.
When the "undo" history is deleted, if the object is a [RefCounted], it will be unreferenced. Otherwise, it will be freed. Do not use for resources.
[codeblock] [codeblock]
var node = $Node2D var node = $Node2D
undo_redo.create_action("Remove node") undo_redo.create_action("Remove node")
@ -272,10 +274,10 @@
Makes "do"/"undo" operations stay in separate actions. Makes "do"/"undo" 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 "undo" operations are from the first action created and the "do" operations are from the last subsequent action with the same name. Merges this action with the previous one if they have the same name. Keeps only the first action's "undo" operations and the last action's "do" operations. Useful for sequential changes to a single value.
</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. Merges this action with the previous one if they have the same name.
</constant> </constant>
</constants> </constants>
</class> </class>