add more nodes

UPBGE · Nov 11, 2023 · 9d812f1 · 9d812f1 · lordloki · Nov 14, 2023
1 parent 4000915
commit 9d812f1
Show file tree

Hide file tree

Showing 158 changed files with 361 additions and 85 deletions.
diff --git a/source/images/Logic_Nodes/gamepad_active_node.png b/source/images/Logic_Nodes/gamepad_active_node.png
diff --git a/source/images/Logic_Nodes/gamepad_button_down_node.png b/source/images/Logic_Nodes/gamepad_button_down_node.png
diff --git a/source/images/Logic_Nodes/gamepad_button_up_node.png b/source/images/Logic_Nodes/gamepad_button_up_node.png
diff --git a/source/images/Logic_Nodes/gamepad_look_node.png b/source/images/Logic_Nodes/gamepad_look_node.png
diff --git a/source/images/Logic_Nodes/gamepad_sticks_node.png b/source/images/Logic_Nodes/gamepad_sticks_node.png
diff --git a/source/images/Logic_Nodes/gamepad_trigger_node.png b/source/images/Logic_Nodes/gamepad_trigger_node.png
diff --git a/source/images/Logic_Nodes/gamepad_vibration_node.png b/source/images/Logic_Nodes/gamepad_vibration_node.png
diff --git a/source/images/Logic_Nodes/key_down_node.png b/source/images/Logic_Nodes/key_down_node.png
diff --git a/source/images/Logic_Nodes/load_file_node.png b/source/images/Logic_Nodes/load_file_node.png
diff --git a/source/images/Logic_Nodes/mouse_button_node.png b/source/images/Logic_Nodes/mouse_button_node.png
diff --git a/source/images/Logic_Nodes/vr_controller_node.png b/source/images/Logic_Nodes/vr_controller_node.png
diff --git a/source/images/Logic_Nodes/vr_headset_node.png b/source/images/Logic_Nodes/vr_headset_node.png
diff --git a/source/manual/logic_nodes/index.rst b/source/manual/logic_nodes/index.rst
@@ -8,8 +8,4 @@ Logic Nodes
    :maxdepth: 2
 
    introduction.rst
-   basic/index.rst
-   scene/index.rst
-   logic_math/index.rst
-   data/index.rst
-   utilities/index.rst
+   nodes/index.rst
diff --git a/source/manual/logic_nodes/introduction.rst b/source/manual/logic_nodes/introduction.rst
@@ -4,7 +4,7 @@
 Introduction
 ============
 
-As an alternative to Python scripts and Logic Bricks, Logic Nodes try to provide an intuitive and versatile
+As an alternative to Python scripts and Logic Bricks, Logic Nodes provide an intuitive and versatile
 way to create game logic. They are designed to support rapid prototyping, enabling artists and game designers
 to quickly test and even fully implement features.
 

diff --git a/...logic_nodes/basic/events/custom/catch.rst → ...nodes/nodes/basic/events/custom/catch.rst b/...logic_nodes/basic/events/custom/catch.rst → ...nodes/nodes/basic/events/custom/catch.rst
diff --git a/...logic_nodes/basic/events/custom/index.rst → ...nodes/nodes/basic/events/custom/index.rst b/...logic_nodes/basic/events/custom/index.rst → ...nodes/nodes/basic/events/custom/index.rst
diff --git a/...odes/basic/events/custom/print_events.rst → ...odes/basic/events/custom/print_events.rst b/...odes/basic/events/custom/print_events.rst → ...odes/basic/events/custom/print_events.rst
diff --git a/...logic_nodes/basic/events/custom/throw.rst → ...nodes/nodes/basic/events/custom/throw.rst b/...logic_nodes/basic/events/custom/throw.rst → ...nodes/nodes/basic/events/custom/throw.rst
diff --git a/...manual/logic_nodes/basic/events/index.rst → .../logic_nodes/nodes/basic/events/index.rst b/...manual/logic_nodes/basic/events/index.rst → .../logic_nodes/nodes/basic/events/index.rst
@@ -1,18 +1,18 @@
 ++++++
 Events
 ++++++
-
-.. toctree::
-  :maxdepth: 2
-
-  custom/index.rst
 
 .. toctree::
   :maxdepth: 1
 
   on_init.rst
-  on_next_tick.rst
   on_update.rst
-  on_value_changed.rst
+  on_next_tick.rst
   on_value_changed_to.rst
