godot-docs/classes/[email protected]

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the @GlobalScope.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_@GlobalScope:

@GlobalScope
============

**Category:** Core

Brief Description
-----------------

Global scope constants and variables.

Enumerations
------------

  .. _enum_@GlobalScope_Variant.Operator:

enum **Variant.Operator**

- **OP_EQUAL** = **0**
- **OP_NOT_EQUAL** = **1**
- **OP_LESS** = **2**
- **OP_LESS_EQUAL** = **3**
- **OP_GREATER** = **4**
- **OP_GREATER_EQUAL** = **5**
- **OP_ADD** = **6**
- **OP_SUBTRACT** = **7**
- **OP_MULTIPLY** = **8**
- **OP_DIVIDE** = **9**
- **OP_NEGATE** = **10**
- **OP_POSITIVE** = **11**
- **OP_MODULE** = **12**
- **OP_STRING_CONCAT** = **13**
- **OP_SHIFT_LEFT** = **14**
- **OP_SHIFT_RIGHT** = **15**
- **OP_BIT_AND** = **16**
- **OP_BIT_OR** = **17**
- **OP_BIT_XOR** = **18**
- **OP_BIT_NEGATE** = **19**
- **OP_AND** = **20**
- **OP_OR** = **21**
- **OP_XOR** = **22**
- **OP_NOT** = **23**
- **OP_IN** = **24**
- **OP_MAX** = **25**

  .. _enum_@GlobalScope_MethodFlags:

enum **MethodFlags**

- **METHOD_FLAG_NORMAL** = **1** --- Flag for normal method
- **METHOD_FLAG_EDITOR** = **2** --- Flag for editor method
- **METHOD_FLAG_NOSCRIPT** = **4**
- **METHOD_FLAG_CONST** = **8** --- Flag for constant method
- **METHOD_FLAG_REVERSE** = **16**
- **METHOD_FLAG_VIRTUAL** = **32** --- Flag for virtual method
- **METHOD_FLAG_FROM_SCRIPT** = **64** --- Flag for method from script
- **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags

  .. _enum_@GlobalScope_Orientation:

enum **Orientation**

- **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc.
- **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc.

  .. _enum_@GlobalScope_PropertyUsageFlags:

enum **PropertyUsageFlags**

- **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default).
- **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default).
- **PROPERTY_USAGE_NETWORK** = **4**
- **PROPERTY_USAGE_EDITOR_HELPER** = **8**
- **PROPERTY_USAGE_CHECKABLE** = **16**
- **PROPERTY_USAGE_CHECKED** = **32**
- **PROPERTY_USAGE_INTERNATIONALIZED** = **64**
- **PROPERTY_USAGE_GROUP** = **128**
- **PROPERTY_USAGE_CATEGORY** = **256**
- **PROPERTY_USAGE_STORE_IF_NONZERO** = **512**
- **PROPERTY_USAGE_STORE_IF_NONONE** = **1024**
- **PROPERTY_USAGE_NO_INSTANCE_STATE** = **2048**
- **PROPERTY_USAGE_RESTART_IF_CHANGED** = **4096**
- **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192**
- **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor).
- **PROPERTY_USAGE_DEFAULT_INTL** = **71**
- **PROPERTY_USAGE_NOEDITOR** = **5**

  .. _enum_@GlobalScope_JoystickList:

enum **JoystickList**

