diff options
| author | Jordyfel <jord_id@abv.bg> | 2024-04-05 16:41:05 +0300 |
|---|---|---|
| committer | Jordyfel <jord_id@abv.bg> | 2024-04-05 20:05:56 +0300 |
| commit | 491d3a2740b90eee987bdceefc8390dec999a4a9 (patch) | |
| tree | 718454703e90b2446a130295322fa955c8f8a1ca /doc/classes/UndoRedo.xml | |
| parent | 7e4c150573d6af7072f2b55ae76dc7b723f21f66 (diff) | |
| download | redot-engine-491d3a2740b90eee987bdceefc8390dec999a4a9.tar.gz | |
Clarify UndoRedo MergeMode and add_*_reference docs
Diffstat (limited to 'doc/classes/UndoRedo.xml')
| -rw-r--r-- | doc/classes/UndoRedo.xml | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 3d36eafb08..e197f7748c 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -112,7 +112,8 @@ <return type="void" /> <param index="0" name="object" type="Object" /> <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] var node = Node2D.new() undo_redo.create_action("Add node") @@ -143,7 +144,8 @@ <return type="void" /> <param index="0" name="object" type="Object" /> <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] var node = $Node2D undo_redo.create_action("Remove node") @@ -272,10 +274,10 @@ Makes "do"/"undo" operations stay in separate actions. </constant> <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 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> </constants> </class> |