Merge pull request #49 from xavco63/master

Some addition and correction to the logic nodes docs

README.md

@@ -61,4 +61,5 @@ manuals that are pointed out above.
 - Ulysse Martin (youle31)
 - Xavier Cho (mysticfall)
 - (aum7)
+- Zazoucoco0 (xavco63)
 - You!

source/manual/logic_nodes/events/on_init.rst

@@ -15,4 +15,4 @@ Outputs
 ++++++++++++++++++++++++++++++
 
 Out
-   *True* if node performed successfully, else *False*.
+   *True* on the first frame, when the scene is initialized

source/manual/logic_nodes/events/on_value_changed.rst

@@ -15,7 +15,7 @@ Parameters
 ++++++++++++++++++++++++++++++
 
 Initialize
-   todo
+   If checked, the node will ignore the change from *None* to the first value pulled from the input socket
 
 Inputs
 ++++++++++++++++++++++++++++++

source/manual/logic_nodes/game/load_game.rst

@@ -21,7 +21,7 @@ Inputs
 ++++++++++++++++++++++++++++++
 
 Condition
-   Input condition.
+   The condition for this node to activate.
 
 Slot
    Index of this save file.

source/manual/logic_nodes/game/quit_game.rst

@@ -15,4 +15,4 @@ Inputs
 ++++++++++++++++++++++++++++++
 
 Condition
-   Input condition which must be fulfilled for node to activate.
+   The condition for this node to activate.

source/manual/logic_nodes/game/restart_game.rst

@@ -15,7 +15,7 @@ Inputs
 ++++++++++++++++++++++++++++++
 
 Condition
-   Input condition required for node to activate.
+   The condition for this node to activate.
 
 Outputs
 ++++++++++++++++++++++++++++++

source/manual/logic_nodes/game/save_game.rst

@@ -21,10 +21,10 @@ Inputs
 ++++++++++++++++++++++++++++++
 
 Condition
-   Input condition required for node to activate.
+   The condition for this node to activate.
 
 Slot
-   Index of this save file.
+   Index of this save file. If a save file already exists at this index, it will be overwritten.
 
 Outputs
 ++++++++++++++++++++++++++++++

source/manual/logic_nodes/input/gamepad/gamepad_button.rst

@@ -18,7 +18,8 @@ Button
    Which button/trigger is monitored.
 
 Input Type
-   Input detection mode.
+   Input detection mode. ``Tap`` is activated the first frame that the key is pressed, ``Down`` 
+   is activated while the key is pressed and ``Up`` is activated once the last frame the key is pressed.
 
 Inputs
 ++++++++++++++++++++++++++++++

source/manual/logic_nodes/input/gamepad/gamepad_look.rst

@@ -38,7 +38,7 @@ Index
    The index of the controller to poll.
 
 Sensitivity
-   Multiplier for translating mouse movement to object rotation.
+   Multiplier for translating controller stick movement to object rotation.
 
 Exponent
    Exponent for fine-tuning the stick behavior.
@@ -53,10 +53,10 @@ Cap Up/Down
    Limit the head object rotation on its local X/Y axis.
 
 Y Limits
-   Limits for the head object's local X/Y rotaion (Vec2). Visible if Cap Up/Down is selected.
+   Limits for the head object local X/Y rotation (Vec2). Visible if Cap Up/Down is selected.
 
 Threshold
-   Ignore stick values under this threshold.
+   Ignore stick values under this threshold. Used to avoid stick drift.
 
 Outputs
 ++++++++++++++++++++++++++++++

source/manual/logic_nodes/input/gamepad/gamepad_sticks.rst

@@ -30,10 +30,10 @@ Sensitivity
    Multiplier for the axis values.
 
 Threshold
-   Dead-zone for the stick.
+   Dead-zone for the stick. Used to avoid stick drift.
 
 Outputs
 ++++++++++++++++++++++++++++++
 
 Vector
-   Stick values as vector `(X, Y, 0)`.
+   Stick values as vector `(X, Y, 0)` (Vector3).

source/manual/logic_nodes/input/gamepad/gamepad_vibrate.rst

@@ -27,7 +27,7 @@ Right
    Force with which to rotate the weight in the right handle.
 
 Time
-   Vibrate for this many seconds.
+   How many seconds the vibration has to play.
 
 Outputs
 ++++++++++++++++++++++++++++++

source/manual/logic_nodes/input/keyboard/keyboard_key.rst

@@ -15,7 +15,8 @@ Parameters
 ++++++++++++++++++++++++++++++
 
 Input Type
-   Input detection mode.
+   Input detection mode. ``Tap`` is activated the first frame that the key is pressed, ``Down`` 
+   is activated while the key is pressed (even the first frame) and ``Up`` is activated once the last frame the key is pressed.
 
 Inputs
 ++++++++++++++++++++++++++++++

source/manual/logic_nodes/input/mouse/mouse_look.rst

@@ -20,7 +20,7 @@ Front
    Look direction of the *Head* Object. If set to Y, the rotational axis will be X and vice versa.
 
 Center Mouse
-   todo
+   If checked, the mouse cursor will be centered in the game window.
 
 Inputs
 ++++++++++++++++++++++++++++++
@@ -44,13 +44,13 @@ Cap Left/Right
    Limit the body objects rotation on its local Z axis.
 
 X Limits
-   The limits for the body objects local Z rotation (Vector2). Only shown if Cap Left/Right is selected.
+   The limits for the body object's local Z rotation (Vector2). Only shown if Cap Left/Right is selected.
 
 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 (Vectpr2). Only shown if Cap Up/Down is selected.
+   The limits for the head object's local X/Y rotation (Vector2). Only shown if Cap Up/Down is selected.
 
 Smoothing
    Use linear interpolation to slowly adapt the object transformation to mouse movement.

source/manual/logic_nodes/input/mouse/mouse_status.rst

@@ -9,26 +9,28 @@
 Mouse Status
 ==============================
 
+Gives informations about the mouse cursor and wheel scroll.
+
 Outputs
 ++++++++++++++++++++++++++++++
 
 Position
-   todo
+   The XY position of the cursor from the top left corner of the game window (Vector2).
 
 Movement
-  todo
+  The XY movement of the cursor on the game window comparing to previous frame position (Vector2).
 
 X Position
-  todo
+  The X position of the cursor from the top left corner of the game window.
 
 Y Position
-   todo
+   The Y position of the cursor from the top left corner of the game window.
 
 X Movement
-   todo
+   The X movement of the cursor on the game window compared to previous frame position.
 
 Y Movement
-   todo
+   The Y movement of the cursor on the game window compared to previous frame position.
 
 Wheel Difference
-   todo
+   *1* if the wheel is scrolled up and *-1* if the wheel is scrolled down, else *0*.

source/manual/logic_nodes/input/mouse/set_cursor_position.rst

@@ -9,13 +9,13 @@
 Set Cursor Position
 ==============================
 
-Places the mouse cursor on corresponding coordinates between (0, 0) and (1, 1) on the screen.
+Places the mouse cursor on corresponding coordinates between (0, 0) and (1, 1) on the game window from the top left corner.
 
 Inputs
 ++++++++++++++++++++++++++++++
 
 Condition
-   Input condition.
+   Input condition needed for node to activate.
 
 Screen X
    Horizontal cursor position between 0 and 1.