- **JOY_BUTTON_0** = **0** --- Joypad Button 0
- **JOY_BUTTON_1** = **1** --- Joypad Button 1
- **JOY_BUTTON_2** = **2** --- Joypad Button 2
- **JOY_BUTTON_3** = **3** --- Joypad Button 3
- **JOY_BUTTON_4** = **4** --- Joypad Button 4
- **JOY_BUTTON_5** = **5** --- Joypad Button 5
- **JOY_BUTTON_6** = **6** --- Joypad Button 6
- **JOY_BUTTON_7** = **7** --- Joypad Button 7
- **JOY_BUTTON_8** = **8** --- Joypad Button 8
- **JOY_BUTTON_9** = **9** --- Joypad Button 9
- **JOY_BUTTON_10** = **10** --- Joypad Button 10
- **JOY_BUTTON_11** = **11** --- Joypad Button 11
- **JOY_BUTTON_12** = **12** --- Joypad Button 12
- **JOY_BUTTON_13** = **13** --- Joypad Button 13
- **JOY_BUTTON_14** = **14** --- Joypad Button 14
- **JOY_BUTTON_15** = **15** --- Joypad Button 15
- **JOY_BUTTON_MAX** = **16** --- Joypad Button 16
- **JOY_SONY_CIRCLE** = **1** --- DUALSHOCK circle button
- **JOY_SONY_X** = **0** --- DUALSHOCK X button
- **JOY_SONY_SQUARE** = **2** --- DUALSHOCK square button
- **JOY_SONY_TRIANGLE** = **3** --- DUALSHOCK triangle button
- **JOY_XBOX_B** = **1** --- XBOX controller B button
- **JOY_XBOX_A** = **0** --- XBOX controller A button
- **JOY_XBOX_X** = **2** --- XBOX controller X button
- **JOY_XBOX_Y** = **3** --- XBOX controller Y button
- **JOY_DS_A** = **1** --- DualShock controller A button
- **JOY_DS_B** = **0** --- DualShock controller B button
- **JOY_DS_X** = **3** --- DualShock controller X button
- **JOY_DS_Y** = **2** --- DualShock controller Y button
- **JOY_SELECT** = **10** --- Joypad Button Select
- **JOY_START** = **11** --- Joypad Button Start
- **JOY_DPAD_UP** = **12** --- Joypad DPad Up
- **JOY_DPAD_DOWN** = **13** --- Joypad DPad Down
- **JOY_DPAD_LEFT** = **14** --- Joypad DPad Left
- **JOY_DPAD_RIGHT** = **15** --- Joypad DPad Right
- **JOY_L** = **4** --- Joypad Left Shoulder Button
- **JOY_L2** = **6** --- Joypad Left Trigger
- **JOY_L3** = **8** --- Joypad Left Stick Click
- **JOY_R** = **5** --- Joypad Right Shoulder Button
- **JOY_R2** = **7** --- Joypad Right Trigger
- **JOY_R3** = **9** --- Joypad Right Stick Click
- **JOY_AXIS_0** = **0** --- Joypad Left Stick Horizontal Axis
- **JOY_AXIS_1** = **1** --- Joypad Left Stick Vertical Axis
- **JOY_AXIS_2** = **2** --- Joypad Right Stick Horizontal Axis
- **JOY_AXIS_3** = **3** --- Joypad Right Stick Vertical Axis
- **JOY_AXIS_4** = **4**
- **JOY_AXIS_5** = **5**
- **JOY_AXIS_6** = **6** --- Joypad Left Trigger Analog Axis
- **JOY_AXIS_7** = **7** --- Joypad Right Trigger Analog Axis
- **JOY_AXIS_8** = **8**
- **JOY_AXIS_9** = **9**
- **JOY_AXIS_MAX** = **10**
- **JOY_ANALOG_LX** = **0** --- Joypad Left Stick Horizontal Axis
- **JOY_ANALOG_LY** = **1** --- Joypad Left Stick Vertical Axis
- **JOY_ANALOG_RX** = **2** --- Joypad Right Stick Horizontal Axis
- **JOY_ANALOG_RY** = **3** --- Joypad Right Stick Vertical Axis
- **JOY_ANALOG_L2** = **6** --- Joypad Left Analog Trigger
- **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger

  .. _enum_@GlobalScope_MidiMessageList:

enum **MidiMessageList**

- **MIDI_MESSAGE_NOTE_OFF** = **8**
- **MIDI_MESSAGE_NOTE_ON** = **9**
- **MIDI_MESSAGE_AFTERTOUCH** = **10**
- **MIDI_MESSAGE_CONTROL_CHANGE** = **11**
- **MIDI_MESSAGE_PROGRAM_CHANGE** = **12**
- **MIDI_MESSAGE_CHANNEL_PRESSURE** = **13**
- **MIDI_MESSAGE_PITCH_BEND** = **14**

  .. _enum_@GlobalScope_KeyModifierMask:

enum **KeyModifierMask**

- **KEY_CODE_MASK** = **33554431** --- Key Code Mask
- **KEY_MODIFIER_MASK** = **-16777216** --- Modifier Key Mask
- **KEY_MASK_SHIFT** = **33554432** --- Shift Key Mask
- **KEY_MASK_ALT** = **67108864** --- Alt Key Mask
- **KEY_MASK_META** = **134217728** --- Meta Key Mask
- **KEY_MASK_CTRL** = **268435456** --- CTRL Key Mask
- **KEY_MASK_CMD** = **268435456** --- CMD Key Mask
- **KEY_MASK_KPAD** = **536870912** --- Keypad Key Mask
- **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask

  .. _enum_@GlobalScope_HAlign:

enum **HAlign**

- **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes.
- **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes.
- **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes.

  .. _enum_@GlobalScope_Error:

enum **Error**

