more node documentation

UPBGE · Apr 6, 2023 · dfc8f55 · dfc8f55
1 parent db2249f
commit dfc8f55
Show file tree

Hide file tree

Showing 52 changed files with 600 additions and 9 deletions.
diff --git a/source/images/Logic_Nodes/cursor_visibility_node.png b/source/images/Logic_Nodes/cursor_visibility_node.png
diff --git a/source/images/Logic_Nodes/key_code_node.png b/source/images/Logic_Nodes/key_code_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/key_logger_node.png b/source/images/Logic_Nodes/key_logger_node.png
diff --git a/source/images/Logic_Nodes/key_up_node.png b/source/images/Logic_Nodes/key_up_node.png
diff --git a/source/images/Logic_Nodes/keyboard_active_node.png b/source/images/Logic_Nodes/keyboard_active_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/load_game_node.png b/source/images/Logic_Nodes/load_game_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/mouse_button_over_node.png b/source/images/Logic_Nodes/mouse_button_over_node.png
diff --git a/source/images/Logic_Nodes/mouse_button_up_node.png b/source/images/Logic_Nodes/mouse_button_up_node.png
diff --git a/source/images/Logic_Nodes/mouse_look_node.png b/source/images/Logic_Nodes/mouse_look_node.png
diff --git a/source/images/Logic_Nodes/mouse_moved_node.png b/source/images/Logic_Nodes/mouse_moved_node.png
diff --git a/source/images/Logic_Nodes/mouse_over_node.png b/source/images/Logic_Nodes/mouse_over_node.png
diff --git a/source/images/Logic_Nodes/mouse_set_position_node.png b/source/images/Logic_Nodes/mouse_set_position_node.png
diff --git a/source/images/Logic_Nodes/mouse_status_node.png b/source/images/Logic_Nodes/mouse_status_node.png
diff --git a/source/images/Logic_Nodes/mouse_wheel_node.png b/source/images/Logic_Nodes/mouse_wheel_node.png
diff --git a/source/images/Logic_Nodes/quit_game_node.png b/source/images/Logic_Nodes/quit_game_node.png
diff --git a/source/images/Logic_Nodes/restart_game_node.png b/source/images/Logic_Nodes/restart_game_node.png
diff --git a/source/images/Logic_Nodes/save_game_node.png b/source/images/Logic_Nodes/save_game_node.png
diff --git a/source/manual/logic_nodes/basic/events/custom/catch.rst b/source/manual/logic_nodes/basic/events/custom/catch.rst
@@ -5,9 +5,10 @@ Receive
 
 .. figure:: /images/Logic_Nodes/receive_node.png
    :align: right
+   :width: 215
    :alt: Receive Node.
 
-The *Receive* node reacts to events thrown via the *Send* node or the *uplogic* module.
+The *Receive* node reacts to events thrown via the :doc:`./throw` node or the *uplogic* module.
 An Event can store some data, which can be extracted using this node.
 
 .. note::

diff --git a/source/manual/logic_nodes/basic/events/custom/throw.rst b/source/manual/logic_nodes/basic/events/custom/throw.rst
@@ -4,9 +4,10 @@ Send
 
 .. figure:: /images/Logic_Nodes/send_node.png
    :align: right
+   :width: 215
    :alt: Send Node.
 
-The *Send* node creates an event that can be reacted to using the *Send* node or
+The *Send* node creates an event that can be reacted to using the :doc:`./catch` node or
 the *uplogic* module. An Event can store *Content* and a *Messenger* can be assigned.
 
 .. note::

diff --git a/source/manual/logic_nodes/basic/events/index.rst b/source/manual/logic_nodes/basic/events/index.rst
@@ -3,9 +3,13 @@ Events
 ++++++
 
 .. toctree::
-  :maxdepth: 1
+  :maxdepth: 2
 
   custom/index.rst
+
+.. toctree::
+  :maxdepth: 1
+
   on_init.rst
   on_next_tick.rst
   on_update.rst

diff --git a/source/manual/logic_nodes/basic/events/on_init.rst b/source/manual/logic_nodes/basic/events/on_init.rst
@@ -5,6 +5,7 @@ On Init
 
 .. figure:: /images/Logic_Nodes/on_init_node.png
    :align: right
+   :width: 215
    :alt: On Init Node.
 
 The *On Init* node can be used to set up a scene. It activates only on the first frame.