+  on_value_changed.rst
   once.rst
+
+.. toctree::
+  :maxdepth: 2
+
+  custom/index.rst
diff --git a/...nual/logic_nodes/basic/events/on_init.rst → ...ogic_nodes/nodes/basic/events/on_init.rst b/...nual/logic_nodes/basic/events/on_init.rst → ...ogic_nodes/nodes/basic/events/on_init.rst
diff --git a/...logic_nodes/basic/events/on_next_tick.rst → ...nodes/nodes/basic/events/on_next_tick.rst b/...logic_nodes/basic/events/on_next_tick.rst → ...nodes/nodes/basic/events/on_next_tick.rst
diff --git a/...al/logic_nodes/basic/events/on_update.rst → ...ic_nodes/nodes/basic/events/on_update.rst b/...al/logic_nodes/basic/events/on_update.rst → ...ic_nodes/nodes/basic/events/on_update.rst
diff --git a/...c_nodes/basic/events/on_value_changed.rst → ...s/nodes/basic/events/on_value_changed.rst b/...c_nodes/basic/events/on_value_changed.rst → ...s/nodes/basic/events/on_value_changed.rst
diff --git a/...odes/basic/events/on_value_changed_to.rst → ...odes/basic/events/on_value_changed_to.rst b/...odes/basic/events/on_value_changed_to.rst → ...odes/basic/events/on_value_changed_to.rst
diff --git a/.../manual/logic_nodes/basic/events/once.rst → ...l/logic_nodes/nodes/basic/events/once.rst b/.../manual/logic_nodes/basic/events/once.rst → ...l/logic_nodes/nodes/basic/events/once.rst
@@ -11,6 +11,13 @@ The *Once* node restricts a continuous *True* condition to only the first frame.
 
 *Example*: An :doc:`./on_update` linked to a *Once* node would be equal to the :doc:`./on_init`.
 
+Parameters
+=======
+
+Timer
+   Reset this node after a time of tree inactivity. This is only needed when stopping
+   and starting logic trees.
+
 Inputs
 =======
 
@@ -23,13 +30,6 @@ Repeat
 Reset After
    Reset this node after X seconds. Only relevant if the *Timer* parameter is active.
 
-Parameters
-=======
-
-Timer
-   Reset this node after a time of tree inactivity. This is only needed when stopping
-   and starting logic trees.
-
 Outputs
 =======
 

diff --git a/...e/manual/logic_nodes/basic/game/index.rst → ...al/logic_nodes/nodes/basic/game/index.rst b/...e/manual/logic_nodes/basic/game/index.rst → ...al/logic_nodes/nodes/basic/game/index.rst
diff --git a/...nual/logic_nodes/basic/game/load_game.rst → ...ogic_nodes/nodes/basic/game/load_game.rst b/...nual/logic_nodes/basic/game/load_game.rst → ...ogic_nodes/nodes/basic/game/load_game.rst
@@ -15,6 +15,12 @@ from a previously saved ``.json`` file.
 .. note::
     No information is read about which scene is loaded, so this node can only be used per scene.
 
+Parameters
+==========
+
+Filepath
+   The path to where the save files are stored.
+
 Inputs
 =======
 
@@ -24,12 +30,6 @@ Condition
 Slot
    Index of this save file.
 
-Parameters
-==========
-
-Filepath
-   The path to where the save files are stored.
-
 Outputs
 =======
 

diff --git a/...nual/logic_nodes/basic/game/quit_game.rst → ...ogic_nodes/nodes/basic/game/quit_game.rst b/...nual/logic_nodes/basic/game/quit_game.rst → ...ogic_nodes/nodes/basic/game/quit_game.rst
diff --git a/...l/logic_nodes/basic/game/restart_game.rst → ...c_nodes/nodes/basic/game/restart_game.rst b/...l/logic_nodes/basic/game/restart_game.rst → ...c_nodes/nodes/basic/game/restart_game.rst
diff --git a/...nual/logic_nodes/basic/game/save_game.rst → ...ogic_nodes/nodes/basic/game/save_game.rst b/...nual/logic_nodes/basic/game/save_game.rst → ...ogic_nodes/nodes/basic/game/save_game.rst
@@ -14,6 +14,12 @@ The *Save Game* node stores information about the state of the scene in a ``.jso
 .. note::
     No information is saved about which scene is loaded, so this node can only be used per scene.
 
