Pārlūkot izejas kodu

[DOCS] Improve docs for is_action_just_pressed and is_action_just_released (#12081)

Olli Markkanen 8 gadi atpakaļ
vecāks
revīzija
9876bad05c
1 mainītis faili ar 9 papildinājumiem un 7 dzēšanām
  1. 9 7
      doc/classes/Input.xml

+ 9 - 7
doc/classes/Input.xml

@@ -4,7 +4,7 @@
 		A Singleton that deals with inputs.
 		A Singleton that deals with inputs.
 	</brief_description>
 	</brief_description>
 	<description>
 	<description>
-		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].
 	</description>
 	</description>
 	<tutorials>
 	<tutorials>
 	</tutorials>
 	</tutorials>
@@ -75,7 +75,7 @@
 			<argument index="1" name="axis" type="int">
 			<argument index="1" name="axis" type="int">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				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])
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="get_joy_axis_index_from_string">
 		<method name="get_joy_axis_index_from_string">
@@ -180,6 +180,7 @@
 			<argument index="0" name="action" type="String">
 			<argument index="0" name="action" type="String">
 			</argument>
 			</argument>
 			<description>
 			<description>
+				Returns [code]true[/code] when you start pressing the action event.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="is_action_just_released" qualifiers="const">
 		<method name="is_action_just_released" qualifiers="const">
@@ -188,6 +189,7 @@
 			<argument index="0" name="action" type="String">
 			<argument index="0" name="action" type="String">
 			</argument>
 			</argument>
 			<description>
 			<description>
+				Returns [code]true[/code] when you stop pressing the action event.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="is_action_pressed" qualifiers="const">
 		<method name="is_action_pressed" qualifiers="const">
@@ -196,7 +198,7 @@
 			<argument index="0" name="action" type="String">
 			<argument index="0" name="action" type="String">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				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.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="is_joy_button_pressed" qualifiers="const">
 		<method name="is_joy_button_pressed" qualifiers="const">
@@ -207,7 +209,7 @@
 			<argument index="1" name="button" type="int">
 			<argument index="1" name="button" type="int">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				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])
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="is_joy_known">
 		<method name="is_joy_known">
@@ -216,7 +218,7 @@
 			<argument index="0" name="device" type="int">
 			<argument index="0" name="device" type="int">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				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.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="is_key_pressed" qualifiers="const">
 		<method name="is_key_pressed" qualifiers="const">
@@ -225,7 +227,7 @@
 			<argument index="0" name="scancode" type="int">
 			<argument index="0" name="scancode" type="int">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				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].
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="is_mouse_button_pressed" qualifiers="const">
 		<method name="is_mouse_button_pressed" qualifiers="const">
@@ -234,7 +236,7 @@
 			<argument index="0" name="button" type="int">
 			<argument index="0" name="button" type="int">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				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].
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="joy_connection_changed">
 		<method name="joy_connection_changed">