summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-03-26 13:45:35 +0100
committerRémi Verschelde <rverschelde@gmail.com>2024-03-26 13:45:35 +0100
commitcff7de077bb4f473c4e63e4762ea244ab66095b5 (patch)
tree9547b4e5b4055cdfca37aaaf0b80961af0b6a7ca
parenta0d464ae19f4f5c2e80823ffba05aa22c38e2eda (diff)
parent9a439b246a875e50fe5e911182e935945f2990cb (diff)
downloadredot-engine-cff7de077bb4f473c4e63e4762ea244ab66095b5.tar.gz
Merge pull request #89838 from Chronos-W/update-shortcut-input-method-doc
Add reference to InputEventJoypadButton in `_shortcut_input` doc
-rw-r--r--doc/classes/Node.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index 1ddcdce439..e6fdd229bf 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -100,7 +100,7 @@
<return type="void" />
<param index="0" name="event" type="InputEvent" />
<description>
- Called when an [InputEventKey] or [InputEventShortcut] hasn't been consumed by [method _input] or any GUI [Control] item. It is called before [method _unhandled_key_input] and [method _unhandled_input]. The input event propagates up through the node tree until a node consumes it.
+ Called when an [InputEventKey], [InputEventShortcut], or [InputEventJoypadButton] hasn't been consumed by [method _input] or any GUI [Control] item. It is called before [method _unhandled_key_input] and [method _unhandled_input]. The input event propagates up through the node tree until a node consumes it.
It is only called if shortcut processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_shortcut_input].
To consume the input event and stop it propagating further to other nodes, [method Viewport.set_input_as_handled] can be called.
This method can be used to handle shortcuts. For generic GUI events, use [method _input] instead. Gameplay events should usually be handled with either [method _unhandled_input] or [method _unhandled_key_input].