From 9876bad05c9a037b7dd4ff7f2c981d1b20278e72 Mon Sep 17 00:00:00 2001 From: Olli Markkanen Date: Sat, 14 Oct 2017 12:30:41 +0300 Subject: [PATCH] [DOCS] Improve docs for is_action_just_pressed and is_action_just_released (#12081) --- doc/classes/Input.xml | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index e56200f63d7..d2d01dacb42 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -4,7 +4,7 @@ A Singleton that deals with inputs. - A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. + A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap]. @@ -75,7 +75,7 @@ - Returns the current value of the joypad axis at given index (see JOY_* constants in [@Global Scope]) + Returns the current value of the joypad axis at given index (see [code]JOY_*[/code] constants in [@Global Scope]) @@ -180,6 +180,7 @@ + Returns [code]true[/code] when you start pressing the action event. @@ -188,6 +189,7 @@ + Returns [code]true[/code] when you stop pressing the action event. @@ -196,7 +198,7 @@ - Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap]. + Returns [code]true[/code] if you are pressing the action event. @@ -207,7 +209,7 @@ - Returns if the joypad button at the given index is currently pressed. (see JOY_* constants in [@Global Scope]) + Returns [code]true[/code] if you are pressing the joypad button. (see [code]JOY_*[/code] constants in [@Global Scope]) @@ -216,7 +218,7 @@ - Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. + Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the [code]JOY_*[/code] constants (see [@Global Scope]). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. @@ -225,7 +227,7 @@ - Returns true or false depending on whether the key is pressed or not. You can pass KEY_*, which are pre-defined constants listed in [@Global Scope]. + Returns [code]true[/code] if you are pressing the key. You can pass [code]KEY_*[/code], which are pre-defined constants listed in [@Global Scope]. @@ -234,7 +236,7 @@ - Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON_*, which are pre-defined constants listed in [@Global Scope]. + Returns [code]true[/code] if you are pressing the mouse button. You can pass [code]BUTTON_*[/code], which are pre-defined constants listed in [@Global Scope].