summaryrefslogtreecommitdiffstats
path: root/doc/classes/InputEventKey.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/InputEventKey.xml')
-rw-r--r--doc/classes/InputEventKey.xml5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml
index dc4872ba03..69c447ba01 100644
--- a/doc/classes/InputEventKey.xml
+++ b/doc/classes/InputEventKey.xml
@@ -59,8 +59,9 @@
</method>
</methods>
<members>
- <member name="echo" type="bool" setter="set_echo" getter="is_echo" default="false">
- If [code]true[/code], the key was already pressed before this event. It means the user is holding the key down.
+ <member name="echo" type="bool" setter="set_echo" getter="is_echo" default="false" keywords="repeat">
+ If [code]true[/code], the key was already pressed before this event. An echo event is a repeated key event sent when the user is holding down the key.
+ [b]Note:[/b] The rate at which echo events are sent is typically around 20 events per second (after holding down the key for roughly half a second). However, the key repeat delay/speed can be changed by the user or disabled entirely in the operating system settings. To ensure your project works correctly on all configurations, do not assume the user has a specific key repeat configuration in your project's behavior.
</member>
<member name="key_label" type="int" setter="set_key_label" getter="get_key_label" enum="Key" default="0">
Represents the localized label printed on the key in the current keyboard layout, which corresponds to one of the [enum Key] constants or any valid Unicode character.