add more logic node descriptions

UPBGE · Nov 27, 2024 · cea6475 · cea6475
1 parent d2ee8f8
commit cea6475
Show file tree

Hide file tree

Showing 40 changed files with 308 additions and 180 deletions.
diff --git a/source/images/logic_nodes/data/variables/ln-clear_variables.png b/source/images/logic_nodes/data/variables/ln-clear_variables.png
diff --git a/source/images/logic_nodes/data/variables/ln-list_saved_variables.png b/source/images/logic_nodes/data/variables/ln-list_saved_variables.png
diff --git a/source/images/logic_nodes/data/variables/ln-load_variable.png b/source/images/logic_nodes/data/variables/ln-load_variable.png
diff --git a/source/images/logic_nodes/data/variables/ln-load_variable_dict.png b/source/images/logic_nodes/data/variables/ln-load_variable_dict.png
diff --git a/source/images/logic_nodes/data/variables/ln-remove_variable.png b/source/images/logic_nodes/data/variables/ln-remove_variable.png
diff --git a/source/images/logic_nodes/data/variables/ln-save_variable.png b/source/images/logic_nodes/data/variables/ln-save_variable.png
diff --git a/source/images/logic_nodes/data/variables/ln-save_variable_dict.png b/source/images/logic_nodes/data/variables/ln-save_variable_dict.png
diff --git a/...gic_nodes/ui/widgets/ln-create_canvas.png → ...mages/logic_nodes/ui/ln-create_canvas.png b/...gic_nodes/ui/widgets/ln-create_canvas.png → ...mages/logic_nodes/ui/ln-create_canvas.png
diff --git a/source/images/logic_nodes/ui/widgets/ln-create_path.png b/source/images/logic_nodes/ui/widgets/ln-create_path.png
diff --git a/source/manual/logic_nodes/animation/animation_status.rst b/source/manual/logic_nodes/animation/animation_status.rst
@@ -9,23 +9,25 @@
 Animation Status
 ==============================
 
+Retrieve information about an action currently playing on an object.
+
 Inputs
 ++++++++++++++++++++++++++++++
 
 Object
-   Which object to use. Type in or picker-select.
+   Get an action currently playing on this object.
 
 Layer
-   todo
+   Select the layer from which to pick the action.
 
 Outputs
 ++++++++++++++++++++++++++++++
 
 Is Playing
-   *True* if animation is playing.
+   *True* if an animation is playing on the selected layer.
 
 Action Name
-   Resulting name of the animation.
+   Name of the action currently playing on the selected layer.
 
 Action Frame
-   todo
+   Current frame of the action currently playing on the selected layer.
diff --git a/source/manual/logic_nodes/animation/armature_rig/bone_status.rst b/source/manual/logic_nodes/animation/armature_rig/bone_status.rst
@@ -9,6 +9,11 @@
 Bone Status
 ==============================
 
+.. warning::
+   This node is deprecated.
+
+Get information about a specific armature bone.
+
 Inputs
 ++++++++++++++++++++++++++++++
 
@@ -22,10 +27,10 @@ Outputs
 ++++++++++++++++++++++++++++++
 
 Position
-   todo
+   Position of the Bone in pose matrix transform.
 
 Rotation
-   todo
+   Rotation of the Bone in pose matrix transform.
 
 Scale
-   todo
+   Scale of the Bone in pose matrix transform.
diff --git a/source/manual/logic_nodes/data/path/join_path.rst b/source/manual/logic_nodes/data/path/join_path.rst
@@ -4,6 +4,7 @@
    :alt: Join Path Node
 
 .. _ln-join_path:
+
 ==============================
 Join Path
 ==============================

diff --git a/source/manual/logic_nodes/data/variables/clear_variables.rst b/source/manual/logic_nodes/data/variables/clear_variables.rst
@@ -9,20 +9,19 @@
 Clear Variables
 ==============================
 
-Parameters
-++++++++++++++++++++++++++++++
-
-File Path/Data
-   Path to file/data. todo
+Remove all stored variables from the selected file.
 
 Inputs
 ++++++++++++++++++++++++++++++
 
 Conditon
    Which condition must be fulfilled for node to activate.
 
-Filename
-   Which file to use for clearing. todo
+Path
+   Path to the directory containing the requested file.
+
+File
+   Name of the file itself, ending can be omitted.
 
 Outputs
 ++++++++++++++++++++++++++++++

diff --git a/source/manual/logic_nodes/data/variables/list_saved_variables.rst b/source/manual/logic_nodes/data/variables/list_saved_variables.rst
@@ -9,23 +9,25 @@
 List Saved Variables
 ==============================
 
-Parameters
-++++++++++++++++++++++++++++++
-
-File Path/Data
-   Path to file to be used.
+Quickly summarize saved variables from a given file.
 
 Inputs
 ++++++++++++++++++++++++++++++
 
 Condition
-   Which condition will be used for node to activate. If checked, always *True*. todo
+   Which condition will be used for node to activate. If checked, always *True*.
+
+Path
+   Path to the directory containing the requested file.
+
+File
+   Name of the file itself, ending can be omitted.
 
-Filename
-   File name to read from.
+Name
+   Lookup key.
 
 Print
-   If checked, list will be printed. todo
+   If checked, list will be printed.
 
 Outputs
 ++++++++++++++++++++++++++++++

diff --git a/source/manual/logic_nodes/data/variables/load_variable.rst b/source/manual/logic_nodes/data/variables/load_variable.rst
@@ -9,23 +9,22 @@
 Load Variable
 ==============================
 
-Parameters
-++++++++++++++++++++++++++++++
-
-File Path/Data
-   Path to file/data to load.
+Load a previously saved value from an external file.
 
 Inputs
 ++++++++++++++++++++++++++++++
 
-Filename
-   File name to load from.
+Path
+   Path to the directory containing the requested file.
+
+File
+   Name of the file itself, ending can be omitted.
 
 Name
-   Which variable to load.
+   Lookup key.
 
 Default Value
-   If connected, that value will be used as default. todo
+   If enabled, this value will be used as default if Name is not found.
 
 Outputs
 ++++++++++++++++++++++++++++++

diff --git a/source/manual/logic_nodes/data/variables/load_variable_dict.rst b/source/manual/logic_nodes/data/variables/load_variable_dict.rst
@@ -9,20 +9,19 @@
 Load Variable Dict
 ==============================
 
-Parameters
-++++++++++++++++++++++++++++++
-
-File Path/Data
-   Path to file/data to be used.
+Load a file with previously saved values as dictionary.
 
 Inputs
 ++++++++++++++++++++++++++++++
 
-Filename
-   File name of loaded . todo
+Path
+   Path to the directory containing the requested file.
+
+File
+   Name of the file itself, ending can be omitted.
 
 Outputs
 ++++++++++++++++++++++++++++++
 
 Variables
-   Resulting loaded variables dictionary.
+   Dictionary containing all saved variables in this file.
diff --git a/source/manual/logic_nodes/data/variables/remove_variable.rst b/source/manual/logic_nodes/data/variables/remove_variable.rst
@@ -9,23 +9,22 @@
 Remove Variable
 ==============================
 
-Parameters
-++++++++++++++++++++++++++++++
-
-File Path/Data
-   Path to file to be used.
+Remove a previously saved variable.
 
 Inputs
 ++++++++++++++++++++++++++++++
 
 Condition
    If connected, condition must be fulfilled for node to activate.
 
-Filename
-   File name to be used.
+Path
+   Path to the directory containing the requested file.
+
+File
+   Name of the file itself, ending can be omitted.
 
 Name
-   Variable name to be removed.
+   Lookup key.
 
 Outputs
 ++++++++++++++++++++++++++++++

diff --git a/source/manual/logic_nodes/data/variables/save_variable.rst b/source/manual/logic_nodes/data/variables/save_variable.rst
@@ -9,23 +9,22 @@
 Save Variable
 ==============================
 
-Parameters
-++++++++++++++++++++++++++++++
-
-File Path/Data
-   Path to file to be used.
+Save a value into an external `.json` file.
 
 Inputs
 ++++++++++++++++++++++++++++++
 
 Condition
    Which condition will be used for node to activate.
 
-Filename
-   File name to save to.
+Path
+   Path to the directory containing the requested file.
+
+File
+   Name of the file itself, ending can be omitted.
 
-Variable
-   Which variable to save.
+Name
+   Lookup key.
 
 Type
    Which type and value to save.

diff --git a/source/manual/logic_nodes/data/variables/save_variable_dict.rst b/source/manual/logic_nodes/data/variables/save_variable_dict.rst
@@ -9,23 +9,22 @@
 Save Variable Dict
 ==============================
 
-Parameters
-++++++++++++++++++++++++++++++
-
-File Path/Data
-   Path to file to be saved. todo
+Save a dictionary as external `json`.
 
 Inputs
 ++++++++++++++++++++++++++++++
 
 Condition
    If connected, condition must be fulfilled for node to activate.
 
-Filename
-   File name to read from. todo
+Path
+   Path to the directory containing the requested file.
+
+File
+   Name of the file itself, ending can be omitted.
 
-Variables
-   Dictionary of variables to save.
+Name
+   Lookup key.
 
 Outputs
 ++++++++++++++++++++++++++++++

diff --git a/source/manual/logic_nodes/introduction.rst b/source/manual/logic_nodes/introduction.rst
@@ -39,4 +39,4 @@ Architecture
 Under the hood, Logic Nodes are actually generating *Python scripts* to be executed by the game engine. The generated component will have options for executing the tree *only at startup* and for executing the tree *only when a certain property is set*. Using this method will prevent you from accessing Logic Bricks directly, but you can still access them via *custom Python calls*.
 
 .. warning::
-   Due to the way Logic Nodes *currently* work, they are the most performance-heavy way to create logic.
+   Due to the way Logic Nodes work, they are the most performance-heavy way to create logic.
diff --git a/source/manual/logic_nodes/logic/trees/add_logic_tree_to_object.rst b/source/manual/logic_nodes/logic/trees/add_logic_tree_to_object.rst
@@ -9,6 +9,8 @@
 Add Logic Tree To Object
 ==============================
 
+Add a new logic tree to an object to be executed.
+
 Inputs
 ++++++++++++++++++++++++++++++
 
@@ -22,7 +24,7 @@ Node Tree
    Which *Node Tree* to add.
 
 Initialize
-   todo
+   Set this tree to *active* when added.
 
 Outputs
 ++++++++++++++++++++++++++++++

diff --git a/source/manual/logic_nodes/math/tween_value.rst b/source/manual/logic_nodes/math/tween_value.rst
@@ -9,6 +9,8 @@
 Tween Value
 ==============================
 
+Move a value along a given curve over a set duration. This node can be used to map a linear value of 0-1 to a curve.
+
 Add Point
    :kbd:`LMB` on curve.
 
@@ -49,7 +51,7 @@ To
    Ending tween value.
 
 Duration
-   Duration of Tweening.
+   Duration of Tweening in seconds.
 
 Outputs
 ++++++++++++++++++++++++++++++

diff --git a/source/manual/logic_nodes/math/vectors/check_angle.rst b/source/manual/logic_nodes/math/vectors/check_angle.rst
@@ -9,6 +9,8 @@
 Check Angle
 ==============================
 
+Compare the angle between two vectors against a given value.
+
 Parameters
 ++++++++++++++++++++++++++++++
 
@@ -25,13 +27,13 @@ Vector 2
    Second vector to use for operation.
 
 Value
-   todo
+   Compare the angle between the two vectors agains this value.
 
 Outputs
 ++++++++++++++++++++++++++++++
 
-If True
-   todo
+Result
+   The selected operation outcome.
 
 Angle
    todo
diff --git a/source/manual/logic_nodes/objects/add_object.rst b/source/manual/logic_nodes/objects/add_object.rst
@@ -9,23 +9,25 @@
 Add Object
 ==============================
 
+Add a copy of an object into the current scene.
+
 Inputs
 ++++++++++++++++++++++++++++++
 
 Condition
    Which condition will be used for node to activate.
 
 Object to Add
-   Which object to add.
+   Object Data Block to add into the scene.
 
 Copy Data From
-   Copy data from which object.
+   Copy the transform data from this object (optional).
 
 Life
-   todo
+   Total amount of frames after which the object is removed.
 
 Full Copy
-   todo
+   Duplicate the data used by the spawned object. This will duplicate any material, action etc. used by this Data Block.
 
 Outputs
 ++++++++++++++++++++++++++++++
@@ -34,4 +36,4 @@ Done
     *True* if the node performed successfully, else *False*.
 
 Added Object
-   todo
+   Spawned instance of the object.
diff --git a/source/manual/logic_nodes/objects/transformation/apply_impulse.rst b/source/manual/logic_nodes/objects/transformation/apply_impulse.rst
@@ -38,10 +38,10 @@ Object
    Object that will be pushed away.
 
 Vector
-   The value that will be applied to the impulse. todo
+   The point on which to apply the impulse.
 
-Direction
-   The direction in which impulse will be applied. todo
+Impulse
+   The impulse to be applied to the object.
 
 Output
 ++++++++++++++++++++++++++++++