KeyboardKeyConfig
Inherits: Resource
Defines a single key configuration for the on-screen keyboard
Description
A key configuration is one key that is part of a KeyboardLayout which defines the type of key it is.
Properties
| Type | Name | Default |
|---|---|---|
| int | type | 0 |
| InputEventKey | input | |
| InputEventKey | mode_shift_input | |
| Texture2D | icon | |
| float | stretch_ratio | 1.0 |
| int | action | 0 |
Methods
| Returns | Signature |
|---|---|
| String | get_text(mode_shifted: bool = false) |
Property Descriptions
type
int type = 0
Whether this is a normal key or special key
input
InputEventKey input
The keyboard event associated with this key
mode_shift_input
InputEventKey mode_shift_input
The keyboard event associated with this key when SHIFT is being held
icon
Texture2D icon
An icon to display for this key on the on-screen keyboard
stretch_ratio
float stretch_ratio = 1.0
How much space relative to other keys in the row to take up
action
int action = 0
An action for TYPE.SPECIAL keys to take
Method Descriptions
get_text()
String get_text(mode_shifted: bool = false)
Note
There is currently no description for this method. Please help us by contributing one!