From 06cc39ad919b2f71e473105210134a7b5c706ebc Mon Sep 17 00:00:00 2001 From: lawnjelly Date: Sat, 28 Sep 2024 07:15:31 +0100 Subject: [PATCH] Document that `Input.is_action` should not be used during input-handling In most cases `InputEvent.is_action*` is more appropriate during input-handling. --- doc/classes/Input.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index b04f417ec..44f37f640 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -211,6 +211,7 @@ If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. [b]Note:[/b] Returning [code]true[/code] does not imply that the action is [i]still[/i] pressed. An action can be pressed and released again rapidly, and [code]true[/code] will still be returned so as not to miss input. [b]Note:[/b] Due to keyboard ghosting, [method is_action_just_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. + [b]Note:[/b] During input handling (e.g. [method Node._input]), use [method InputEvent.is_action_pressed] instead to query the action state of the current event. @@ -221,6 +222,7 @@ Returns [code]true[/code] when the user [i]stops[/i] pressing the action event in the current frame or physics tick. It will only return [code]true[/code] on the frame or tick that the user releases the button. If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. [b]Note:[/b] Returning [code]true[/code] does not imply that the action is [i]still[/i] not pressed. An action can be released and pressed again rapidly, and [code]true[/code] will still be returned so as not to miss input. + [b]Note:[/b] During input handling (e.g. [method Node._input]), use [method InputEvent.is_action_released] instead to query the action state of the current event.