diff options
| author | Poommetee Ketson <poommetee@protonmail.com> | 2018-03-19 08:34:59 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-19 08:34:59 +0700 |
| commit | fc4e7722864907a751e2b88d9d3e2e58d7f4004e (patch) | |
| tree | 11e6ade4df42a0ceadbebd2c91a3f31ab567921c /doc | |
| parent | 883afd1b4d6886676ceb2017caafae0c24df6c24 (diff) | |
| parent | 11aa330a6f4f1111d8b53abf4425f842f5bcae2b (diff) | |
Merge pull request #17606 from PJB3005/18-03-18-just-pressed-action-docs-update
Improve Input.is_action_just_* docs.
[ci skip]
Diffstat (limited to 'doc')
| -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 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"> |