From 732ad382a64e983c002a640f0220135835bab354 Mon Sep 17 00:00:00 2001 From: Ninni Pipping Date: Tue, 9 May 2023 10:25:07 +0200 Subject: [PATCH] Clarify that event handling does not affect `Input` --- doc/classes/Control.xml | 1 + doc/classes/Input.xml | 1 + doc/classes/Viewport.xml | 1 + 3 files changed, 3 insertions(+) diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index a52cdf72074..9a34bc4f994 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -217,6 +217,7 @@ Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to [method Node._unhandled_input] or [method Node._unhandled_key_input]. + [b]Note:[/b] This does not affect the methods in [Input], only the way events are propagated. diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index ecc9c3d89a0..5250b7a3235 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -5,6 +5,7 @@ A singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the [b]Input Map[/b] tab in the [b]Project > Project Settings[/b], or with the [InputMap] class. + [b]Note:[/b] The methods here reflect the global input state and are not affected by [method Control.accept_event] or [method Viewport.set_input_as_handled], which only deal with the way input is propagated in the [SceneTree]. $DOCS_URL/tutorials/inputs/index.html diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 81838f397fb..11d1fa2f301 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -197,6 +197,7 @@ Stops the input from propagating further down the [SceneTree]. + [b]Note:[/b] This does not affect the methods in [Input], only the way events are propagated.