diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-01-25 21:52:35 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-25 21:52:35 +0100 |
| commit | 8896ce1c0a0bfdae7a188c2a75021a32b6ec0009 (patch) | |
| tree | c522102b96c67f3be7a52f60960e82841b260766 | |
| parent | a7f7c393bae2239c9f033f753de82e2a580c5d18 (diff) | |
| parent | 7a0c37c3f5c8e62d77a7d316babe019a0ab79a3d (diff) | |
Merge pull request #35559 from Calinou/doc-inputeventkey-string
Document how to get a human-readable string from an InputEventKey
| -rw-r--r-- | doc/classes/InputEventKey.xml | 6 | ||||
| -rw-r--r-- | doc/classes/OS.xml | 1 |
2 files changed, 5 insertions, 2 deletions
diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index cf9faaa26d..ee14be9e63 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -15,6 +15,7 @@ </return> <description> Returns the scancode combined with modifier keys such as [code]Shift[/code] or [code]Alt[/code]. See also [InputEventWithModifiers]. + To get a human-readable representation of the [InputEventKey] with modifiers, use [code]OS.get_scancode_string(event.get_scancode_with_modifiers())[/code] where [code]event[/code] is the [InputEventKey]. </description> </method> </methods> @@ -26,10 +27,11 @@ If [code]true[/code], the key's state is pressed. If [code]false[/code], the key's state is released. </member> <member name="scancode" type="int" setter="set_scancode" getter="get_scancode" default="0"> - Key scancode, one of the [enum KeyList] constants. + The key scancode, which corresponds to one of the [enum KeyList] constants. + To get a human-readable representation of the [InputEventKey], use [code]OS.get_scancode_string(event.scancode)[/code] where [code]event[/code] is the [InputEventKey]. </member> <member name="unicode" type="int" setter="set_unicode" getter="get_unicode" default="0"> - Key Unicode identifier when relevant. Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information. + The key Unicode identifier (when relevant). Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information. </member> </members> <constants> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index a37fb28901..d2dec9d5e7 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -333,6 +333,7 @@ </argument> <description> Returns the given scancode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). + See also [member InputEventKey.scancode] and [method InputEventKey.get_scancode_with_modifiers]. </description> </method> <method name="get_screen_count" qualifiers="const"> |