diff --git a/source/images/Logic_Nodes/cursor_visibility_node.png b/source/images/Logic_Nodes/cursor_visibility_node.png new file mode 100644 index 00000000..4eb8cb2a Binary files /dev/null and b/source/images/Logic_Nodes/cursor_visibility_node.png differ diff --git a/source/images/Logic_Nodes/key_code_node.png b/source/images/Logic_Nodes/key_code_node.png new file mode 100644 index 00000000..d50790db Binary files /dev/null and b/source/images/Logic_Nodes/key_code_node.png differ diff --git a/source/images/Logic_Nodes/key_down_node.png b/source/images/Logic_Nodes/key_down_node.png new file mode 100644 index 00000000..9f28d001 Binary files /dev/null and b/source/images/Logic_Nodes/key_down_node.png differ diff --git a/source/images/Logic_Nodes/key_logger_node.png b/source/images/Logic_Nodes/key_logger_node.png new file mode 100644 index 00000000..d3cb9758 Binary files /dev/null and b/source/images/Logic_Nodes/key_logger_node.png differ diff --git a/source/images/Logic_Nodes/key_up_node.png b/source/images/Logic_Nodes/key_up_node.png new file mode 100644 index 00000000..64b17abd Binary files /dev/null and b/source/images/Logic_Nodes/key_up_node.png differ diff --git a/source/images/Logic_Nodes/keyboard_active_node.png b/source/images/Logic_Nodes/keyboard_active_node.png new file mode 100644 index 00000000..c22dd16f Binary files /dev/null and b/source/images/Logic_Nodes/keyboard_active_node.png differ diff --git a/source/images/Logic_Nodes/load_file_node.png b/source/images/Logic_Nodes/load_file_node.png new file mode 100644 index 00000000..d92a8f2c Binary files /dev/null and b/source/images/Logic_Nodes/load_file_node.png differ diff --git a/source/images/Logic_Nodes/load_game_node.png b/source/images/Logic_Nodes/load_game_node.png new file mode 100644 index 00000000..2adb915d Binary files /dev/null and b/source/images/Logic_Nodes/load_game_node.png differ diff --git a/source/images/Logic_Nodes/mouse_button_node.png b/source/images/Logic_Nodes/mouse_button_node.png new file mode 100644 index 00000000..d544ed6a Binary files /dev/null and b/source/images/Logic_Nodes/mouse_button_node.png differ diff --git a/source/images/Logic_Nodes/mouse_button_over_node.png b/source/images/Logic_Nodes/mouse_button_over_node.png new file mode 100644 index 00000000..20afe12e Binary files /dev/null and b/source/images/Logic_Nodes/mouse_button_over_node.png differ diff --git a/source/images/Logic_Nodes/mouse_button_up_node.png b/source/images/Logic_Nodes/mouse_button_up_node.png new file mode 100644 index 00000000..42f43c48 Binary files /dev/null and b/source/images/Logic_Nodes/mouse_button_up_node.png differ diff --git a/source/images/Logic_Nodes/mouse_look_node.png b/source/images/Logic_Nodes/mouse_look_node.png new file mode 100644 index 00000000..16644c50 Binary files /dev/null and b/source/images/Logic_Nodes/mouse_look_node.png differ diff --git a/source/images/Logic_Nodes/mouse_moved_node.png b/source/images/Logic_Nodes/mouse_moved_node.png new file mode 100644 index 00000000..aa4eb591 Binary files /dev/null and b/source/images/Logic_Nodes/mouse_moved_node.png differ diff --git a/source/images/Logic_Nodes/mouse_over_node.png b/source/images/Logic_Nodes/mouse_over_node.png new file mode 100644 index 00000000..5e010d22 Binary files /dev/null and b/source/images/Logic_Nodes/mouse_over_node.png differ diff --git a/source/images/Logic_Nodes/mouse_set_position_node.png b/source/images/Logic_Nodes/mouse_set_position_node.png new file mode 100644 index 00000000..ecbd6fde Binary files /dev/null and b/source/images/Logic_Nodes/mouse_set_position_node.png differ diff --git a/source/images/Logic_Nodes/mouse_status_node.png b/source/images/Logic_Nodes/mouse_status_node.png new file mode 100644 index 00000000..ed9aaeeb Binary files /dev/null and b/source/images/Logic_Nodes/mouse_status_node.png differ diff --git a/source/images/Logic_Nodes/mouse_wheel_node.png b/source/images/Logic_Nodes/mouse_wheel_node.png new file mode 100644 index 00000000..b7d6cc8b Binary files /dev/null and b/source/images/Logic_Nodes/mouse_wheel_node.png differ diff --git a/source/images/Logic_Nodes/quit_game_node.png b/source/images/Logic_Nodes/quit_game_node.png new file mode 100644 index 00000000..5ddd5a29 Binary files /dev/null and b/source/images/Logic_Nodes/quit_game_node.png differ diff --git a/source/images/Logic_Nodes/restart_game_node.png b/source/images/Logic_Nodes/restart_game_node.png new file mode 100644 index 00000000..71bc81b2 Binary files /dev/null and b/source/images/Logic_Nodes/restart_game_node.png differ diff --git a/source/images/Logic_Nodes/save_game_node.png b/source/images/Logic_Nodes/save_game_node.png new file mode 100644 index 00000000..747a9ec8 Binary files /dev/null and b/source/images/Logic_Nodes/save_game_node.png differ diff --git a/source/manual/logic_nodes/basic/events/custom/catch.rst b/source/manual/logic_nodes/basic/events/custom/catch.rst index cdc54b14..acde63d3 100644 --- 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 index b6b4f5b2..d75efdbd 100644 --- 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 index f7d27571..72de5657 100644 --- 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 index 6a9703c8..999f849c 100644 --- 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 index e146e59c..55258cfb 100644 --- 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 index c6b8e6eb..0a22bed6 100644 --- 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 index 8f260547..09ff0e1b 100644 --- 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 index ba22f584..f4d92433 100644 --- 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 index 85618e6c..4035bb85 100644 --- 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 index fac20464..c64ebd66 100644 --- 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 index 8b137891..da4f432b 100644 --- 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 index 8b137891..8677bc07 100644 --- 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 index 8b137891..13a2e521 100644 --- 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 index 8b137891..f205a151 100644 --- 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 index 8b137891..07512940 100644 --- 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 index c2740b48..3486c9d0 100644 --- 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 index 8b137891..0b1b1d76 100644 --- 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 new file mode 100644 index 00000000..3a45c864 --- /dev/null +++ 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 new file mode 100644 index 00000000..d734c50b --- /dev/null +++ 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 new file mode 100644 index 00000000..16da182b --- /dev/null +++ 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 new file mode 100644 index 00000000..a04e973a --- /dev/null +++ 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* diff --git a/source/manual/logic_nodes/basic/input/keyboard/logger.rst b/source/manual/logic_nodes/basic/input/keyboard/logger.rst new file mode 100644 index 00000000..9ad35860 --- /dev/null +++ b/source/manual/logic_nodes/basic/input/keyboard/logger.rst @@ -0,0 +1,34 @@ ++++++++++++++++ +Logger ++++++++++++++++ + +.. figure:: /images/Logic_Nodes/key_logger_node.png + :align: right + :width: 215 + :alt: Key Logger Node. + +The Keyboard -> *Logger* node records keyboard activity. + +Inputs +======= + +Condition + Input condition. + +Parameters +========== + +Mode + Toggle between *Key Tap* and *Key Down* modes. + +Outputs +======= + +Done + *True* if the node performed successfully, else *False*. + +Key Code + Integer code of the recorded key. + +Logged Char + Letter representation of the recorded key. diff --git a/source/manual/logic_nodes/basic/input/mouse/button.rst b/source/manual/logic_nodes/basic/input/mouse/button.rst index 8b137891..c972fa37 100644 --- a/source/manual/logic_nodes/basic/input/mouse/button.rst +++ b/source/manual/logic_nodes/basic/input/mouse/button.rst @@ -1 +1,28 @@ ++++++++++++++++ +Button ++++++++++++++++ +.. figure:: /images/Logic_Nodes/mouse_button_node.png + :align: right + :width: 215 + :alt: Mouse Button Node. + +The Mouse -> *Button* node detects mouse button activity. + +Inputs +======= + +Button ID + The button to monitor. + +Parameters +========== + +Mode + Toggle between *Once* and *Each Frame* modes. + +Outputs +======= + +If Pressed + *True* if the corresponding button is pressed, else *False* diff --git a/source/manual/logic_nodes/basic/input/mouse/button_over.rst b/source/manual/logic_nodes/basic/input/mouse/button_over.rst index 8b137891..3bd936f9 100644 --- a/source/manual/logic_nodes/basic/input/mouse/button_over.rst +++ b/source/manual/logic_nodes/basic/input/mouse/button_over.rst @@ -1 +1,26 @@ ++++++++++++++++ +Button Over ++++++++++++++++ + +.. figure:: /images/Logic_Nodes/mouse_button_over_node.png + :align: right + :width: 215 + :alt: Mouse Button Over Node. + +The Mouse -> *Button Over* node detects mouse button activity in relation to a specified object. + +Inputs +======= + +Button ID + The button to monitor. + +Object + Only count mouse activity if cursor is over this object. + +Outputs +======= + +When Pressed On + *True* if the corresponding button is pressed, else *False* diff --git a/source/manual/logic_nodes/basic/input/mouse/button_up.rst b/source/manual/logic_nodes/basic/input/mouse/button_up.rst index 8b137891..9bcda2a3 100644 --- a/source/manual/logic_nodes/basic/input/mouse/button_up.rst +++ b/source/manual/logic_nodes/basic/input/mouse/button_up.rst @@ -1 +1,30 @@ + ++++++++++++++++ +Button Up ++++++++++++++++ + +.. figure:: /images/Logic_Nodes/mouse_button_up_node.png + :align: right + :width: 215 + :alt: Mouse Button Up Node. + +The Mouse -> *Button Up* node detects mouse button activity. + +Inputs +======= + +Button ID + The button to monitor. + +Parameters +========== + +Mode + Toggle between *Once* and *Each Frame* modes. + +Outputs +======= + +If Released + *True* if the corresponding button is releasedd, else *False* diff --git a/source/manual/logic_nodes/basic/input/mouse/cursor_visibility.rst b/source/manual/logic_nodes/basic/input/mouse/cursor_visibility.rst index 8b137891..a386a107 100644 --- a/source/manual/logic_nodes/basic/input/mouse/cursor_visibility.rst +++ b/source/manual/logic_nodes/basic/input/mouse/cursor_visibility.rst @@ -1 +1,25 @@ ++++++++++++++++ +Cursor Visibility ++++++++++++++++ +.. figure:: /images/Logic_Nodes/cursor_visibility_node.png + :align: right + :width: 215 + :alt: Cursor Visibility Node. + +The *Cursor Visibility* node is used to set the visibility status of the system mouse cursor. + +Inputs +======= + +Condition + Input Condition. + +Visible + Target state for the system cursor. + +Outputs +======= + +Done + *True* if the node performed successfully, else *False* diff --git a/source/manual/logic_nodes/basic/input/mouse/look.rst b/source/manual/logic_nodes/basic/input/mouse/look.rst index 8b137891..f50f1fc3 100644 --- a/source/manual/logic_nodes/basic/input/mouse/look.rst +++ b/source/manual/logic_nodes/basic/input/mouse/look.rst @@ -1 +1,59 @@ ++++++++++++++++ +Mouse Look ++++++++++++++++ +.. figure:: /images/Logic_Nodes/mouse_look_node.png + :align: right + :width: 215 + :alt: Mouse Look Node. + +The *Mouse Look* node is a quick way to make objects follow the mouse 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. + +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 + Option to invert movement for each axis (Vec2). + +Sensitivity + Multiplier for translating mouse movement to object rotation. + +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). + +Smoothing + Use linear interpolation to slowly adapt the object transformation to mouse movement. + +Parameters +========== + +Front + The look direction of the Head Object. If set to Y, the rotational axis will be X and vice versa. + +Outputs +======= + +Done + *True* if the node performed successfully, else *False* diff --git a/source/manual/logic_nodes/basic/input/mouse/moved.rst b/source/manual/logic_nodes/basic/input/mouse/moved.rst index 8b137891..70d17024 100644 --- a/source/manual/logic_nodes/basic/input/mouse/moved.rst +++ b/source/manual/logic_nodes/basic/input/mouse/moved.rst @@ -1 +1,23 @@ ++++++++++++++++ +Moved ++++++++++++++++ + +.. figure:: /images/Logic_Nodes/mouse_moved_node.png + :align: right + :width: 215 + :alt: Mouse Moved Node. + +The Mouse -> *Moved* node detects mouse movement. + +Parameters +========== + +Mode + Toggle between *Once* and *Each Frame* modes. + +Outputs +======= + +If Moved + *True* if mouse movement is detected, else *False* diff --git a/source/manual/logic_nodes/basic/input/mouse/over.rst b/source/manual/logic_nodes/basic/input/mouse/over.rst index 8b137891..1382670e 100644 --- a/source/manual/logic_nodes/basic/input/mouse/over.rst +++ b/source/manual/logic_nodes/basic/input/mouse/over.rst @@ -1 +1,33 @@ ++++++++++++++++ +Over ++++++++++++++++ +.. figure:: /images/Logic_Nodes/mouse_over_node.png + :align: right + :alt: Mouse Over Node. + +The Mouse -> *Over* node matches the mouse position to an object on screen. + +Inputs +========== + +Object + The object to monitor. + +Outputs +======= + +On Mouse Enter + *True* on the first frame the mouse position matches the object bounds, else *False* + +On Mouse Over + *True* while the mouse position matches the object bounds, else *False* + +On Mouse Exit + *True* on the first frame the mouse position leaves the object bounds, else *False* + +Point + World Position of the mouse cursor matched to the object (Vec3). + +Normal + Face normal of the targeted mesh face (Vec3). diff --git a/source/manual/logic_nodes/basic/input/mouse/set_position.rst b/source/manual/logic_nodes/basic/input/mouse/set_position.rst index 8b137891..49aad71c 100644 --- a/source/manual/logic_nodes/basic/input/mouse/set_position.rst +++ b/source/manual/logic_nodes/basic/input/mouse/set_position.rst @@ -1 +1,29 @@ ++++++++++++++++ +Set Position ++++++++++++++++ +.. figure:: /images/Logic_Nodes/mouse_set_position_node.png + :align: right + :width: 215 + :alt: Mouse Set Position Node. + +The Mouse -> *Set Position* node places the mouse cursor on corresponding coordinates +between (0, 0) and (1, 1) on the screen. + +Inputs +========== + +Condition + Input Condition. + +Screen X + X (horizontal) cursor position between 0 and 1. + +Screen Y + Y (vertical) cursor position between 0 and 1. + +Outputs +======= + +Done + *True* if the node performed successfully, else *False* diff --git a/source/manual/logic_nodes/basic/input/mouse/status.rst b/source/manual/logic_nodes/basic/input/mouse/status.rst index 8b137891..7e89938b 100644 --- a/source/manual/logic_nodes/basic/input/mouse/status.rst +++ b/source/manual/logic_nodes/basic/input/mouse/status.rst @@ -1 +1,35 @@ ++++++++++++++++ +Mouse Status ++++++++++++++++ + +.. figure:: /images/Logic_Nodes/mouse_status_node.png + :align: right + :width: 215 + :alt: Mouse Status Node. + +The *Mouse Status* node contains information about the mouse. + +Outputs +======= + +Position + Screen position of the mouse cursor (Vec2). + +Movement + Difference of the mouse position in comparison to the frame before. + +X Position + Horizontal position of the mouse cursor + +Y Position + Vertical position of the mouse cursor + +X Movement + Difference of the horizontal mouse position in comparison to the frame before. + +Y Movement + Difference of the vertical mouse position in comparison to the frame before. + +Wheel Difference + Scrolling direction. -1 for down, 1 for up, idle is 0. diff --git a/source/manual/logic_nodes/basic/input/mouse/wheel.rst b/source/manual/logic_nodes/basic/input/mouse/wheel.rst index 8b137891..b26536aa 100644 --- a/source/manual/logic_nodes/basic/input/mouse/wheel.rst +++ b/source/manual/logic_nodes/basic/input/mouse/wheel.rst @@ -1 +1,22 @@ ++++++++++++++++ +Wheel ++++++++++++++++ +.. figure:: /images/Logic_Nodes/mouse_wheel_node.png + :align: right + :width: 215 + :alt: Mouse Wheel Node. + +The Mouse -> *Wheel* node detects changes in the mouse wheel status. + +Inputs +======= + +Mode + Change between *Up*, *Down* or *Up and Down* modes. + +Outputs +======= + +Position + Screen position of the mouse cursor (Vec2).