Andrew/redot-engine
1
0
Fork 0
mirror of https://github.com/Redot-Engine/redot-engine.git synced 2025-12-06 15:21:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #76874 from AThousandShips/input_doc

Browse Source 
Clarify that event handling does not affect `Input`
This commit is contained in:
Rémi Verschelde
2023-05-09 17:44:56 +02:00
parent e56427b4f5 732ad382a6
commit b0b23082c4
3 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/classes/Control.xml
View File

@@ -217,6 +217,7 @@
<return type="void" /> <return type="void" />
<description> <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]. 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> </description>
</method> </method>
<method name="add_theme_color_override"> <method name="add_theme_color_override">

1
doc/classes/Input.xml
View File

@@ -5,6 +5,7 @@
</brief_description> </brief_description>
<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. 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> </description>
<tutorials> <tutorials>
<link title="Inputs documentation index">$DOCS_URL/tutorials/inputs/index.html</link> <link title="Inputs documentation index">$DOCS_URL/tutorials/inputs/index.html</link>

1
doc/classes/Viewport.xml
View File

@@ -201,6 +201,7 @@
<return type="void" /> <return type="void" />
<description> <description>
Stops the input from propagating further down the [SceneTree]. 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> </description>
</method> </method>
<method name="set_positional_shadow_atlas_quadrant_subdiv"> <method name="set_positional_shadow_atlas_quadrant_subdiv">