- **OK** = **0** --- Functions that return Error return OK when no error occurred. Most functions don't return errors and/or just print errors to STDOUT.
- **FAILED** = **1** --- Generic error.
- **ERR_UNAVAILABLE** = **2** --- Unavailable error
- **ERR_UNCONFIGURED** = **3** --- Unconfigured error
- **ERR_UNAUTHORIZED** = **4** --- Unauthorized error
- **ERR_PARAMETER_RANGE_ERROR** = **5** --- Parameter range error
- **ERR_OUT_OF_MEMORY** = **6** --- Out of memory (OOM) error
- **ERR_FILE_NOT_FOUND** = **7** --- File: Not found error
- **ERR_FILE_BAD_DRIVE** = **8** --- File: Bad drive error
- **ERR_FILE_BAD_PATH** = **9** --- File: Bad path error
- **ERR_FILE_NO_PERMISSION** = **10** --- File: No permission error
- **ERR_FILE_ALREADY_IN_USE** = **11** --- File: Already in use error
- **ERR_FILE_CANT_OPEN** = **12** --- File: Can't open error
- **ERR_FILE_CANT_WRITE** = **13** --- File: Can't write error
- **ERR_FILE_CANT_READ** = **14** --- File: Can't read error
- **ERR_FILE_UNRECOGNIZED** = **15** --- File: Unrecognized error
- **ERR_FILE_CORRUPT** = **16** --- File: Corrupt error
- **ERR_FILE_MISSING_DEPENDENCIES** = **17** --- File: Missing dependencies error
- **ERR_FILE_EOF** = **18** --- File: End of file (EOF) error
- **ERR_CANT_OPEN** = **19** --- Can't open error
- **ERR_CANT_CREATE** = **20** --- Can't create error
- **ERR_PARSE_ERROR** = **43** --- Parse error
- **ERR_QUERY_FAILED** = **21** --- Query failed error
- **ERR_ALREADY_IN_USE** = **22** --- Already in use error
- **ERR_LOCKED** = **23** --- Locked error
- **ERR_TIMEOUT** = **24** --- Timeout error
- **ERR_CANT_ACQUIRE_RESOURCE** = **28** --- Can't acquire resource error
- **ERR_INVALID_DATA** = **30** --- Invalid data error
- **ERR_INVALID_PARAMETER** = **31** --- Invalid parameter error
- **ERR_ALREADY_EXISTS** = **32** --- Already exists error
- **ERR_DOES_NOT_EXIST** = **33** --- Does not exist error
- **ERR_DATABASE_CANT_READ** = **34** --- Database: Read error
- **ERR_DATABASE_CANT_WRITE** = **35** --- Database: Write error
- **ERR_COMPILATION_FAILED** = **36** --- Compilation failed error
- **ERR_METHOD_NOT_FOUND** = **37** --- Method not found error
- **ERR_LINK_FAILED** = **38** --- Linking failed error
- **ERR_SCRIPT_FAILED** = **39** --- Script failed error
- **ERR_CYCLIC_LINK** = **40** --- Cycling link (import cycle) error
- **ERR_BUSY** = **44** --- Busy error
- **ERR_HELP** = **46** --- Help error
- **ERR_BUG** = **47** --- Bug error

  .. _enum_@GlobalScope_VAlign:

enum **VAlign**

- **VALIGN_TOP** = **0** --- Vertical top alignment, usually for text-derived classes.
- **VALIGN_CENTER** = **1** --- Vertical center alignment, usually for text-derived classes.
- **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes.

  .. _enum_@GlobalScope_PropertyHint:

enum **PropertyHint**

- **PROPERTY_HINT_NONE** = **0** --- No hint for edited property.
- **PROPERTY_HINT_RANGE** = **1** --- Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
- **PROPERTY_HINT_ENUM** = **3** --- Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
- **PROPERTY_HINT_EXP_EASING** = **4**
- **PROPERTY_HINT_LENGTH** = **5**
- **PROPERTY_HINT_KEY_ACCEL** = **7**
- **PROPERTY_HINT_FLAGS** = **8** --- Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
- **PROPERTY_HINT_LAYERS_2D_RENDER** = **9**
- **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10**
- **PROPERTY_HINT_LAYERS_3D_RENDER** = **11**
- **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12**
- **PROPERTY_HINT_FILE** = **13** --- String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "\*.doc".
- **PROPERTY_HINT_DIR** = **14** --- String property is a directory (so pop up a file dialog when edited).
- **PROPERTY_HINT_GLOBAL_FILE** = **15**
- **PROPERTY_HINT_GLOBAL_DIR** = **16**
- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- String property is a resource, so open the resource popup menu when edited.
- **PROPERTY_HINT_MULTILINE_TEXT** = **18**
- **PROPERTY_HINT_PLACEHOLDER_TEXT** = **19**
- **PROPERTY_HINT_COLOR_NO_ALPHA** = **20**
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that the image is compressed using lossy compression.
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that the image is compressed using lossless compression.

  .. _enum_@GlobalScope_Corner:

enum **Corner**

- **CORNER_TOP_LEFT** = **0**
- **CORNER_TOP_RIGHT** = **1**
- **CORNER_BOTTOM_RIGHT** = **2**
- **CORNER_BOTTOM_LEFT** = **3**

  .. _enum_@GlobalScope_KeyList:

enum **KeyList**

- **KEY_ESCAPE** = **16777217** --- Escape Key
- **KEY_TAB** = **16777218** --- Tab Key
- **KEY_BACKTAB** = **16777219** --- Shift-Tab Key
- **KEY_BACKSPACE** = **16777220** --- Backspace Key
- **KEY_ENTER** = **16777221** --- Return Key (On Main Keyboard)
- **KEY_KP_ENTER** = **16777222** --- Enter Key (On Numpad)
- **KEY_INSERT** = **16777223** --- Insert Key
- **KEY_DELETE** = **16777224** --- Delete Key
- **KEY_PAUSE** = **16777225** --- Pause Key
- **KEY_PRINT** = **16777226** --- Printscreen Key
- **KEY_SYSREQ** = **16777227** --- System Request Key
- **KEY_CLEAR** = **16777228** --- Clear Key
- **KEY_HOME** = **16777229** --- Home Key
- **KEY_END** = **16777230** --- End Key
- **KEY_LEFT** = **16777231** --- Left Arrow Key
- **KEY_UP** = **16777232** --- Up Arrow Key
- **KEY_RIGHT** = **16777233** --- Right Arrow Key
- **KEY_DOWN** = **16777234** --- Down Arrow Key
- **KEY_PAGEUP** = **16777235** --- Pageup Key
- **KEY_PAGEDOWN** = **16777236** --- Pagedown Key
- **KEY_SHIFT** = **16777237** --- Shift Key
- **KEY_CONTROL** = **16777238** --- Control Key
- **KEY_META** = **16777239** --- Meta Key
- **KEY_ALT** = **16777240** --- Alt Key
- **KEY_CAPSLOCK** = **16777241** --- Capslock Key
- **KEY_NUMLOCK** = **16777242** --- Numlock Key
- **KEY_SCROLLLOCK** = **16777243** --- Scrolllock Key
- **KEY_F1** = **16777244** --- F1 Key
- **KEY_F2** = **16777245** --- F2 Key
- **KEY_F3** = **16777246** --- F3 Key
- **KEY_F4** = **16777247** --- F4 Key
- **KEY_F5** = **16777248** --- F5 Key
- **KEY_F6** = **16777249** --- F6 Key
- **KEY_F7** = **16777250** --- F7 Key
- **KEY_F8** = **16777251** --- F8 Key
- **KEY_F9** = **16777252** --- F9 Key
- **KEY_F10** = **16777253** --- F10 Key
- **KEY_F11** = **16777254** --- F11 Key
- **KEY_F12** = **16777255** --- F12 Key
- **KEY_F13** = **16777256** --- F13 Key
- **KEY_F14** = **16777257** --- F14 Key
- **KEY_F15** = **16777258** --- F15 Key
- **KEY_F16** = **16777259** --- F16 Key
- **KEY_KP_MULTIPLY** = **16777345** --- Multiply Key on Numpad
- **KEY_KP_DIVIDE** = **16777346** --- Divide Key on Numpad
- **KEY_KP_SUBTRACT** = **16777347** --- Subtract Key on Numpad
- **KEY_KP_PERIOD** = **16777348** --- Period Key on Numpad
- **KEY_KP_ADD** = **16777349** --- Add Key on Numpad
- **KEY_KP_0** = **16777350** --- Number 0 on Numpad
- **KEY_KP_1** = **16777351** --- Number 1 on Numpad
- **KEY_KP_2** = **16777352** --- Number 2 on Numpad
- **KEY_KP_3** = **16777353** --- Number 3 on Numpad
- **KEY_KP_4** = **16777354** --- Number 4 on Numpad
- **KEY_KP_5** = **16777355** --- Number 5 on Numpad
- **KEY_KP_6** = **16777356** --- Number 6 on Numpad
- **KEY_KP_7** = **16777357** --- Number 7 on Numpad
- **KEY_KP_8** = **16777358** --- Number 8 on Numpad
- **KEY_KP_9** = **16777359** --- Number 9 on Numpad
- **KEY_SUPER_L** = **16777260** --- Left Super Key (Windows Key)
- **KEY_SUPER_R** = **16777261** --- Right Super Key (Windows Key)
- **KEY_MENU** = **16777262** --- Context menu key
- **KEY_HYPER_L** = **16777263** --- Left Hyper Key
- **KEY_HYPER_R** = **16777264** --- Right Hyper Key
- **KEY_HELP** = **16777265** --- Help key
- **KEY_DIRECTION_L** = **16777266** --- Left Direction Key
- **KEY_DIRECTION_R** = **16777267** --- Right Direction Key
- **KEY_BACK** = **16777280** --- Back key
- **KEY_FORWARD** = **16777281** --- Forward key
- **KEY_STOP** = **16777282** --- Stop key
- **KEY_REFRESH** = **16777283** --- Refresh key
- **KEY_VOLUMEDOWN** = **16777284** --- Volume down key
- **KEY_VOLUMEMUTE** = **16777285** --- Mute volume key
- **KEY_VOLUMEUP** = **16777286** --- Volume up key
- **KEY_BASSBOOST** = **16777287** --- Bass Boost Key
- **KEY_BASSUP** = **16777288** --- Bass Up Key
- **KEY_BASSDOWN** = **16777289** --- Bass Down Key
- **KEY_TREBLEUP** = **16777290** --- Treble Up Key
- **KEY_TREBLEDOWN** = **16777291** --- Treble Down Key
- **KEY_MEDIAPLAY** = **16777292** --- Media play key
- **KEY_MEDIASTOP** = **16777293** --- Media stop key
- **KEY_MEDIAPREVIOUS** = **16777294** --- Previous song key
- **KEY_MEDIANEXT** = **16777295** --- Next song key
- **KEY_MEDIARECORD** = **16777296** --- Media record key
- **KEY_HOMEPAGE** = **16777297** --- Home page key
- **KEY_FAVORITES** = **16777298** --- Favorites key
- **KEY_SEARCH** = **16777299** --- Search key
- **KEY_STANDBY** = **16777300** --- Standby Key
- **KEY_OPENURL** = **16777301** --- Open URL / Launch Browser Key
- **KEY_LAUNCHMAIL** = **16777302** --- Launch Mail Key
- **KEY_LAUNCHMEDIA** = **16777303** --- Launch Media Key
- **KEY_LAUNCH0** = **16777304** --- Launch Shortcut 0 Key
- **KEY_LAUNCH1** = **16777305** --- Launch Shortcut 1 Key
- **KEY_LAUNCH2** = **16777306** --- Launch Shortcut 2 Key
- **KEY_LAUNCH3** = **16777307** --- Launch Shortcut 3 Key
- **KEY_LAUNCH4** = **16777308** --- Launch Shortcut 4 Key
- **KEY_LAUNCH5** = **16777309** --- Launch Shortcut 5 Key
- **KEY_LAUNCH6** = **16777310** --- Launch Shortcut 6 Key
- **KEY_LAUNCH7** = **16777311** --- Launch Shortcut 7 Key
- **KEY_LAUNCH8** = **16777312** --- Launch Shortcut 8 Key
- **KEY_LAUNCH9** = **16777313** --- Launch Shortcut 9 Key
- **KEY_LAUNCHA** = **16777314** --- Launch Shortcut A Key
- **KEY_LAUNCHB** = **16777315** --- Launch Shortcut B Key
- **KEY_LAUNCHC** = **16777316** --- Launch Shortcut C Key
- **KEY_LAUNCHD** = **16777317** --- Launch Shortcut D Key
- **KEY_LAUNCHE** = **16777318** --- Launch Shortcut E Key
- **KEY_LAUNCHF** = **16777319** --- Launch Shortcut F Key
- **KEY_UNKNOWN** = **33554431** --- Unknown Key
- **KEY_SPACE** = **32** --- Space Key
- **KEY_EXCLAM** = **33** --- ! key
- **KEY_QUOTEDBL** = **34** --- " key
- **KEY_NUMBERSIGN** = **35** --- # key
- **KEY_DOLLAR** = **36** --- $ key
- **KEY_PERCENT** = **37** --- % key
- **KEY_AMPERSAND** = **38** --- & key
- **KEY_APOSTROPHE** = **39** --- ' key
- **KEY_PARENLEFT** = **40** --- ( key
- **KEY_PARENRIGHT** = **41** --- ) key
- **KEY_ASTERISK** = **42** --- \* key
- **KEY_PLUS** = **43** --- + key
- **KEY_COMMA** = **44** --- , key
- **KEY_MINUS** = **45** --- - key
- **KEY_PERIOD** = **46** --- . key
- **KEY_SLASH** = **47** --- / key
- **KEY_0** = **48** --- Number 0
- **KEY_1** = **49** --- Number 1
- **KEY_2** = **50** --- Number 2
- **KEY_3** = **51** --- Number 3
- **KEY_4** = **52** --- Number 4
- **KEY_5** = **53** --- Number 5
- **KEY_6** = **54** --- Number 6
- **KEY_7** = **55** --- Number 7
- **KEY_8** = **56** --- Number 8
- **KEY_9** = **57** --- Number 9
- **KEY_COLON** = **58** --- : key
- **KEY_SEMICOLON** = **59** --- ; key
- **KEY_LESS** = **60** --- Lower than key
- **KEY_EQUAL** = **61** --- = key
- **KEY_GREATER** = **62** --- Greater than key
- **KEY_QUESTION** = **63** --- ? key
- **KEY_AT** = **64** --- @ key
- **KEY_A** = **65** --- A Key
- **KEY_B** = **66** --- B Key
- **KEY_C** = **67** --- C Key
- **KEY_D** = **68** --- D Key
- **KEY_E** = **69** --- E Key
- **KEY_F** = **70** --- F Key
- **KEY_G** = **71** --- G Key
- **KEY_H** = **72** --- H Key
- **KEY_I** = **73** --- I Key
- **KEY_J** = **74** --- J Key
- **KEY_K** = **75** --- K Key
- **KEY_L** = **76** --- L Key
- **KEY_M** = **77** --- M Key
- **KEY_N** = **78** --- N Key
- **KEY_O** = **79** --- O Key
- **KEY_P** = **80** --- P Key
- **KEY_Q** = **81** --- Q Key
- **KEY_R** = **82** --- R Key
- **KEY_S** = **83** --- S Key
- **KEY_T** = **84** --- T Key
- **KEY_U** = **85** --- U Key
- **KEY_V** = **86** --- V Key
- **KEY_W** = **87** --- W Key
- **KEY_X** = **88** --- X Key
- **KEY_Y** = **89** --- Y Key
- **KEY_Z** = **90** --- Z Key
- **KEY_BRACKETLEFT** = **91** --- [ key
- **KEY_BACKSLASH** = **92** --- \\ key
- **KEY_BRACKETRIGHT** = **93** --- ] key
- **KEY_ASCIICIRCUM** = **94** --- ^ key
- **KEY_UNDERSCORE** = **95** --- \_ key
- **KEY_QUOTELEFT** = **96** --- Left Quote Key
- **KEY_BRACELEFT** = **123** --- { key
- **KEY_BAR** = **124** --- | key
- **KEY_BRACERIGHT** = **125** --- } key
- **KEY_ASCIITILDE** = **126** --- ~ key
- **KEY_NOBREAKSPACE** = **160**
- **KEY_EXCLAMDOWN** = **161**
- **KEY_CENT** = **162** --- ¢ key
- **KEY_STERLING** = **163**
- **KEY_CURRENCY** = **164**
- **KEY_YEN** = **165** --- Yen Key
- **KEY_BROKENBAR** = **166** --- ¦ key
- **KEY_SECTION** = **167** --- § key
- **KEY_DIAERESIS** = **168** --- ¨ key
- **KEY_COPYRIGHT** = **169** --- © key
- **KEY_ORDFEMININE** = **170**
- **KEY_GUILLEMOTLEFT** = **171** --- « key
- **KEY_NOTSIGN** = **172** --- » key
- **KEY_HYPHEN** = **173** --- ‐ key
- **KEY_REGISTERED** = **174** --- ® key
- **KEY_MACRON** = **175** --- Macron Key
- **KEY_DEGREE** = **176** --- ° key
- **KEY_PLUSMINUS** = **177** --- ± key
- **KEY_TWOSUPERIOR** = **178** --- ² key
- **KEY_THREESUPERIOR** = **179** --- ³ key
- **KEY_ACUTE** = **180** --- ´ key
- **KEY_MU** = **181** --- µ key
- **KEY_PARAGRAPH** = **182** --- Paragraph Key
- **KEY_PERIODCENTERED** = **183** --- · key
- **KEY_CEDILLA** = **184** --- ¬ key
- **KEY_ONESUPERIOR** = **185** --- ¹ key
- **KEY_MASCULINE** = **186** --- ♂ key
- **KEY_GUILLEMOTRIGHT** = **187** --- » key
- **KEY_ONEQUARTER** = **188** --- ¼ key
- **KEY_ONEHALF** = **189** --- ½ key
- **KEY_THREEQUARTERS** = **190** --- ¾ key
- **KEY_QUESTIONDOWN** = **191** --- ¿ key
- **KEY_AGRAVE** = **192** --- à key
- **KEY_AACUTE** = **193** --- á key
- **KEY_ACIRCUMFLEX** = **194** --- â key
- **KEY_ATILDE** = **195** --- ã key
- **KEY_ADIAERESIS** = **196** --- ä key
- **KEY_ARING** = **197** --- å key
- **KEY_AE** = **198** --- æ key
- **KEY_CCEDILLA** = **199** --- ç key
- **KEY_EGRAVE** = **200** --- è key
- **KEY_EACUTE** = **201** --- é key
- **KEY_ECIRCUMFLEX** = **202** --- ê key
- **KEY_EDIAERESIS** = **203** --- ë key
- **KEY_IGRAVE** = **204** --- ì key
- **KEY_IACUTE** = **205** --- í key
- **KEY_ICIRCUMFLEX** = **206** --- î key
- **KEY_IDIAERESIS** = **207** --- ë key
- **KEY_ETH** = **208** --- ð key
- **KEY_NTILDE** = **209** --- ñ key
- **KEY_OGRAVE** = **210** --- ò key
- **KEY_OACUTE** = **211** --- ó key
- **KEY_OCIRCUMFLEX** = **212** --- ô key
- **KEY_OTILDE** = **213** --- õ key
- **KEY_ODIAERESIS** = **214** --- ö key
- **KEY_MULTIPLY** = **215** --- × key
- **KEY_OOBLIQUE** = **216** --- ø key
- **KEY_UGRAVE** = **217** --- ù key
- **KEY_UACUTE** = **218** --- ú key
- **KEY_UCIRCUMFLEX** = **219** --- û key
- **KEY_UDIAERESIS** = **220** --- ü key
- **KEY_YACUTE** = **221** --- ý key
- **KEY_THORN** = **222** --- þ key
- **KEY_SSHARP** = **223** --- ß key
- **KEY_DIVISION** = **247** --- ÷ key
- **KEY_YDIAERESIS** = **255** --- ÿ key

  .. _enum_@GlobalScope_Variant.Type:

