Vital.sandbox

util.input.key

Client

Enumeration of supported keyboard and mouse button identifiers


Values

Alphabet

ConstantDescription
util.input.key.AA key
util.input.key.BB key
util.input.key.CC key
util.input.key.DD key
util.input.key.EE key
util.input.key.FF key
util.input.key.GG key
util.input.key.HH key
util.input.key.II key
util.input.key.JJ key
util.input.key.KK key
util.input.key.LL key
util.input.key.MM key
util.input.key.NN key
util.input.key.OO key
util.input.key.PP key
util.input.key.QQ key
util.input.key.RR key
util.input.key.SS key
util.input.key.TT key
util.input.key.UU key
util.input.key.VV key
util.input.key.WW key
util.input.key.XX key
util.input.key.YY key
util.input.key.ZZ key

Digits

ConstantDescription
util.input.key.0Number row 0 key
util.input.key.1Number row 1 key
util.input.key.2Number row 2 key
util.input.key.3Number row 3 key
util.input.key.4Number row 4 key
util.input.key.5Number row 5 key
util.input.key.6Number row 6 key
util.input.key.7Number row 7 key
util.input.key.8Number row 8 key
util.input.key.9Number row 9 key

Numpad Digits

ConstantDescription
util.input.key.NUM_0Numpad 0 key
util.input.key.NUM_1Numpad 1 key
util.input.key.NUM_2Numpad 2 key
util.input.key.NUM_3Numpad 3 key
util.input.key.NUM_4Numpad 4 key
util.input.key.NUM_5Numpad 5 key
util.input.key.NUM_6Numpad 6 key
util.input.key.NUM_7Numpad 7 key
util.input.key.NUM_8Numpad 8 key
util.input.key.NUM_9Numpad 9 key

Numpad Operators

ConstantDescription
util.input.key.NUM_ADDNumpad + key
util.input.key.NUM_SUBTRACTNumpad - key
util.input.key.NUM_MULTIPLYNumpad * key
util.input.key.NUM_DIVIDENumpad / key
util.input.key.NUM_PERIODNumpad . key

Function Keys

ConstantDescription
util.input.key.F1F1 key
util.input.key.F2F2 key
util.input.key.F3F3 key
util.input.key.F4F4 key
util.input.key.F5F5 key
util.input.key.F6F6 key
util.input.key.F7F7 key
util.input.key.F8F8 key
util.input.key.F9F9 key
util.input.key.F10F10 key
util.input.key.F11F11 key
util.input.key.F12F12 key
util.input.key.F13F13 key
util.input.key.F14F14 key
util.input.key.F15F15 key
util.input.key.F16F16 key
util.input.key.F17F17 key
util.input.key.F18F18 key
util.input.key.F19F19 key
util.input.key.F20F20 key
util.input.key.F21F21 key
util.input.key.F22F22 key
util.input.key.F23F23 key
util.input.key.F24F24 key
util.input.key.F25F25 key. Only supported on macOS and Linux due to a Windows limitation
util.input.key.F26F26 key. Only supported on macOS and Linux due to a Windows limitation
util.input.key.F27F27 key. Only supported on macOS and Linux due to a Windows limitation
util.input.key.F28F28 key. Only supported on macOS and Linux due to a Windows limitation
util.input.key.F29F29 key. Only supported on macOS and Linux due to a Windows limitation
util.input.key.F30F30 key. Only supported on macOS and Linux due to a Windows limitation
util.input.key.F31F31 key. Only supported on macOS and Linux due to a Windows limitation
util.input.key.F32F32 key. Only supported on macOS and Linux due to a Windows limitation
util.input.key.F33F33 key. Only supported on macOS and Linux due to a Windows limitation
util.input.key.F34F34 key. Only supported on macOS and Linux due to a Windows limitation
util.input.key.F35F35 key. Only supported on macOS and Linux due to a Windows limitation

Arrow Keys

ConstantDescription
util.input.key.UPUp arrow key
util.input.key.DOWNDown arrow key
util.input.key.LEFTLeft arrow key
util.input.key.RIGHTRight arrow key

Control Keys

ConstantDescription
util.input.key.SPACESpace bar
util.input.key.ENTEREnter / Return key (main keyboard)
util.input.key.KP_ENTEREnter key on the numpad
util.input.key.ESCAPEEscape key
util.input.key.TABTab key
util.input.key.BACKTABShift + Tab key
util.input.key.BACKSPACEBackspace key
util.input.key.INSERTInsert key
util.input.key.DELETEDelete key
util.input.key.HOMEHome key
util.input.key.ENDEnd key
util.input.key.PAGE_UPPage Up key
util.input.key.PAGE_DOWNPage Down key
util.input.key.PAUSEPause key
util.input.key.PRINTPrint Screen key
util.input.key.CLEARClear key
util.input.key.MENUContext menu key
util.input.key.SYSREQSystem Request key
util.input.key.HYPERHyper key (Linux/X11 only)
util.input.key.HELPHelp key
util.input.key.BACKBack key
util.input.key.FORWARDForward key
util.input.key.STOPMedia stop key
util.input.key.REFRESHRefresh key

Modifier Keys

Both sided aliases resolve to the same underlying key code.

