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.xml9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml
index 48a6804290..7b6fc3f216 100644
--- a/doc/classes/InputEventKey.xml
+++ b/doc/classes/InputEventKey.xml
@@ -24,6 +24,12 @@
Returns a [String] representation of the event's [member keycode] and modifiers.
</description>
</method>
+ <method name="as_text_location" qualifiers="const">
+ <return type="String" />
+ <description>
+ Returns a [String] representation of the event's [member location]. This will be a blank string if the event is not specific to a location.
+ </description>
+ </method>
<method name="as_text_physical_keycode" qualifiers="const">
<return type="String" />
<description>
@@ -77,6 +83,9 @@
+-----+ +-----+
[/codeblock]
</member>
+ <member name="location" type="int" setter="set_location" getter="get_location" enum="KeyLocation" default="0">
+ Represents the location of a key which has both left and right versions, such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd].
+ </member>
<member name="physical_keycode" type="int" setter="set_physical_keycode" getter="get_physical_keycode" enum="Key" default="0">
Represents the physical location of a key on the 101/102-key US QWERTY keyboard, which corresponds to one of the [enum Key] constants.
To get a human-readable representation of the [InputEventKey], use [method OS.get_keycode_string] in combination with [method DisplayServer.keyboard_get_keycode_from_physical]: