diff --git a/source/images/logic_nodes/data/variables/ln-clear_variables.png b/source/images/logic_nodes/data/variables/ln-clear_variables.png index 6737b5a2..538e9198 100644 Binary files a/source/images/logic_nodes/data/variables/ln-clear_variables.png and b/source/images/logic_nodes/data/variables/ln-clear_variables.png differ 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 index 6ffa3cc8..a4a0f45f 100644 Binary files a/source/images/logic_nodes/data/variables/ln-list_saved_variables.png and b/source/images/logic_nodes/data/variables/ln-list_saved_variables.png differ diff --git a/source/images/logic_nodes/data/variables/ln-load_variable.png b/source/images/logic_nodes/data/variables/ln-load_variable.png index ea89e004..5abca596 100644 Binary files a/source/images/logic_nodes/data/variables/ln-load_variable.png and b/source/images/logic_nodes/data/variables/ln-load_variable.png differ 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 index 50836871..0349321c 100644 Binary files a/source/images/logic_nodes/data/variables/ln-load_variable_dict.png and b/source/images/logic_nodes/data/variables/ln-load_variable_dict.png differ diff --git a/source/images/logic_nodes/data/variables/ln-remove_variable.png b/source/images/logic_nodes/data/variables/ln-remove_variable.png index 881b2a09..a980d0ea 100644 Binary files a/source/images/logic_nodes/data/variables/ln-remove_variable.png and b/source/images/logic_nodes/data/variables/ln-remove_variable.png differ diff --git a/source/images/logic_nodes/data/variables/ln-save_variable.png b/source/images/logic_nodes/data/variables/ln-save_variable.png index 5fcba3f4..4bc153c7 100644 Binary files a/source/images/logic_nodes/data/variables/ln-save_variable.png and b/source/images/logic_nodes/data/variables/ln-save_variable.png differ 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 index 78dd9498..575bb83c 100644 Binary files a/source/images/logic_nodes/data/variables/ln-save_variable_dict.png and b/source/images/logic_nodes/data/variables/ln-save_variable_dict.png differ diff --git a/source/images/logic_nodes/ui/widgets/ln-create_canvas.png b/source/images/logic_nodes/ui/ln-create_canvas.png similarity index 100% rename from source/images/logic_nodes/ui/widgets/ln-create_canvas.png rename to source/images/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 new file mode 100644 index 00000000..e5cd7646 Binary files /dev/null and b/source/images/logic_nodes/ui/widgets/ln-create_path.png differ diff --git a/source/manual/logic_nodes/animation/animation_status.rst b/source/manual/logic_nodes/animation/animation_status.rst index d937b016..2f8df0a8 100644 --- 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 index cfd6b834..a334e008 100644 --- 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 index 87be5506..f71a7bba 100644 --- 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 index 92a7b750..ae2fe336 100644 --- a/source/manual/logic_nodes/data/variables/clear_variables.rst +++ b/source/manual/logic_nodes/data/variables/clear_variables.rst @@ -9,11 +9,7 @@ Clear Variables ============================== -Parameters -++++++++++++++++++++++++++++++ - -File Path/Data - Path to file/data. todo +Remove all stored variables from the selected file. Inputs ++++++++++++++++++++++++++++++ @@ -21,8 +17,11 @@ 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 index 9fc7983e..325ebf41 100644 --- 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 index 2d5f3411..452fc7db 100644 --- 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 index 43485485..917d82ba 100644 --- 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 index f059ae53..c2193e21 100644 --- a/source/manual/logic_nodes/data/variables/remove_variable.rst +++ b/source/manual/logic_nodes/data/variables/remove_variable.rst @@ -9,11 +9,7 @@ Remove Variable ============================== -Parameters -++++++++++++++++++++++++++++++ - -File Path/Data - Path to file to be used. +Remove a previously saved variable. Inputs ++++++++++++++++++++++++++++++ @@ -21,11 +17,14 @@ 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 index 895e4376..2075509c 100644 --- a/source/manual/logic_nodes/data/variables/save_variable.rst +++ b/source/manual/logic_nodes/data/variables/save_variable.rst @@ -9,11 +9,7 @@ Save Variable ============================== -Parameters -++++++++++++++++++++++++++++++ - -File Path/Data - Path to file to be used. +Save a value into an external `.json` file. Inputs ++++++++++++++++++++++++++++++ @@ -21,11 +17,14 @@ 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 index 9405639c..b230d63a 100644 --- a/source/manual/logic_nodes/data/variables/save_variable_dict.rst +++ b/source/manual/logic_nodes/data/variables/save_variable_dict.rst @@ -9,11 +9,7 @@ Save Variable Dict ============================== -Parameters -++++++++++++++++++++++++++++++ - -File Path/Data - Path to file to be saved. todo +Save a dictionary as external `json`. Inputs ++++++++++++++++++++++++++++++ @@ -21,11 +17,14 @@ 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 index b872d82c..68742e5c 100644 --- 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 index b95032c6..0d7df860 100644 --- 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 index b51ace4b..5577a657 100644 --- 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 index 7413a0a8..db0e49fc 100644 --- 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 index 6558afd4..ef6900a2 100644 --- a/source/manual/logic_nodes/objects/add_object.rst +++ b/source/manual/logic_nodes/objects/add_object.rst @@ -9,6 +9,8 @@ Add Object ============================== +Add a copy of an object into the current scene. + Inputs ++++++++++++++++++++++++++++++ @@ -16,16 +18,16 @@ 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 index 48f3d2ea..1523f31d 100644 --- 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 ++++++++++++++++++++++++++++++ diff --git a/source/manual/logic_nodes/physics/add_constraint.rst b/source/manual/logic_nodes/physics/add_constraint.rst index d9a598a3..3f0b14dd 100644 --- a/source/manual/logic_nodes/physics/add_constraint.rst +++ b/source/manual/logic_nodes/physics/add_constraint.rst @@ -9,6 +9,8 @@ Add Constraint ============================== +This node will create a new physics constraint on the selected object. + Parameters ++++++++++++++++++++++++++++++ @@ -22,22 +24,22 @@ Condition If connected, condition must be fulfilled for node to activate. Object - Which object to use todo. + Which object to apply the constraint to. Target - Which object to use as target. + Which object to use as target for the constraint (may not be the same as Object socket). Name - todo + Unique name for this constraint for later access. Use World Space - todo + Calculate the pivot in world space instead of local. Pivot - todo + Pivot for physics calculations. Linked Collision - todo + If enabled, object will collide with target. Outputs ++++++++++++++++++++++++++++++ diff --git a/source/manual/logic_nodes/physics/collision.rst b/source/manual/logic_nodes/physics/collision.rst index 83aea412..f07e3521 100644 --- a/source/manual/logic_nodes/physics/collision.rst +++ b/source/manual/logic_nodes/physics/collision.rst @@ -9,6 +9,8 @@ Collision ============================== +Detect and react to collisions involving a given object. + Parameters ++++++++++++++++++++++++++++++ @@ -19,28 +21,31 @@ Inputs ++++++++++++++++++++++++++++++ Object - Which object to use for collision. + The monitored object. Use Material - Which material to use. + If enabled, changes the "Property" socket to a "Material" one. Property - todo + If set, only detect collisions with objects that have this property. + +Material + If set, only detect collisions with objects that have this material applied. Outputs ++++++++++++++++++++++++++++++ On Collision - What to trigger when collision happens. todo + `True` if a collision has occured according to the "Continuous" property, else `False`. Colliding Object - Which other object has collided with used object. todo + The object with which the monitored object is colliding with. Colliding Objects - A list of colliding objects. todo + A list of objects with which the monitored object is colliding with. Point - todo + The point in world space where the collision has occured. Normal - todo + The normal of the face on which the collision has occured. diff --git a/source/manual/logic_nodes/raycasts/camera_ray.rst b/source/manual/logic_nodes/raycasts/camera_ray.rst index 13b21576..32a7ac03 100644 --- a/source/manual/logic_nodes/raycasts/camera_ray.rst +++ b/source/manual/logic_nodes/raycasts/camera_ray.rst @@ -9,6 +9,8 @@ Camera Ray ============================== +Cast a ray from the camera in the direction of coordinates on the screen. + Inputs ++++++++++++++++++++++++++++++ @@ -16,31 +18,31 @@ Condition Which condition will be used for node to activate. Aim - todo + Screen coordinates at which to cast the ray. Property Which property to use. X-Ray - todo + Ignore objects that don't have the given property. Distance - todo. + Maximum reach of the ray. Mask - Mask layers to use. todo + Bitmask to use. Outputs ++++++++++++++++++++++++++++++ Has Result - todo + `True` if the ray has hit a target, else `False` Picked Object - todo + The object the ray has hit, or `None` Picked Point - todo + The world point the ray has hit, or `None` Picked Normal - todo + The normal of the face the ray has hit, or `None` diff --git a/source/manual/logic_nodes/scene/post_fx/add_filter.rst b/source/manual/logic_nodes/scene/post_fx/add_filter.rst index 7b097d99..6ebbab3b 100644 --- a/source/manual/logic_nodes/scene/post_fx/add_filter.rst +++ b/source/manual/logic_nodes/scene/post_fx/add_filter.rst @@ -9,6 +9,20 @@ Add Filter ============================== +This node will add a new GL filter, modifying the render output. + +Available filters are: +- FXAA +- HBAO +- SSAO +- Vignette +- Brightness +- Chromatic Abberation +- Grayscale +- Levels +- Mist +- Blur + Parameters ++++++++++++++++++++++++++++++ @@ -22,19 +36,19 @@ Condition If connected, condition must be fulfilled for node to activate. Pass Index - todo + Higher indices will affect the rendered image by lower indices. Power - todo + Strength of the effect. Color - Color of the added filter. + Color of the added filter (if applicable). Brightness - Brightness of the selected filter. + Brightness of the selected filter (if applicable). Start - todo. For *Mist* filter only. + Starting distance of the mist. For *Mist* filter only. Density Density of the mist. For *Mist* filter only. diff --git a/source/manual/logic_nodes/time/barrier.rst b/source/manual/logic_nodes/time/barrier.rst index c03026f6..88f97cc5 100644 --- a/source/manual/logic_nodes/time/barrier.rst +++ b/source/manual/logic_nodes/time/barrier.rst @@ -9,6 +9,10 @@ Barrier ============================== +Only activate if the condition is true for the given amount of time. +Example: If the condition is "Press A" and the Time socket is set to "1.0", +A has to be pressed for 1 second for the output socket to return `True`. + Inputs ++++++++++++++++++++++++++++++ @@ -16,10 +20,10 @@ Condition If connected, condition must be fulfilled for node to activate. Time - todo + Output socket will return `True` if input condition has been true for this amount of seconds. Outputs ++++++++++++++++++++++++++++++ Out - Resulting value of . todo + `True` if input condition has been `True` for "Time" seconds, else `False`. diff --git a/source/manual/logic_nodes/ui/add_widget.rst b/source/manual/logic_nodes/ui/add_widget.rst index 98ee6bd7..8d28919a 100644 --- a/source/manual/logic_nodes/ui/add_widget.rst +++ b/source/manual/logic_nodes/ui/add_widget.rst @@ -9,6 +9,10 @@ Add Widget ============================== +Add one widget to another. Child widgets will inherit positioning +and rotation from their parent and can be placed locally. They will +also only be visible if their parent is also visible. + Inputs ++++++++++++++++++++++++++++++ @@ -16,10 +20,10 @@ Condition If connected, condition must be fulfilled for node to activate. Parent - todo + Parent to which to add the widget. Widget - todo + Widget to add to the parent. Outputs ++++++++++++++++++++++++++++++ diff --git a/source/manual/logic_nodes/ui/widgets/create_canvas.rst b/source/manual/logic_nodes/ui/create_canvas.rst similarity index 86% rename from source/manual/logic_nodes/ui/widgets/create_canvas.rst rename to source/manual/logic_nodes/ui/create_canvas.rst index ed742d5c..0a79b6b9 100644 --- a/source/manual/logic_nodes/ui/widgets/create_canvas.rst +++ b/source/manual/logic_nodes/ui/create_canvas.rst @@ -1,4 +1,4 @@ -.. figure:: /images/logic_nodes/ui/widgets/ln-create_canvas.png +.. figure:: /images/logic_nodes/ui/ln-create_canvas.png :align: right :width: 215 :alt: Create Canvas Node diff --git a/source/manual/logic_nodes/ui/index.rst b/source/manual/logic_nodes/ui/index.rst index 47271267..ce681c06 100644 --- a/source/manual/logic_nodes/ui/index.rst +++ b/source/manual/logic_nodes/ui/index.rst @@ -8,6 +8,7 @@ UI :maxdepth: 1 widgets/index + create_canvas add_widget get_widget_attribute set_widget_attribute diff --git a/source/manual/logic_nodes/ui/widgets/create_button.rst b/source/manual/logic_nodes/ui/widgets/create_button.rst index 5fe037da..5bf0e6b5 100644 --- a/source/manual/logic_nodes/ui/widgets/create_button.rst +++ b/source/manual/logic_nodes/ui/widgets/create_button.rst @@ -9,14 +9,22 @@ Create Button ============================== +Create an interactive button. + Parameters ++++++++++++++++++++++++++++++ X: - Origin/start horizontal position. + Widget horizontal alignment Y: - Origin/start vertical position. + Widget vertical alignment + +Text X: + Text horizontal alignment. + +Text Y: + Text vertical alignment. Inputs ++++++++++++++++++++++++++++++ @@ -25,22 +33,22 @@ Condition If connected, condition must be fulfilled for node to activate. Parent - todo + If connected, the created widget will be added as a child to this parent. Relative Position - todo + If enabled, position will use a factor value (0-1) instead of pixels. -Vector - X and Y vector of . todo +Position + X and Y position of this Widget. Relative Size - todo + If enabled, Size will use a factor value (0-1) instead of pixels. -Vector - todo +Size + Width and Height of this Widget. Angle - Angle in radians. todo + Widget tilt Angle. Color Button color in normal state. @@ -55,7 +63,22 @@ Border Color Color of border line. Text - Button text string. + Text displayed on top of the button. + +Text Position + Text position in local button coordinates. + +Font + Graphical font to use for the button text. + +Font Size + Display size for the text. + +Line Height + Line spacing in factor (1.5 = 1.5 x Font Size). + +Font Color + Color of the button text. Outputs ++++++++++++++++++++++++++++++ @@ -64,13 +87,13 @@ Done *True* if node performed successfully, else *False*. Button - Resulting button data . todo + Created Widget. On Click - Which action to perform on button click. + True when Button is clicked. On Hover - Which action to perform on button mouse-over. + True when cursor is hovering over this widget. On Release - Which action to perform on button release. + True when Button was clicked and is released again. diff --git a/source/manual/logic_nodes/ui/widgets/create_image.rst b/source/manual/logic_nodes/ui/widgets/create_image.rst index 481337cd..96b70bc8 100644 --- a/source/manual/logic_nodes/ui/widgets/create_image.rst +++ b/source/manual/logic_nodes/ui/widgets/create_image.rst @@ -13,10 +13,10 @@ Parameters ++++++++++++++++++++++++++++++ X: - Origin/start horizontal position. + Widget horizontal alignment Y: - Origin/start vertical position. + Widget vertical alignment Inputs ++++++++++++++++++++++++++++++ @@ -25,22 +25,22 @@ Condition If connected, condition must be fulfilled for node to activate. Parent - todo + If connected, the created widget will be added as a child to this parent. Relative Position todo -Vector - X and Y vector of . todo +Position + X and Y position of this Widget. Relative Size - todo + If enabled, Size will use a factor value (0-1) instead of pixels. -Vector - todo +Size + Width and Height of this Widget. Angle - Angle in radians. todo + Widget tilt Angle. Image Path to the image to use. @@ -52,4 +52,4 @@ Done *True* if node performed successfully, else *False*. Image - Resulting image data . todo + Created Widget. diff --git a/source/manual/logic_nodes/ui/widgets/create_label.rst b/source/manual/logic_nodes/ui/widgets/create_label.rst index 1d3d8535..545438a0 100644 --- a/source/manual/logic_nodes/ui/widgets/create_label.rst +++ b/source/manual/logic_nodes/ui/widgets/create_label.rst @@ -13,10 +13,10 @@ Parameters ++++++++++++++++++++++++++++++ X: - Origin/start horizontal position. + Text horizontal alignment Y: - Origin/start vertical position. + Text vertical alignment Inputs ++++++++++++++++++++++++++++++ @@ -25,28 +25,28 @@ Condition If connected, condition must be fulfilled for node to activate. Parent - todo + If connected, the created widget will be added as a child to this parent. Relative Position - todo + If enabled, position will use a factor value (0-1) instead of pixels. -Vector - X and Y vector of . todo +Position + X and Y position of this Widget. Angle - Angle in radians. todo + Widget tilt Angle. Text - Label text to show. + Text content as string. Font - Label text font to use. + Graphical font to use for the text. Font Size - Font size to set. + Display size for the text. Line Height - todo + Line spacing in factor (1.5 = 1.5 x Font Size). Font Color Color to use for font. @@ -54,6 +54,12 @@ Font Color Use Shadow If checked, text will drop a shadow on background. +Shadow Offset + Offset of the drop shadow in pixels. + +Shadow Color + Color of the shadow drawn behind the text. + Outputs ++++++++++++++++++++++++++++++ @@ -61,4 +67,4 @@ Done *True* if node performed successfully, else *False*. Label - Resulting label data . todo + Created widget. diff --git a/source/manual/logic_nodes/ui/widgets/create_layout.rst b/source/manual/logic_nodes/ui/widgets/create_layout.rst index 4206bb8d..9ecf0e9e 100644 --- a/source/manual/logic_nodes/ui/widgets/create_layout.rst +++ b/source/manual/logic_nodes/ui/widgets/create_layout.rst @@ -16,10 +16,10 @@ Layout Type Selected layout type. X: - Origin/start horizontal position. + Widget horizontal alignment Y: - Origin/start vertical position. + Widget vertical alignment Inputs ++++++++++++++++++++++++++++++ @@ -28,25 +28,25 @@ Condition If connected, condition must be fulfilled for node to activate. Parent - todo + If connected, the created widget will be added as a child to this parent. Relative Position - todo + If enabled, position will use a factor value (0-1) instead of pixels. -Vector - X and Y vector of . todo +Position + X and Y position of this Widget. Relative Size - todo + If enabled, Size will use a factor value (0-1) instead of pixels. -Vector - todo +Size + Width and Height of this Widget. Angle - Angle in radians. todo + Widget tilt Angle. Color - todo + Background color of this widget. Border Width Width of border line, in pixels. @@ -61,4 +61,4 @@ Done *True* if node performed successfully, else *False*. Layout - Resulting layout data. todo + Created widget. diff --git a/source/manual/logic_nodes/ui/widgets/create_path.rst b/source/manual/logic_nodes/ui/widgets/create_path.rst new file mode 100644 index 00000000..0dc07441 --- /dev/null +++ b/source/manual/logic_nodes/ui/widgets/create_path.rst @@ -0,0 +1,55 @@ +.. figure:: /images/logic_nodes/ui/widgets/ln-create_path.png + :align: right + :width: 215 + :alt: Create Path Node + +.. _ln-create_path: + +============================== +Create Path +============================== + +Parameters +++++++++++++++++++++++++++++++ + +World: + Draw the path in screen or world coordinates. + +Inputs +++++++++++++++++++++++++++++++ + +Condition + If connected, condition must be fulfilled for node to activate. + +Parent + If connected, the created widget will be added as a child to this parent. + +Relative Position + If enabled, position will use a factor value (0-1) instead of pixels. + +Position + X and Y position of this Widget. + +Relative Points + If enabled, each point in Points will use a factor value for its position (0-1) instead of pixels. + +Points + List of points. + +Line Color + Color to draw the line with. + +Line Width + Width of Path line, in pixels. + +Angle + Widget tilt Angle. + +Outputs +++++++++++++++++++++++++++++++ + +Done + *True* if node performed successfully, else *False*. + +Button + Created widget. diff --git a/source/manual/logic_nodes/ui/widgets/create_slider.rst b/source/manual/logic_nodes/ui/widgets/create_slider.rst index fbf094c6..eed3c157 100644 --- a/source/manual/logic_nodes/ui/widgets/create_slider.rst +++ b/source/manual/logic_nodes/ui/widgets/create_slider.rst @@ -19,10 +19,10 @@ Orientation Selected slider orientation. X: - Origin/start horizontal position. + Widget horizontal alignment Y: - Origin/start vertical position. + Widget vertical alignment Inputs ++++++++++++++++++++++++++++++ @@ -31,22 +31,22 @@ Condition If connected, condition must be fulfilled for node to activate. Parent - todo + If connected, the created widget will be added as a child to this parent. Relative Position - todo + If enabled, position will use a factor value (0-1) instead of pixels. -Vector - X and Y vector of . todo +Position + X and Y position of this Widget. Relative Size - todo + If enabled, Size will use a factor value (0-1) instead of pixels. -Vector - todo +Size + Width and Height of this Widget. Angle - Angle in radians. todo + Widget tilt Angle. Bar Width Width of the slider bar. @@ -61,7 +61,7 @@ Bar Hover Color Slider color when in mouse-over state. Knob Size - todo + Size of the control knob (only on some slider types). Knob Color Color of the knob. @@ -70,10 +70,10 @@ Knob Hover Color Color of the knob when in mouse-over state. Steps - If step functionality is required, i.e. slider moves by value of 10-20-30 etc. 0 (zero) will enable smooth value changing. todo + If step functionality is required, i.e. slider moves by value of 10-20-30 etc. 0 (zero) will enable smooth value changing. Bar Control - If checked, . todo + If checked, clicking on the bar has the same effect as clicking on the knob. Outputs ++++++++++++++++++++++++++++++ @@ -82,10 +82,10 @@ Done *True* if node performed successfully, else *False*. Slider - Resulting slider data . todo + Created widget. Slider Value - Initial slider value. todo + Current slider value. Knob Position - Knob rotation relative to slider value. todo + Knob position in pixel screen coordinates. diff --git a/source/manual/logic_nodes/ui/widgets/index.rst b/source/manual/logic_nodes/ui/widgets/index.rst index 53581b6f..ec26466b 100644 --- a/source/manual/logic_nodes/ui/widgets/index.rst +++ b/source/manual/logic_nodes/ui/widgets/index.rst @@ -6,10 +6,10 @@ Widgets .. toctree:: :maxdepth: 1 - - create_canvas + create_layout create_button create_label create_image create_slider + create_path