ConstantAliasesDescription
util.input.key.SHIFTLSHIFT / RSHIFTShift key
util.input.key.CTRLLCTRL / RCTRLControl key
util.input.key.ALTLALT / RALTAlt key
util.input.key.METALMETA / RMETAMeta / Super / Windows key

Lock Keys

ConstantDescription
util.input.key.CAPS_LOCKCaps Lock key
util.input.key.NUM_LOCKNum Lock key
util.input.key.SCROLL_LOCKScroll Lock key

Punctuation & Symbols

ConstantSymbolDescription
util.input.key.EXCLAM!Exclamation mark
util.input.key.QUOTEDBL"Double quotation mark
util.input.key.NUMBER_SIGN#Number sign / hash
util.input.key.DOLLAR$Dollar sign
util.input.key.PERCENT%Percent sign
util.input.key.AMPERSAND&Ampersand
util.input.key.APOSTROPHE'Apostrophe
util.input.key.PAREN_LEFT(Left parenthesis
util.input.key.PAREN_RIGHT)Right parenthesis
util.input.key.ASTERISK*Asterisk
util.input.key.PLUS+Plus sign
util.input.key.COMMA,Comma
util.input.key.MINUS-Minus / hyphen
util.input.key.PERIOD.Period / full stop
util.input.key.SLASH/Forward slash
util.input.key.COLON:Colon
util.input.key.SEMICOLON;Semicolon
util.input.key.LESS<Less-than sign
util.input.key.EQUAL=Equal sign
util.input.key.GREATER>Greater-than sign
util.input.key.QUESTION?Question mark
util.input.key.AT@At sign
util.input.key.BRACKET_LEFT[Left square bracket
util.input.key.BACKSLASH\Backslash
util.input.key.BRACKET_RIGHT]Right square bracket
util.input.key.CIRCUM^Caret
util.input.key.UNDERSCORE_Underscore
util.input.key.QUOTE_LEFT`Backtick / grave accent
util.input.key.BRACE_LEFT{Left curly brace
util.input.key.BAR|Vertical bar / pipe
util.input.key.BRACE_RIGHT}Right curly brace
util.input.key.TILDE~Tilde
util.input.key.YEN¥Yen symbol
util.input.key.SECTION§Section sign

Volume & Media Keys

ConstantDescription
util.input.key.VOLUME_DOWNVolume down key
util.input.key.VOLUME_MUTEMute volume key
util.input.key.VOLUME_UPVolume up key
util.input.key.MEDIA_PLAYMedia play key
util.input.key.MEDIA_STOPMedia stop key
util.input.key.MEDIA_PREVIOUSPrevious track key
util.input.key.MEDIA_NEXTNext track key
util.input.key.MEDIA_RECORDMedia record key

Browser & Launch Keys

ConstantDescription
util.input.key.HOMEPAGEHome page key
util.input.key.FAVORITESFavorites key
util.input.key.SEARCHSearch key
util.input.key.STANDBYStandby key
util.input.key.OPEN_URLOpen URL / Launch Browser key
util.input.key.LAUNCH_MAILLaunch Mail key
util.input.key.LAUNCH_MEDIALaunch Media key
util.input.key.LAUNCH0Launch Shortcut 0 key
util.input.key.LAUNCH1Launch Shortcut 1 key
util.input.key.LAUNCH2Launch Shortcut 2 key
util.input.key.LAUNCH3Launch Shortcut 3 key
util.input.key.LAUNCH4Launch Shortcut 4 key
util.input.key.LAUNCH5Launch Shortcut 5 key
util.input.key.LAUNCH6Launch Shortcut 6 key
util.input.key.LAUNCH7Launch Shortcut 7 key
util.input.key.LAUNCH8Launch Shortcut 8 key
util.input.key.LAUNCH9Launch Shortcut 9 key
util.input.key.LAUNCHALaunch Shortcut A key
util.input.key.LAUNCHBLaunch Shortcut B key
util.input.key.LAUNCHCLaunch Shortcut C key
util.input.key.LAUNCHDLaunch Shortcut D key
util.input.key.LAUNCHELaunch Shortcut E key
util.input.key.LAUNCHFLaunch Shortcut F key
util.input.key.GLOBE"Globe" key on Mac / iPad keyboard
util.input.key.KEYBOARD"On-screen keyboard" key on iPad keyboard
util.input.key.JIS_EISU英数 key on Mac keyboard
util.input.key.JIS_KANAかな key on Mac keyboard

Mouse Buttons

ConstantDescription
util.input.key.MOUSE_LEFTLeft mouse button
util.input.key.MOUSE_RIGHTRight mouse button
util.input.key.MOUSE_MIDDLEMiddle mouse button / scroll wheel click
util.input.key.MOUSE_WHEEL_UPScroll wheel up
util.input.key.MOUSE_WHEEL_DOWNScroll wheel down
util.input.key.MOUSE_XBUTTON1Extra mouse button 1 (side button)
util.input.key.MOUSE_XBUTTON2Extra mouse button 2 (side button)

util.event.emit_callback

Fires an event and returns a promise that resolves with the handler's return values

util.input.cursor_mode

Enumeration of supported cursor visibility and confinement modes

On this page

ValuesAlphabetDigitsNumpad DigitsNumpad OperatorsFunction KeysArrow KeysControl KeysModifier KeysLock KeysPunctuation & SymbolsVolume & Media KeysBrowser & Launch KeysMouse Buttons