summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNinni Pipping <over999ships@gmail.com>2023-05-09 10:25:07 +0200
committerRĂ©mi Verschelde <rverschelde@gmail.com>2023-05-12 12:14:45 +0200
commit9a5af8e7936ed5cfd4664455a88a3ecdae197783 (patch)
treed38704228da6acc0b931811984a707a41bb71478 /doc
parent28012c40fb5d86d6d5fc4fa4c8ab71b726ec520c (diff)
Clarify that event handling does not affect `Input`
(cherry picked from commit 732ad382a64e983c002a640f0220135835bab354)
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Control.xml1
-rw-r--r--doc/classes/Input.xml1
-rw-r--r--doc/classes/Viewport.xml1
3 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml
index a4b5764c3b..4996c6fe01 100644
--- a/doc/classes/Control.xml
+++ b/doc/classes/Control.xml
@@ -209,6 +209,7 @@
<return type="void" />
<description>
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.
</description>
</method>
<method name="add_theme_color_override">
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml
index ab9ed47b85..58d3f6dc66 100644
--- a/doc/classes/Input.xml
+++ b/doc/classes/Input.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
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 &gt; 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].
</description>
<tutorials>
<link title="Inputs documentation index">$DOCS_URL/tutorials/inputs/index.html</link>
diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml
index 35253dc9ef..62413581a9 100644
--- a/doc/classes/Viewport.xml
+++ b/doc/classes/Viewport.xml
@@ -197,6 +197,7 @@
<return type="void" />
<description>
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.
</description>
</method>
<method name="set_positional_shadow_atlas_quadrant_subdiv">