+Parameters
+==========
+
+Filepath
+   The path to where the save files are stored.
+
 Inputs
 =======
 
@@ -23,12 +29,6 @@ Condition
 Slot
    Index of this save file.
 
-Parameters
-==========
-
-Filepath
-   The path to where the save files are stored.
-
 Outputs
 =======
 

diff --git a/...ual/logic_nodes/basic/game/start_game.rst → ...gic_nodes/nodes/basic/game/start_game.rst b/...ual/logic_nodes/basic/game/start_game.rst → ...gic_nodes/nodes/basic/game/start_game.rst
@@ -1,14 +1,14 @@
 
 +++++++++++++++
-Load File
+Jump To File
 +++++++++++++++
 
 .. figure:: /images/Logic_Nodes/load_file_node.png
    :align: right
    :width: 215
-   :alt: Load File Node.
+   :alt: Jump To File Node.
 
-The *Load File* node is the ingame equivalent of *File->Open*. It loads directly into
+The *Jump To File* node is the ingame equivalent of *File->Open*. It loads directly into
 the runtime version of another .blend file.
 
 Inputs

diff --git a/source/manual/logic_nodes/basic/index.rst → .../manual/logic_nodes/nodes/basic/index.rst b/source/manual/logic_nodes/basic/index.rst → .../manual/logic_nodes/nodes/basic/index.rst
diff --git a/source/manual/logic_nodes/nodes/basic/input/gamepad/gamepad_active.rst b/source/manual/logic_nodes/nodes/basic/input/gamepad/gamepad_active.rst
@@ -0,0 +1,22 @@
++++++++++++++++
+Gamepad Active
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/gamepad_active_node.png
+   :align: right
+   :width: 215
+   :alt: Gamepad Active.
+
+The *Gamepad Active* node detects if the controller at given index has any activity.
+
+Inputs
+=======
+
+Index
+   The controller index to monitor.
+
+Outputs
+=======
+
+Active
+   *True* if the controller has activity, else *False*.
diff --git a/source/manual/logic_nodes/nodes/basic/input/gamepad/gamepad_button.rst b/source/manual/logic_nodes/nodes/basic/input/gamepad/gamepad_button.rst
@@ -0,0 +1,34 @@
++++++++++++++++
+Gamepad Button
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/gamepad_button_down_node.png
+   :align: right
+   :width: 215
+   :alt: Gamepad Button.
+
+The Gamepad *Button* node detects if a specified button has been pressed on the controller at given index.
+
+Parameters
+==========
+
+Button
+   Which button to react to.
+
+Mode
+   Input detection mode.
+
+Inputs
+=======
+
+Index
+   The controller index to monitor.
+
+Outputs
+=======
+
+Pressed
+   *True* if the button is active in the selected mode, else *False*.
+
+Strength
+   Value of the trigger from 0 to 1; Only visible if button is `LT / L2` or `RT / R2`.
diff --git a/source/manual/logic_nodes/nodes/basic/input/gamepad/gamepad_look.rst b/source/manual/logic_nodes/nodes/basic/input/gamepad/gamepad_look.rst
@@ -0,0 +1,65 @@
++++++++++++++++
+Gamepad Look
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/gamepad_look_node.png
+   :align: right
+   :width: 215
+   :alt: Gamepad Look Node.
+
+The *Gamepad Look* node is a quick way to make objects follow controller stick movement.
+It's possible to assign a *Body* and a *Head* object.
+
+If no *Head* object is assigned, the body will be used for both axis, but
+that is generally discouraged as it can lead to unwanted side effects.
+
+Parameters
+==========
+
+Axis
+   Which stick of the controller to use for the transformation.
+
+Inputs
+=======
+
+Condition
+   Input Condition.
+
+Main Object
+   This is the body object
+
+Head (Optional)
+   This is the head object. If set, both objects will be rotated along their corresponding local axis.
+
+Invert XY
+   Option to invert movement for each axis (Vec2).
+
+Index
+   The index of the controller to poll.
+
+Sensitivity
+   Multiplier for translating mouse movement to object rotation.
+
+Exponent
+   Exponent for fine-tuning the stick behavior.
+
+Cap Left/Right
+   Limit the body objects rotation on its local Z axis.
+
+X Limits
+   The limits for the body objects local Z rotaion (Vec2).
+
+Cap Up/Down
+   Limit the head object's rotation on its local X/Y axis.
+
+Y Limits
+   The limits for the head object's local X/Y rotaion (Vec2).
+
+Threshold
+   Ignore stick values under this threshold.
+
+Outputs
+=======
+
+Done
+   *True* if the node performed successfully, else *False*
diff --git a/source/manual/logic_nodes/nodes/basic/input/gamepad/gamepad_sticks.rst b/source/manual/logic_nodes/nodes/basic/input/gamepad/gamepad_sticks.rst
@@ -0,0 +1,38 @@
++++++++++++++++
+Gamepad Sticks
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/gamepad_sticks_node.png
+   :align: right
+   :width: 215
+   :alt: Gamepad Sticks.
+
+The Gamepad *Sticks* node detects stick values of the controller at given index.
+
+Parameters
+==========
+
+Axis
+   Which stick values to read.
+
+Inputs
+=======
+
+Invert XY
+   Invert the axis values.
+
+Index
+   The controller index to monitor.
+
+Sensitivity
+   Multiplier for the axis values.
+
+Threshold
+   Dead-zone for the stick.
+
+
+Outputs
+=======
+
+Vector
+   Stick values as vector `(X, Y, 0)`
diff --git a/source/manual/logic_nodes/nodes/basic/input/gamepad/gamepad_vibration.rst b/source/manual/logic_nodes/nodes/basic/input/gamepad/gamepad_vibration.rst
@@ -0,0 +1,31 @@
++++++++++++++++
+Gamepad Vibration
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/gamepad_vibration_node.png
+   :align: right
+   :width: 215
+   :alt: Gamepad Vibration.
+
+The *Gamepad Vibration* node detects if the controller at given index has any activity.
+
+Inputs
+=======
+
+Index
+   The controller index to vibrate.
+
+Left
+   Force with which to rotate the weight in the left handle.
+
+Right
+   Force with which to rotate the weight in the right handle.
+
+Time
+   Vibrate for this many seconds.
+
+Outputs
+=======
+
+Done
+   *True* if the node performed successfully, else *False*.
diff --git a/source/manual/logic_nodes/nodes/basic/input/gamepad/index.rst b/source/manual/logic_nodes/nodes/basic/input/gamepad/index.rst
@@ -0,0 +1,13 @@
+
++++++
+Gamepad
++++++
+
+.. toctree::
+  :maxdepth: 1
+
+  gamepad_button.rst
+  gamepad_sticks.rst
+  gamepad_active.rst
+  gamepad_vibration.rst
+  gamepad_look.rst
diff --git a/.../manual/logic_nodes/basic/input/index.rst → ...l/logic_nodes/nodes/basic/input/index.rst b/.../manual/logic_nodes/basic/input/index.rst → ...l/logic_nodes/nodes/basic/input/index.rst
@@ -6,5 +6,6 @@ Input
   :maxdepth: 2
 
   mouse/index.rst
