Enums
Text Alignment
Fields
eAlignCentered 2
eAlignCenteredWithLeftPos 5
eAlignLeft 0
eAlignLeftWithCenterPos 3
eAlignRight 1
eAlignRightWithCenterPos 4
Text Event Type
Fields
eEvtKeyDown 1
eEvtKeyTextInput 3
eEvtKeyUp 2
eEvtControllerKeyDown 4
eEvtControllerKeyUp 5
eEvtControllerAxis 6
eMsgControllerConnected 7
eMsgControllerDisconnected 8
eMsgControllerRemapped 9
Mouse Event Type
Fields
eEvtDollarGesture 15
eEvtMouseLeftButtonDoubleClick 2
eEvtMouseLeftButtonDown 3
eEvtMouseLeftButtonHold 5
eEvtMouseLeftButtonHolding 6
eEvtMouseLeftButtonUp 4
eEvtMouseMiddleButtonDown 10
eEvtMouseMiddleButtonUp 11
eEvtMouseMove 1
eEvtMouseRightButtonDoubleClick 7
eEvtMouseRightButtonDown 8
eEvtMouseRightButtonUp 9
eEvtMouseWheelDown 13
eEvtMouseWheelUp 12
eEvtMultiGesture 14
eEvtTouchDown 16
eEvtTouchMove 18
eEvtTouchUp 17
Dialog Return Type
Fields
eDialogReturnToEnd 2
eDialogReturnToSame 0
eDialogReturnToUpper 1
Disable Interaction Type
Fields
eDisableInteractionAlways 2
eDisableInteractionCharacterAnim 1
eDisableInteractionNever 0
Draw Action Text Type
Fields
eDrawActionTextAtCurrentPos 1
eDrawActionTextAtRect 2
eDrawNoActionText 0
Inteface Displacement
Fields
eInterfaceDisplacementAbsolute 4
eInterfaceDisplacementBottom 1
eInterfaceDisplacementLeft 2
eInterfaceDisplacementRelative 5
eInterfaceDisplacementRight 3
eInterfaceDisplacementTop 0
Container Count
Fields
eMainContainer 0
eSingleContainer 1
eMultipleContainers 2
Mouse Behaviour
Fields
eMouseActionBehaviourDoNotSendCharacter 0
eMouseActionBehaviourSendCharacterToCursor 1
eMouseActionBehaviourSendCharacterToObjects 2
Replay Type
Fields
eReplayNormal 0
eReplayRandom 2
eReplayReverse 1
Script Type
Fields
eScriptTypeDefinition 1
eScriptTypeExecution 0
Activate Standard Command
Fields
eSetStdCommandAlways 0
eSetStdCommandNever 1
eSetStdCommandOnSuccess 2
Text Output
Fields
eTextAndSpeechOutput 0
eOnlySpeechOutput 1
eOnlyTextOutput 2
Interpolation Type
Fields
eLinearInterpolation 0
eNearestNeighborInterpolation 1
eTriLinearInterpolation 2
Keys
Fields
eKeyBackspace 8
eKeyEscape 27
eKeyModAlt 768
eKeyModCaps 8192
eKeyModCtrl 192
eKeyModGui 3072
eKeyModLAlt 256
eKeyModLCtrl 64
eKeyModLGui 1024
eKeyModLShift 1
eKeyModMode 16384
eKeyModNum 4096
eKeyModRAlt 512
eKeyModRCtrl 128
eKeyModRGui 2048
eKeyModRShift 2
eKeyModShift 3
eKeyReturn 13
eKeySpace 32
eKeyTab 9
Key codes and modifiers
This page lists keycodes and modifiers for use in key event handlers.
Please note that these lists may be incomplete. If you have anything to add, please post it on our Discord.
Keycodes
| Key | Key code | Enum name |
|---|---|---|
| Unknown | 0 | |
| Backspace | 8 | eKeyBackspace |
| Tab | 9 | eKeyTab |
| Clear | 12 | |
| Return | 13 | eKeyReturn |
| Pause | 19 | |
| Escape | 27 | eKeyEscape |
| Space | 32 | eKeySpace |
| QuotedDouble | 34 | |
| Hash | 35 | |
| Dollar | 36 | |
| Percent | 37 | |
| Ampersand | 38 | |
| Quote | 39 | |
| LeftParenthesis | 40 | |
| RightParenthesis | 41 | |
| Asterisk | 42 | |
| Plus | 43 | |
| Comma | 44 | |
| Minus | 45 | |
| Period | 46 | |
| Slash | 47 | |
| Zero | 48 | |
| One | 49 | |
| Two | 50 | |
| Three | 51 | |
| Four | 52 | |
| Five | 53 | |
| Six | 54 | |
| Seven | 55 | |
| Eight | 56 | |
| Nine | 57 | |
| Colon | 58 | |
| Semicolon | 59 | |
| LessThan | 60 | |
| Equals | 61 | |
| GreaterThan | 62 | |
| Question | 63 | |
| At | 64 | |
| LeftBracket | 91 | |
| BackSlash | 92 | |
| RightBracket | 93 | |
| Caret | 94 | |
| Underscore | 95 | |
| Backquote | 96 | |
| A | 97 | |
| B | 98 | |
| C | 99 | |
| D | 100 | |
| E | 101 | |
| F | 102 | |
| G | 103 | |
| H | 104 | |
| I | 105 | |
| J | 106 | |
| K | 107 | |
| L | 108 | |
| M | 109 | |
| N | 110 | |
| O | 111 | |
| P | 112 | |
| Q | 113 | |
| R | 114 | |
| S | 115 | |
| T | 116 | |
| U | 117 | |
| V | 118 | |
| W | 119 | |
| X | 120 | |
| Y | 121 | |
| Z | 122 | |
| LeftCurly | 123 | |
| Pipe | 124 | |
| RightCurly | 125 | |
| Tilde | 126 | |
| Delete | 127 | |
| World0 | 160 | |
| World1 | 161 | |
| World2 | 162 | |
| World3 | 163 | |
| World4 | 164 | |
| World5 | 165 | |
| World6 | 166 | |
| World7 | 167 | |
| World8 | 168 | |
| World9 | 169 | |
| World10 | 170 | |
| World11 | 171 | |
| World12 | 172 | |
| World13 | 173 | |
| World14 | 174 | |
| World15 | 175 | |
| World16 | 176 | |
| World17 | 177 | |
| World18 | 178 | |
| World19 | 179 | |
| World20 | 180 | |
| World21 | 181 | |
| World22 | 182 | |
| World23 | 183 | |
| World24 | 184 | |
| World25 | 185 | |
| World26 | 186 | |
| World27 | 187 | |
| World28 | 188 | |
| World29 | 189 | |
| World30 | 190 | |
| World31 | 191 | |
| World32 | 192 | |
| World33 | 193 | |
| World34 | 194 | |
| World35 | 195 | |
| World36 | 196 | |
| World37 | 197 | |
| World38 | 198 | |
| World39 | 199 | |
| World40 | 200 | |
| World41 | 201 | |
| World42 | 202 | |
| World43 | 203 | |
| World44 | 204 | |
| World45 | 205 | |
| World46 | 206 | |
| World47 | 207 | |
| World48 | 208 | |
| World49 | 209 | |
| World50 | 210 | |
| World51 | 211 | |
| World52 | 212 | |
| World53 | 213 | |
| World54 | 214 | |
| World55 | 215 | |
| World56 | 216 | |
| World57 | 217 | |
| World58 | 218 | |
| World59 | 219 | |
| World60 | 220 | |
| World61 | 221 | |
| World62 | 222 | |
| World63 | 223 | |
| World64 | 224 | |
| World65 | 225 | |
| World66 | 226 | |
| World67 | 227 | |
| World68 | 228 | |
| World69 | 229 | |
| World70 | 230 | |
| World71 | 231 | |
| World72 | 232 | |
| World73 | 233 | |
| World74 | 234 | |
| World75 | 235 | |
| World76 | 236 | |
| World77 | 237 | |
| World78 | 238 | |
| World79 | 239 | |
| World80 | 240 | |
| World81 | 241 | |
| World82 | 242 | |
| World83 | 243 | |
| World84 | 244 | |
| World85 | 245 | |
| World86 | 246 | |
| World87 | 247 | |
| World88 | 248 | |
| World89 | 249 | |
| World90 | 250 | |
| World91 | 251 | |
| World92 | 252 | |
| World93 | 253 | |
| World94 | 254 | |
| World95 | 255 | |
| KeypadZero | 256 | |
| KeypadOne | 257 | |
| KeypadTwo | 258 | |
| KeypadThree | 259 | |
| KeypadFour | 260 | |
| KeypadFive | 261 | |
| KeypadSix | 262 | |
| KeypadSeven | 263 | |
| KeypadEight | 264 | |
| KeypadNine | 265 | |
| KeypadPeriod | 266 | |
| KeypadDivide | 267 | |
| KeypadMultiply | 268 | |
| KeypadMinus | 269 | |
| KeypadPlus | 270 | |
| KeypadEnter | 271 | |
| KeypadEquals | 272 | |
| Up | 273 | |
| Down | 274 | |
| Right | 275 | |
| Left | 276 | |
| Insert | 277 | |
| Home | 278 | |
| End | 279 | |
| PageUp | 280 | |
| PageDown | 281 | |
| F1 | 282 | |
| F2 | 283 | |
| F3 | 284 | |
| F4 | 285 | |
| F5 | 286 | |
| F6 | 287 | |
| F7 | 288 | |
| F8 | 289 | |
| F9 | 290 | |
| F10 | 291 | |
| F11 | 292 | |
| F12 | 293 | |
| F13 | 294 | |
| F14 | 295 | |
| F15 | 296 | |
| NumLock | 300 | |
| CapsLock | 301 | |
| ScrollLock | 302 | |
| RightShift | 303 | |
| LeftShift | 304 | |
| RightControl | 305 | |
| LeftControl | 306 | |
| RightAlt | 307 | |
| LeftAlt | 308 | |
| RightMeta | 309 | |
| LeftMeta | 310 | |
| LeftSuper | 311 | |
| RightSuper | 312 | |
| Mode | 313 | |
| Compose | 314 | |
| Help | 315 | |
| 316 | ||
| SysReq | 317 | |
| Break | 318 | |
| Menu | 319 | |
| Power | 320 | |
| Euro | 321 | |
| Undo | 322 | |
| ButtonX | 1000 | |
| ButtonY | 1001 | |
| ButtonA | 1002 | |
| ButtonB | 1003 | |
| ButtonR1 | 1004 | |
| ButtonL1 | 1005 | |
| ButtonR2 | 1006 | |
| ButtonL2 | 1007 | |
| ButtonR3 | 1008 | |
| ButtonL3 | 1009 | |
| ButtonStart | 1010 | |
| ButtonSelect | 1011 | |
| DPadLeft | 1012 | |
| DPadRight | 1013 | |
| DPadUp | 1014 | |
| DPadDown | 1015 | |
| Thumbstick1 | 1016 | |
| Thumbstick2 | 1017 |
Modifiers
| Key | Modifier code | Enum name |
|---|---|---|
| LeftShift | 1 | eKeyModLShift |
| RightShift | 2 | eKeyModRShift |
| Shift | 3 | eKeyModShift |
| LeftControl | 64 | eKeyModLCtrl |
| RightControl | 128 | eKeyModRCtrl |
| Control | 192 | eKeyModCtrl |
| LeftAlt | 256 | eKeyModLAlt |
| RightAlt | 512 | eKeyModRAlt |
| Alt | 768 | eKeyModAlt |
| 1024 | eKeyModLGui | |
| 2048 | eKeyModRGui | |
| 3072 | eKeyModGui | |
| NumLock | 4096 | eKeyModNum |
| CapsLock | 8192 | eKeyModCaps |
| 16384 | eKeyModMode |
Button Type
Fields
eButtonActionArea 4
eButtonCombined 1
eButtonCommand 3
eButtonCommandGroup 5
eButtonCommandInGroup 6
eButtonGive 2
eButtonNormal 0
eButtonPlaceholder 0
eButtonScrollDown 2
eButtonScrollUp 1
Execution Type
Fields
eAtBeginningOfScene 31
eAtEndOfScene 32
eExecutionTypeActionCommand 6
eExecutionTypeActionCommandBoth 21
eExecutionTypeActionCommandIm 17
eExecutionTypeActionCommandImBoth 22
eExecutionTypeActionCommandImOther 24
eExecutionTypeActionCommandOther 23
eExecutionTypeCalledByOtherAction 5
eExecutionTypeCombinedCommandMouseClickIm 19
eExecutionTypeCommandMouseClickIm 18
eExecutionTypeFixtureDropped 3
eExecutionTypeFixtureDroppedBoth 25
eExecutionTypeFixtureDroppedIm 20
eExecutionTypeFixtureDroppedImBoth 26
eExecutionTypeFixtureDroppedImOther 28
eExecutionTypeFixtureDroppedOther 27
eExecutionTypeLeftMouseClickIm 7
eExecutionTypeLeftMouseDblClick 12
eExecutionTypeLeftMouseDblClickIm 13
eExecutionTypeLeftMouseHold 14
eExecutionTypeLeftMouseHoldIm 15
eExecutionTypeMouseEntersArea 1
eExecutionTypeMouseLeavesArea 2
eExecutionTypeRightMouseClick 0
eExecutionTypeRightMouseClickIm 16
Shader Exclude
Fields
eShaderExcludeCursor 3
eShaderExcludeInterfaces 1
eShaderExcludeNothing 0
eShaderExcludeTextsAndCursor 2
Command Use Type
Fields
eUseOnAll 0
eUseOnCharacters 1
eUseOnObjects 2
Sound Volume Types
Fields
eMusicVolume 0
eSoundVolume 1
eSpeechVolume 2
eMovieVolume 3
eGlobalVolume 4
Transitions
Fields
eFadeIn 1
eFadeInAndOut 3
eFadeNo 0
eFadeOut 2
eFadeToNew 4
eShiftLeft 5
eShiftRight 6
eTunnelEffect 7
eTunnelEffectFadeOut 8
eTunnelEffectFadeIn 9
eFadeKeep 10
eFadeShader 11
Animation Type
Fields
eCharacterAnim 4
eStandingAnim 3
eTalkAnim 2
eWalkAnim 1
eNoAnim 0
eRandomAnim 5
Tables
Fields
eActionAreas 32
eActionParts 8
eActions 7
eActiveActions 25
eActiveAnimations 26
eActiveTexts 24
eAnimationFrames 28
eAnimations 9
eAreaActions 33
eButtons 2
eCharacters 0
eCommentSetEntries 27
eCommentSets 16
eConditions 10
eCursors 15
eDialogParts 12
eDialogs 11
eFonts 3
eGame -1
eInterfaces 1
eInterfaceClasses 31
eLanguages 18
eLoadings 21
eModels 35
eObjects 6
eOutfits 17
eParticleContainers 23
eParticles 22
ePoints 5
eScenes 4
eScriptVariables 34
eScripts 30
eSprites 13
eTextLanguages 19
eTexts 14
eValues 20
eWaySystems 29
Transparency
Fields
eTransparencyAlpha 2
eTransparencyColorKey 1
eTransparencyNone 0
eTransparencyUndefined -1
Easing
Fields
easeBackIn 0
easeBackInOut 2
easeBackOut 1
easeBounceIn 3
easeBounceInOut 5
easeBounceOut 4
easeCircIn 6
easeCircInOut 8
easeCircOut 7
easeCubicIn 9
easeCubicInOut 11
easeCubicOut 10
easeElasticIn 12
easeElasticInOut 14
easeElasticOut 13
easeLinearIn 15
easeLinearInOut 17
easeLinearOut 16
easeNoneIn 18
easeNoneInOut 20
easeNoneOut 19
easeQuadIn 21
easeQuadInOut 23
easeQuadOut 22
easeQuartIn 24
easeQuartInOut 26
easeQuartOut 25
easeQuintIn 27
easeQuintInOut 29
easeQuintOut 28
easeSineIn 30
easeSineInOut 32
easeSineOut 31