Documentation
¶
Overview ¶
Package InputEventKey provides methods for working with InputEventKey object instances.
Index ¶
- type Advanced
- type Any
- type Instance
- func (self Instance) AsInputEvent() InputEvent.Instance
- func (self Instance) AsInputEventFromWindow() InputEventFromWindow.Instance
- func (self Instance) AsInputEventKey() Instance
- func (self Instance) AsInputEventWithModifiers() InputEventWithModifiers.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsTextKeyLabel() string
- func (self Instance) AsTextKeycode() string
- func (self Instance) AsTextLocation() string
- func (self Instance) AsTextPhysicalKeycode() string
- func (self Instance) GetKeyLabelWithModifiers() Key
- func (self Instance) GetKeycodeWithModifiers() Key
- func (self Instance) GetPhysicalKeycodeWithModifiers() Key
- func (self Instance) KeyLabel() Key
- func (self Instance) Keycode() Key
- func (self Instance) Location() KeyLocation
- func (self Instance) PhysicalKeycode() Key
- func (self Instance) SetEcho(value bool)
- func (self Instance) SetKeyLabel(value Key)
- func (self Instance) SetKeycode(value Key)
- func (self Instance) SetLocation(value KeyLocation)
- func (self Instance) SetPhysicalKeycode(value Key)
- func (self Instance) SetPressed(value bool)
- func (self Instance) SetUnicode(value int)
- func (self Instance) Unicode() int
- func (self *Instance) UnsafePointer() unsafe.Pointer
- func (self Instance) Virtual(name string) reflect.Value
- type Key
- type KeyLocation
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Instance ¶
type Instance [1]gdclass.InputEventKey
An input event for keys on a keyboard. Supports key presses, key releases and [member echo] events. It can also be received in [method Node._unhandled_key_input]. [b]Note:[/b] Events received from the keyboard usually have all properties set. Event mappings should have only one of the [member keycode], [member physical_keycode] or [member unicode] set. When events are compared, properties are checked in the following priority - [member keycode], [member physical_keycode] and [member unicode]. Events with the first matching value will be considered equal.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsInputEvent ¶
func (self Instance) AsInputEvent() InputEvent.Instance
func (Instance) AsInputEventFromWindow ¶
func (self Instance) AsInputEventFromWindow() InputEventFromWindow.Instance
func (Instance) AsInputEventKey ¶
func (Instance) AsInputEventWithModifiers ¶
func (self Instance) AsInputEventWithModifiers() InputEventWithModifiers.Instance
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsTextKeyLabel ¶
Returns a [String] representation of the event's [member key_label] and modifiers.
func (Instance) AsTextKeycode ¶
Returns a [String] representation of the event's [member keycode] and modifiers.
func (Instance) AsTextLocation ¶
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.
func (Instance) AsTextPhysicalKeycode ¶
Returns a [String] representation of the event's [member physical_keycode] and modifiers.
func (Instance) GetKeyLabelWithModifiers ¶
Returns the localized key label combined with modifier keys such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See also [InputEventWithModifiers]. To get a human-readable representation of the [InputEventKey] with modifiers, use [code]OS.get_keycode_string(event.get_key_label_with_modifiers())[/code] where [code]event[/code] is the [InputEventKey].
func (Instance) GetKeycodeWithModifiers ¶
Returns the Latin keycode combined with modifier keys such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See also [InputEventWithModifiers]. To get a human-readable representation of the [InputEventKey] with modifiers, use [code]OS.get_keycode_string(event.get_keycode_with_modifiers())[/code] where [code]event[/code] is the [InputEventKey].
func (Instance) GetPhysicalKeycodeWithModifiers ¶
Returns the physical keycode combined with modifier keys such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See also [InputEventWithModifiers]. To get a human-readable representation of the [InputEventKey] with modifiers, use [code]OS.get_keycode_string(event.get_physical_keycode_with_modifiers())[/code] where [code]event[/code] is the [InputEventKey].
func (Instance) Location ¶
func (self Instance) Location() KeyLocation
func (Instance) PhysicalKeycode ¶
func (Instance) SetKeyLabel ¶
func (Instance) SetKeycode ¶
func (Instance) SetLocation ¶
func (self Instance) SetLocation(value KeyLocation)
func (Instance) SetPhysicalKeycode ¶
func (Instance) SetPressed ¶
func (Instance) SetUnicode ¶
func (*Instance) UnsafePointer ¶
type Key ¶
type Key int
const ( /*Enum value which doesn't correspond to any key. This is used to initialize [enum Key] properties with a generic state.*/ KeyNone Key = 0 /*Keycodes with this bit applied are non-printable.*/ KeySpecial Key = 4194304 /*Escape key.*/ KeyEscape Key = 4194305 /*Tab key.*/ KeyTab Key = 4194306 /*Shift + Tab key.*/ KeyBacktab Key = 4194307 /*Backspace key.*/ KeyBackspace Key = 4194308 /*Return key (on the main keyboard).*/ KeyEnter Key = 4194309 /*Enter key on the numeric keypad.*/ KeyKpEnter Key = 4194310 /*Insert key.*/ KeyInsert Key = 4194311 /*Delete key.*/ KeyDelete Key = 4194312 /*Pause key.*/ KeyPause Key = 4194313 /*Print Screen key.*/ KeyPrint Key = 4194314 /*System Request key.*/ KeySysreq Key = 4194315 /*Clear key.*/ KeyClear Key = 4194316 /*Home key.*/ KeyHome Key = 4194317 /*End key.*/ KeyEnd Key = 4194318 /*Left arrow key.*/ KeyLeft Key = 4194319 /*Up arrow key.*/ KeyUp Key = 4194320 /*Right arrow key.*/ KeyRight Key = 4194321 /*Down arrow key.*/ KeyDown Key = 4194322 /*Page Up key.*/ KeyPageup Key = 4194323 /*Page Down key.*/ KeyPagedown Key = 4194324 /*Shift key.*/ KeyShift Key = 4194325 /*Control key.*/ KeyCtrl Key = 4194326 /*Meta key.*/ KeyMeta Key = 4194327 /*Alt key.*/ KeyAlt Key = 4194328 /*Caps Lock key.*/ KeyCapslock Key = 4194329 /*Num Lock key.*/ KeyNumlock Key = 4194330 /*Scroll Lock key.*/ KeyScrolllock Key = 4194331 /*F1 key.*/ KeyF1 Key = 4194332 /*F2 key.*/ KeyF2 Key = 4194333 /*F3 key.*/ KeyF3 Key = 4194334 /*F4 key.*/ KeyF4 Key = 4194335 /*F5 key.*/ KeyF5 Key = 4194336 /*F6 key.*/ KeyF6 Key = 4194337 /*F7 key.*/ KeyF7 Key = 4194338 /*F8 key.*/ KeyF8 Key = 4194339 /*F9 key.*/ KeyF9 Key = 4194340 /*F10 key.*/ KeyF10 Key = 4194341 /*F11 key.*/ KeyF11 Key = 4194342 /*F12 key.*/ KeyF12 Key = 4194343 /*F13 key.*/ KeyF13 Key = 4194344 /*F14 key.*/ KeyF14 Key = 4194345 /*F15 key.*/ KeyF15 Key = 4194346 /*F16 key.*/ KeyF16 Key = 4194347 /*F17 key.*/ KeyF17 Key = 4194348 /*F18 key.*/ KeyF18 Key = 4194349 /*F19 key.*/ KeyF19 Key = 4194350 /*F20 key.*/ KeyF20 Key = 4194351 /*F21 key.*/ KeyF21 Key = 4194352 /*F22 key.*/ KeyF22 Key = 4194353 /*F23 key.*/ KeyF23 Key = 4194354 /*F24 key.*/ KeyF24 Key = 4194355 /*F25 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF25 Key = 4194356 /*F26 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF26 Key = 4194357 /*F27 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF27 Key = 4194358 /*F28 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF28 Key = 4194359 /*F29 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF29 Key = 4194360 /*F30 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF30 Key = 4194361 /*F31 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF31 Key = 4194362 /*F32 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF32 Key = 4194363 /*F33 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF33 Key = 4194364 /*F34 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF34 Key = 4194365 /*F35 key. Only supported on macOS and Linux due to a Windows limitation.*/ KeyF35 Key = 4194366 /*Multiply (*) key on the numeric keypad.*/ KeyKpMultiply Key = 4194433 /*Divide (/) key on the numeric keypad.*/ KeyKpDivide Key = 4194434 /*Subtract (-) key on the numeric keypad.*/ KeyKpSubtract Key = 4194435 /*Period (.) key on the numeric keypad.*/ KeyKpPeriod Key = 4194436 /*Add (+) key on the numeric keypad.*/ KeyKpAdd Key = 4194437 /*Number 0 on the numeric keypad.*/ KeyKp0 Key = 4194438 /*Number 1 on the numeric keypad.*/ KeyKp1 Key = 4194439 /*Number 2 on the numeric keypad.*/ KeyKp2 Key = 4194440 /*Number 3 on the numeric keypad.*/ KeyKp3 Key = 4194441 /*Number 4 on the numeric keypad.*/ KeyKp4 Key = 4194442 /*Number 5 on the numeric keypad.*/ KeyKp5 Key = 4194443 /*Number 6 on the numeric keypad.*/ KeyKp6 Key = 4194444 /*Number 7 on the numeric keypad.*/ KeyKp7 Key = 4194445 /*Number 8 on the numeric keypad.*/ KeyKp8 Key = 4194446 /*Number 9 on the numeric keypad.*/ KeyKp9 Key = 4194447 /*Context menu key.*/ KeyMenu Key = 4194370 /*Hyper key. (On Linux/X11 only).*/ KeyHyper Key = 4194371 /*Help key.*/ KeyHelp Key = 4194373 /*Media back key. Not to be confused with the Back button on an Android device.*/ KeyBack Key = 4194376 /*Media forward key.*/ KeyForward Key = 4194377 /*Media stop key.*/ KeyStop Key = 4194378 /*Media refresh key.*/ KeyRefresh Key = 4194379 /*Volume down key.*/ KeyVolumedown Key = 4194380 /*Mute volume key.*/ KeyVolumemute Key = 4194381 /*Volume up key.*/ KeyVolumeup Key = 4194382 /*Media play key.*/ KeyMediaplay Key = 4194388 /*Media stop key.*/ KeyMediastop Key = 4194389 /*Previous song key.*/ KeyMediaprevious Key = 4194390 /*Next song key.*/ KeyMedianext Key = 4194391 /*Media record key.*/ KeyMediarecord Key = 4194392 /*Home page key.*/ KeyHomepage Key = 4194393 /*Favorites key.*/ KeyFavorites Key = 4194394 /*Search key.*/ KeySearch Key = 4194395 /*Standby key.*/ KeyStandby Key = 4194396 /*Open URL / Launch Browser key.*/ KeyOpenurl Key = 4194397 /*Launch Mail key.*/ KeyLaunchmail Key = 4194398 /*Launch Media key.*/ KeyLaunchmedia Key = 4194399 /*Launch Shortcut 0 key.*/ KeyLaunch0 Key = 4194400 /*Launch Shortcut 1 key.*/ KeyLaunch1 Key = 4194401 /*Launch Shortcut 2 key.*/ KeyLaunch2 Key = 4194402 /*Launch Shortcut 3 key.*/ KeyLaunch3 Key = 4194403 /*Launch Shortcut 4 key.*/ KeyLaunch4 Key = 4194404 /*Launch Shortcut 5 key.*/ KeyLaunch5 Key = 4194405 /*Launch Shortcut 6 key.*/ KeyLaunch6 Key = 4194406 /*Launch Shortcut 7 key.*/ KeyLaunch7 Key = 4194407 /*Launch Shortcut 8 key.*/ KeyLaunch8 Key = 4194408 /*Launch Shortcut 9 key.*/ KeyLaunch9 Key = 4194409 /*Launch Shortcut A key.*/ KeyLauncha Key = 4194410 /*Launch Shortcut B key.*/ KeyLaunchb Key = 4194411 /*Launch Shortcut C key.*/ KeyLaunchc Key = 4194412 /*Launch Shortcut D key.*/ KeyLaunchd Key = 4194413 /*Launch Shortcut E key.*/ KeyLaunche Key = 4194414 /*Launch Shortcut F key.*/ KeyLaunchf Key = 4194415 /*"Globe" key on Mac / iPad keyboard.*/ KeyGlobe Key = 4194416 /*"On-screen keyboard" key on iPad keyboard.*/ KeyKeyboard Key = 4194417 /*英数 key on Mac keyboard.*/ KeyJisEisu Key = 4194418 /*かな key on Mac keyboard.*/ KeyJisKana Key = 4194419 /*Unknown key.*/ KeyUnknown Key = 8388607 /*Space key.*/ KeySpace Key = 32 /*! key.*/ KeyExclam Key = 33 /*" key.*/ KeyQuotedbl Key = 34 /*# key.*/ KeyNumbersign Key = 35 /*$ key.*/ KeyDollar Key = 36 /*% key.*/ KeyPercent Key = 37 /*& key.*/ KeyAmpersand Key = 38 /*' key.*/ KeyApostrophe Key = 39 /*( key.*/ KeyParenleft Key = 40 /*) key.*/ KeyParenright Key = 41 /** key.*/ KeyAsterisk Key = 42 /*+ key.*/ KeyPlus Key = 43 /*, key.*/ KeyComma Key = 44 /*- key.*/ KeyMinus Key = 45 /*. key.*/ KeyPeriod Key = 46 /*/ key.*/ KeySlash Key = 47 /*Number 0 key.*/ Key0 Key = 48 /*Number 1 key.*/ Key1 Key = 49 /*Number 2 key.*/ Key2 Key = 50 /*Number 3 key.*/ Key3 Key = 51 /*Number 4 key.*/ Key4 Key = 52 /*Number 5 key.*/ Key5 Key = 53 /*Number 6 key.*/ Key6 Key = 54 /*Number 7 key.*/ Key7 Key = 55 /*Number 8 key.*/ Key8 Key = 56 /*Number 9 key.*/ Key9 Key = 57 /*: key.*/ KeyColon Key = 58 /*; key.*/ KeySemicolon Key = 59 /*< key.*/ KeyLess Key = 60 /*= key.*/ KeyEqual Key = 61 /*> key.*/ KeyGreater Key = 62 /*? key.*/ KeyQuestion Key = 63 /*@ key.*/ KeyAt Key = 64 /*A key.*/ KeyA Key = 65 /*B key.*/ KeyB Key = 66 /*C key.*/ KeyC Key = 67 /*D key.*/ KeyD Key = 68 /*E key.*/ KeyE Key = 69 /*F key.*/ KeyF Key = 70 /*G key.*/ KeyG Key = 71 /*H key.*/ KeyH Key = 72 /*I key.*/ KeyI Key = 73 /*J key.*/ KeyJ Key = 74 /*K key.*/ KeyK Key = 75 /*L key.*/ KeyL Key = 76 /*M key.*/ KeyM Key = 77 /*N key.*/ KeyN Key = 78 /*O key.*/ KeyO Key = 79 /*P key.*/ KeyP Key = 80 /*Q key.*/ KeyQ Key = 81 /*R key.*/ KeyR Key = 82 /*S key.*/ KeyS Key = 83 /*T key.*/ KeyT Key = 84 /*U key.*/ KeyU Key = 85 /*V key.*/ KeyV Key = 86 /*W key.*/ KeyW Key = 87 /*X key.*/ KeyX Key = 88 /*Y key.*/ KeyY Key = 89 /*Z key.*/ KeyZ Key = 90 /*[ key.*/ KeyBracketleft Key = 91 /*\ key.*/ KeyBackslash Key = 92 /*] key.*/ KeyBracketright Key = 93 /*^ key.*/ KeyAsciicircum Key = 94 /*_ key.*/ KeyUnderscore Key = 95 /*` key.*/ KeyQuoteleft Key = 96 /*{ key.*/ KeyBraceleft Key = 123 /*| key.*/ KeyBar Key = 124 /*} key.*/ KeyBraceright Key = 125 /*~ key.*/ KeyAsciitilde Key = 126 /*¥ key.*/ KeyYen Key = 165 /*§ key.*/ KeySection Key = 167 )
type KeyLocation ¶
type KeyLocation int
const ( /*Used for keys which only appear once, or when a comparison doesn't need to differentiate the [code]LEFT[/code] and [code]RIGHT[/code] versions. For example, when using [method InputEvent.is_match], an event which has [constant KEY_LOCATION_UNSPECIFIED] will match any [enum KeyLocation] on the passed event.*/ KeyLocationUnspecified KeyLocation = 0 /*A key which is to the left of its twin.*/ KeyLocationLeft KeyLocation = 1 /*A key which is to the right of its twin.*/ KeyLocationRight KeyLocation = 2 )
Source Files
Click to show internal directories.
Click to hide internal directories.