-  gamepad/index.rst
   keyboard/index.rst
+  gamepad/index.rst
+  vr/index.rst
diff --git a/...ogic_nodes/basic/input/keyboard/index.rst → ...odes/nodes/basic/input/keyboard/index.rst b/...ogic_nodes/basic/input/keyboard/index.rst → ...odes/nodes/basic/input/keyboard/index.rst
@@ -5,8 +5,7 @@ Keyboard
 .. toctree::
   :maxdepth: 1
 
-  key_code.rst
   key_down.rst
-  key_up.rst
   keyboard_active.rst
-  logger.rst
+  key_code.rst
+  instream.rst
diff --git a/...gic_nodes/basic/input/keyboard/logger.rst → ...s/nodes/basic/input/keyboard/instream.rst b/...gic_nodes/basic/input/keyboard/logger.rst → ...s/nodes/basic/input/keyboard/instream.rst
@@ -9,18 +9,18 @@ Logger
 
 The Keyboard -> *Logger* node records keyboard activity.
 
-Inputs
-=======
-
-Condition
-   Input condition.
-
 Parameters
 ==========
 
 Mode
    Toggle between *Key Tap* and *Key Down* modes.
 
+Inputs
+=======
+
+Condition
+   Input condition.
+
 Outputs
 =======
 

diff --git a/...c_nodes/basic/input/keyboard/key_code.rst → ...s/nodes/basic/input/keyboard/key_code.rst b/...c_nodes/basic/input/keyboard/key_code.rst → ...s/nodes/basic/input/keyboard/key_code.rst