summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPieter-Jan Briers <pieterjan.briers@gmail.com>2018-03-18 13:41:25 +0100
committerPieter-Jan Briers <pieterjan.briers@gmail.com>2018-03-18 13:41:25 +0100
commit11aa330a6f4f1111d8b53abf4425f842f5bcae2b (patch)
tree26bf42a21d36416e18afa2cba546b4d985b70d15
parent760b0567a668c927820101d057ea8b4218943438 (diff)
Improve Input.is_action_just_* docs.
More clarification.
-rw-r--r--doc/classes/Input.xml5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml
index 5b2e019c4c..f3bff5a146 100644
--- a/doc/classes/Input.xml
+++ b/doc/classes/Input.xml
@@ -182,7 +182,8 @@
<argument index="0" name="action" type="String">
</argument>
<description>
- Returns [code]true[/code] when you start pressing the action event.
+ Returns [code]true[/code] when the user starts pressing the action event, meaning it's true only on the frame that the user pressed down the button.
+ This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed.
</description>
</method>
<method name="is_action_just_released" qualifiers="const">
@@ -191,7 +192,7 @@
<argument index="0" name="action" type="String">
</argument>
<description>
- Returns [code]true[/code] when you stop pressing the action event.
+ Returns [code]true[/code] when the user stops pressing the action event, meaning it's true only on the frame that the user released the button.
</description>
</method>
<method name="is_action_pressed" qualifiers="const">