enum **Variant.Type**

- **TYPE_NIL** = **0** --- Variable is of type nil (only applied for null).
- **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool<class_bool>`.
- **TYPE_INT** = **2** --- Variable is of type :ref:`int<class_int>`.
- **TYPE_REAL** = **3** --- Variable is of type :ref:`float<class_float>`/real.
- **TYPE_STRING** = **4** --- Variable is of type :ref:`String<class_String>`.
- **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2<class_Vector2>`.
- **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2<class_Rect2>`.
- **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3<class_Vector3>`.
- **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D<class_Transform2D>`.
- **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane<class_Plane>`.
- **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat<class_Quat>`.
- **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB<class_AABB>`.
- **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis<class_Basis>`.
- **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform<class_Transform>`.
- **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color<class_Color>`.
- **TYPE_NODE_PATH** = **15** --- Variable is of type :ref:`NodePath<class_NodePath>`.
- **TYPE_RID** = **16** --- Variable is of type :ref:`RID<class_RID>`.
- **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object<class_Object>`.
- **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary<class_Dictionary>`.
- **TYPE_ARRAY** = **19** --- Variable is of type :ref:`Array<class_Array>`.
- **TYPE_RAW_ARRAY** = **20** --- Variable is of type :ref:`PoolByteArray<class_PoolByteArray>`.
- **TYPE_INT_ARRAY** = **21** --- Variable is of type :ref:`PoolIntArray<class_PoolIntArray>`.
- **TYPE_REAL_ARRAY** = **22** --- Variable is of type :ref:`PoolRealArray<class_PoolRealArray>`.
- **TYPE_STRING_ARRAY** = **23** --- Variable is of type :ref:`PoolStringArray<class_PoolStringArray>`.
- **TYPE_VECTOR2_ARRAY** = **24** --- Variable is of type :ref:`PoolVector2Array<class_PoolVector2Array>`.
- **TYPE_VECTOR3_ARRAY** = **25** --- Variable is of type :ref:`PoolVector3Array<class_PoolVector3Array>`.
- **TYPE_COLOR_ARRAY** = **26** --- Variable is of type :ref:`PoolColorArray<class_PoolColorArray>`.
- **TYPE_MAX** = **27** --- Marker for end of type constants.

  .. _enum_@GlobalScope_Margin:

enum **Margin**

- **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
- **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
- **MARGIN_RIGHT** = **2** --- Right margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
- **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.

  .. _enum_@GlobalScope_ButtonList:

enum **ButtonList**

- **BUTTON_LEFT** = **1** --- Left Mouse Button
- **BUTTON_RIGHT** = **2** --- Right Mouse Button
- **BUTTON_MIDDLE** = **3** --- Middle Mouse Button
- **BUTTON_XBUTTON1** = **8**
- **BUTTON_XBUTTON2** = **9**
- **BUTTON_WHEEL_UP** = **4** --- Mouse wheel up
- **BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down
- **BUTTON_WHEEL_LEFT** = **6** --- Mouse wheel left button
- **BUTTON_WHEEL_RIGHT** = **7** --- Mouse wheel right button
- **BUTTON_MASK_LEFT** = **1** --- Left Mouse Button Mask
- **BUTTON_MASK_RIGHT** = **2** --- Right Mouse Button Mask
- **BUTTON_MASK_MIDDLE** = **4** --- Middle Mouse Button Mask
- **BUTTON_MASK_XBUTTON1** = **128**
- **BUTTON_MASK_XBUTTON2** = **256**


Constants
---------

- **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable.

Description
-----------

Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, scancodes, property hints, etc. It's not much.

Singletons are also documented here, since they can be accessed from anywhere.

Property Descriptions
---------------------

  .. _class_@GlobalScope_ARVRServer:

- :ref:`ARVRServer<class_ARVRServer>` **ARVRServer** - :ref:`ARVRServer<class_ARVRServer>` singleton

  .. _class_@GlobalScope_AudioServer:

- :ref:`AudioServer<class_AudioServer>` **AudioServer** - :ref:`AudioServer<class_AudioServer>` singleton

  .. _class_@GlobalScope_ClassDB:

- :ref:`ClassDB<class_ClassDB>` **ClassDB** - :ref:`ClassDB<class_ClassDB>` singleton

  .. _class_@GlobalScope_Engine:

- :ref:`Engine<class_Engine>` **Engine** - :ref:`Engine<class_Engine>` singleton

  .. _class_@GlobalScope_Geometry:

- :ref:`Geometry<class_Geometry>` **Geometry** - :ref:`Geometry<class_Geometry>` singleton

  .. _class_@GlobalScope_GodotSharp:

- :ref:`GodotSharp<class_GodotSharp>` **GodotSharp**

  .. _class_@GlobalScope_IP:

- :ref:`IP<class_IP>` **IP** - :ref:`IP<class_IP>` singleton

  .. _class_@GlobalScope_Input:

- :ref:`Input<class_Input>` **Input** - :ref:`Input<class_Input>` singleton

  .. _class_@GlobalScope_InputMap:

- :ref:`InputMap<class_InputMap>` **InputMap** - :ref:`InputMap<class_InputMap>` singleton

  .. _class_@GlobalScope_JSON:

- :ref:`JSON<class_JSON>` **JSON** - :ref:`JSON<class_JSON>` singleton

  .. _class_@GlobalScope_JavaScript:

- :ref:`JavaScript<class_JavaScript>` **JavaScript** - :ref:`JavaScript<class_JavaScript>` singleton

  .. _class_@GlobalScope_Marshalls:

- :ref:`Reference<class_Reference>` **Marshalls** - :ref:`Marshalls<class_Marshalls>` singleton

  .. _class_@GlobalScope_OS:

- :ref:`OS<class_OS>` **OS** - :ref:`OS<class_OS>` singleton

  .. _class_@GlobalScope_Performance:

- :ref:`Performance<class_Performance>` **Performance** - :ref:`Performance<class_Performance>` singleton

  .. _class_@GlobalScope_Physics2DServer:

- :ref:`Physics2DServer<class_Physics2DServer>` **Physics2DServer** - :ref:`Physics2DServer<class_Physics2DServer>` singleton

  .. _class_@GlobalScope_PhysicsServer:

- :ref:`PhysicsServer<class_PhysicsServer>` **PhysicsServer** - :ref:`PhysicsServer<class_PhysicsServer>` singleton

  .. _class_@GlobalScope_ProjectSettings:

- :ref:`ProjectSettings<class_ProjectSettings>` **ProjectSettings** - :ref:`ProjectSettings<class_ProjectSettings>` singleton

  .. _class_@GlobalScope_ResourceLoader:

- :ref:`ResourceLoader<class_ResourceLoader>` **ResourceLoader** - :ref:`ResourceLoader<class_ResourceLoader>` singleton

  .. _class_@GlobalScope_ResourceSaver:

- :ref:`ResourceSaver<class_ResourceSaver>` **ResourceSaver** - :ref:`ResourceSaver<class_ResourceSaver>` singleton

  .. _class_@GlobalScope_TranslationServer:

- :ref:`TranslationServer<class_TranslationServer>` **TranslationServer** - :ref:`TranslationServer<class_TranslationServer>` singleton

  .. _class_@GlobalScope_VisualScriptEditor:

- :ref:`VisualScriptEditor<class_VisualScriptEditor>` **VisualScriptEditor** - :ref:`VisualScriptEditor<class_VisualScriptEditor>` singleton

  .. _class_@GlobalScope_VisualServer:

- :ref:`VisualServer<class_VisualServer>` **VisualServer** - :ref:`VisualServer<class_VisualServer>` singleton