diff --git a/source/manual/logic_nodes/basic/events/on_next_tick.rst b/source/manual/logic_nodes/basic/events/on_next_tick.rst
@@ -5,6 +5,7 @@ On Next Tick
 
 .. figure:: /images/Logic_Nodes/on_next_tick_node.png
    :align: right
+   :width: 215
    :alt: On Next Tick Node.
 
 The *On Next Tick* node delays a condition by one tick/frame.

diff --git a/source/manual/logic_nodes/basic/events/on_update.rst b/source/manual/logic_nodes/basic/events/on_update.rst
@@ -5,6 +5,7 @@ On Update
 
 .. figure:: /images/Logic_Nodes/on_update_node.png
    :align: right
+   :width: 215
    :alt: On Update Node.
 
 The *On Update* node activates each frame. It can be used to continuously

diff --git a/source/manual/logic_nodes/basic/events/on_value_changed.rst b/source/manual/logic_nodes/basic/events/on_value_changed.rst
@@ -4,6 +4,7 @@ On Value Changed
 
 .. figure:: /images/Logic_Nodes/on_value_changed_node.png
    :align: right
+   :width: 215
    :alt: On Value Changed Node.
 
 The *On Value Changed* node stores a value internally, and as soon as a value other than

diff --git a/source/manual/logic_nodes/basic/events/on_value_changed_to.rst b/source/manual/logic_nodes/basic/events/on_value_changed_to.rst
@@ -5,6 +5,7 @@ On Value Changed To
 
 .. figure:: /images/Logic_Nodes/on_value_changed_to_node.png
    :align: right
+   :width: 215
    :alt: On Value Changed To Node.
 
 The *On Value Changed To* node stores a value internally, and as soon as the value pulled through

diff --git a/source/manual/logic_nodes/basic/events/once.rst b/source/manual/logic_nodes/basic/events/once.rst
@@ -4,6 +4,7 @@ Once
 
 .. figure:: /images/Logic_Nodes/once_node.png
    :align: right
+   :width: 215
    :alt: Once Node.
 
 The *Once* node restricts a continuous *True* condition to only the first frame.

diff --git a/source/manual/logic_nodes/basic/game/index.rst b/source/manual/logic_nodes/basic/game/index.rst
@@ -2,9 +2,11 @@
 Game
 ++++
 
+.. toctree::
+  :maxdepth: 1
 
-load_game.rst
-quit_game.rst
-restart_game.rst
-save_game.rst
-start_game.rst
+  load_game.rst
+  quit_game.rst
+  restart_game.rst
+  save_game.rst
+  start_game.rst
diff --git a/source/manual/logic_nodes/basic/game/load_game.rst b/source/manual/logic_nodes/basic/game/load_game.rst
@@ -1 +1,37 @@
 
+
++++++++++++++++
+Load Game
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/load_game_node.png
+   :align: right
+   :width: 215
+   :alt: Load Game Node.
+
+The *Load Game* node reads information about the state of the current scene
+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.
+
+Inputs
+=======
+
+Condition
+   Input Condition.
+
+Slot
+   Index of this save file.
+
+Parameters
+==========
+
+Filepath
+   The path to where the save files are stored.
+
+Outputs
+=======
+
+Done
+   *True* if the node performed successfully, else *False*
diff --git a/source/manual/logic_nodes/basic/game/quit_game.rst b/source/manual/logic_nodes/basic/game/quit_game.rst
@@ -1 +1,19 @@
 
+
++++++++++++++++
+Quit Game
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/quit_game_node.png
+   :align: right
+   :width: 215
+   :alt: Quit Game Node.
+
+The *Quit Game* node exits the current runtime. In standalone mode it closes the runtime
+window entirely.
+
+Inputs
+=======
+
+Condition
+   Input Condition.
diff --git a/source/manual/logic_nodes/basic/game/restart_game.rst b/source/manual/logic_nodes/basic/game/restart_game.rst
@@ -1 +1,23 @@
 
++++++++++++++++
+Restart Game
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/restart_game_node.png
+   :align: right
+   :width: 215
+   :alt: Restart Game Node.
+
+The *Restart Game* node reverts the state of the current runtime to it's original version.
+
+Inputs
+=======
+
+Condition
+   Input Condition.
+
+Outputs
+=======
+
+Done
+   *True* if the node performed successfully, else *False*
diff --git a/source/manual/logic_nodes/basic/game/save_game.rst b/source/manual/logic_nodes/basic/game/save_game.rst
@@ -1 +1,36 @@
 
