diff options
| author | Pieter-Jan Briers | 2018-03-18 13:41:25 +0100 |
|---|---|---|
| committer | Hein-Pieter van Braam | 2018-04-29 14:24:52 +0200 |
| commit | f12db4013e211199eb9203540c2018e5a7c3834e (patch) | |
| tree | d0959808606b8b3f157e41dd541276652ce1c3a5 | |
| parent | e53f01a7afe5d47266510e525af142c5418334cd (diff) | |
| download | godot-f12db4013e211199eb9203540c2018e5a7c3834e.tar.gz godot-f12db4013e211199eb9203540c2018e5a7c3834e.tar.zst godot-f12db4013e211199eb9203540c2018e5a7c3834e.zip | |
Improve Input.is_action_just_* docs.
More clarification.
(cherry picked from commit 11aa330a6f4f1111d8b53abf4425f842f5bcae2b)
| -rw-r--r-- | doc/classes/Input.xml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 49c1dd603..e0bc444bb 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"> |