From f7f6115f7627df24a08a9a0882b2f573cc838eb1 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Sat, 22 Jun 2019 01:04:47 +0200 Subject: Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies --- doc/classes/UndoRedo.xml | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'doc/classes/UndoRedo.xml') diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 71da4c684c..7834719af6 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -4,7 +4,7 @@ Helper to manage undo/redo operations in the editor or custom tools. - Helper to manage undo/redo operations 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 the Godot editor's own [UndoRedo], from a plugin: [codeblock] @@ -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. @@ -52,7 +52,7 @@ - Register a property value change for 'do'. + Register a property value change for "do". @@ -61,7 +61,7 @@ - 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. @@ -85,7 +85,7 @@ - Register a property value change for 'undo'. + Register a property value change for "undo". @@ -94,7 +94,7 @@ - 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!). @@ -111,7 +111,7 @@ - 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. @@ -130,14 +130,14 @@ - Get the name of the current action. + Gets the name of the current action. - 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. @@ -145,21 +145,21 @@ - Returns [code]true[/code] if a 'redo' action is available. + Returns [code]true[/code] if a "redo" action is available. - Returns [code]true[/code] if an 'undo' action is available. + Returns [code]true[/code] if an "undo" action is available. - 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]). + 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]). @@ -186,10 +186,10 @@ - Makes 'do'/'undo' operations stay in separate actions. + Makes "do"/"undo" operations stay in separate actions. - 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. + 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. Makes subsequent actions with the same name be merged into one. -- cgit v1.2.3