+
++++++++++++++++
+Save Game
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/save_game_node.png
+   :align: right
+   :width: 215
+   :alt: Save Game Node.
+
+The *Save Game* node stores information about the state of the scene in a ``.json`` file.
+
+.. note::
+    No information is saved about which scene is loaded, so this node can only be used per scene.
+
+Inputs
+=======
+
+Condition
+   Input Condition.
+
+Slot
+   Index of this save file.
+
+Parameters
+==========
+
+Filepath
+   The path to where the save files are stored.
+
+Outputs
+=======
+
+Done
+   *True* if the node performed successfully, else *False*
diff --git a/source/manual/logic_nodes/basic/game/start_game.rst b/source/manual/logic_nodes/basic/game/start_game.rst
@@ -1 +1,27 @@
 
++++++++++++++++
+Load File
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/load_file_node.png
+   :align: right
+   :width: 215
+   :alt: Load File Node.
+
+The *Load File* node is the ingame equivalent of *File->Open*. It loads directly into
+the runtime version of another .blend file.
+
+Inputs
+=======
+
+Condition
+   Input Condition.
+
+File Name
+   Full path to the target .blend file; Supports relative paths.
+
+Outputs
+=======
+
+Done
+   *True* if the node performed successfully, else *False*
diff --git a/source/manual/logic_nodes/basic/input/index.rst b/source/manual/logic_nodes/basic/input/index.rst
@@ -3,7 +3,7 @@ Input
 +++++
 
 .. toctree::
-  :maxdepth: 1
+  :maxdepth: 2
 
   mouse/index.rst
   gamepad/index.rst

diff --git a/source/manual/logic_nodes/basic/input/keyboard/index.rst b/source/manual/logic_nodes/basic/input/keyboard/index.rst
@@ -1 +1,12 @@
++++++
+Keyboard
++++++
 
+.. toctree::
+  :maxdepth: 1
+
+  key_code.rst
+  key_down.rst
+  key_up.rst
+  keyboard_active.rst
+  logger.rst
diff --git a/source/manual/logic_nodes/basic/input/keyboard/key_code.rst b/source/manual/logic_nodes/basic/input/keyboard/key_code.rst
@@ -0,0 +1,23 @@
++++++++++++++++
+Key Code
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/key_code_node.png
+   :align: right
+   :width: 215
+   :alt: Key Code Node.
+
+The *Key Code* node retrieves a specified key's numeric code. This node is meant for
+debugging purposes.
+
+Inputs
+=======
+
+Key
+   The key to translate.
+
+Outputs
+=======
+
+Code
+   Integer code of the selected key.
diff --git a/source/manual/logic_nodes/basic/input/keyboard/key_down.rst b/source/manual/logic_nodes/basic/input/keyboard/key_down.rst
@@ -0,0 +1,28 @@
++++++++++++++++
+Key Down
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/key_down_node.png
+   :align: right
+   :width: 215
+   :alt: Key Down Node.
+
+The *Key Down* node detects if a specified key has been pressed.
+
+Inputs
+=======
+
+Key
+   The key to monitor.
+
+Parameters
+==========
+
+Mode
+   Toggle between *Once* and *Each Frame* modes.
+
+Outputs
+=======
+
+If Pressed
+   *True* if the key is active in the selected mode, else *False*
diff --git a/source/manual/logic_nodes/basic/input/keyboard/key_up.rst b/source/manual/logic_nodes/basic/input/keyboard/key_up.rst
@@ -0,0 +1,28 @@
++++++++++++++++
+Key Up
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/key_up_node.png
+   :align: right
+   :width: 215
+   :alt: Key Up Node.
+
+The *Key Up* node detects if a specified key has been released.
+
+Inputs
+=======
+
+Key
+   The key to monitor.
+
+Parameters
+==========
+
+Mode
+   Toggle between *Once* and *Each Frame* modes.
+
+Outputs
+=======
+
+If Pressed
+   *True* if the key is released in the selected mode, else *False*
diff --git a/source/manual/logic_nodes/basic/input/keyboard/keyboard_active.rst b/source/manual/logic_nodes/basic/input/keyboard/keyboard_active.rst
@@ -0,0 +1,16 @@
++++++++++++++++
+Keyboard Active
++++++++++++++++
+
+.. figure:: /images/Logic_Nodes/keyboard_active_node.png
+   :align: right
+   :width: 215
+   :alt: Keyboard Active Node.
+
+The *Keyboard Active* node detects any activity on the keyboard.
+
+Outputs
+=======
+
+Active
+   *True* keyboard state changed, else *False*