[email protected] 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the @GlobalScope.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_@GlobalScope:
  5. @GlobalScope
  6. ============
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Global scope constants and variables.
  11. Member Variables
  12. ----------------
  13. .. _class_@GlobalScope_ARVRServer:
  14. - :ref:`ARVRServer<class_arvrserver>` **ARVRServer** - :ref:`ARVRServer<class_arvrserver>` singleton
  15. .. _class_@GlobalScope_AudioServer:
  16. - :ref:`AudioServer<class_audioserver>` **AudioServer** - :ref:`AudioServer<class_audioserver>` singleton
  17. .. _class_@GlobalScope_ClassDB:
  18. - :ref:`ClassDB<class_classdb>` **ClassDB** - :ref:`ClassDB<class_classdb>` singleton
  19. .. _class_@GlobalScope_Engine:
  20. - :ref:`Engine<class_engine>` **Engine** - :ref:`Engine<class_engine>` singleton
  21. .. _class_@GlobalScope_Geometry:
  22. - :ref:`Geometry<class_geometry>` **Geometry** - :ref:`Geometry<class_geometry>` singleton
  23. .. _class_@GlobalScope_GodotSharp:
  24. - :ref:`GodotSharp<class_godotsharp>` **GodotSharp** - :ref:`GodotSharp<class_godotsharp>` singleton
  25. .. _class_@GlobalScope_IP:
  26. - :ref:`IP<class_ip>` **IP** - :ref:`IP<class_ip>` singleton
  27. .. _class_@GlobalScope_Input:
  28. - :ref:`Input<class_input>` **Input** - :ref:`Input<class_input>` singleton
  29. .. _class_@GlobalScope_InputMap:
  30. - :ref:`InputMap<class_inputmap>` **InputMap** - :ref:`InputMap<class_inputmap>` singleton
  31. .. _class_@GlobalScope_JSON:
  32. - :ref:`JSON<class_json>` **JSON** - :ref:`JSON<class_json>` singleton
  33. .. _class_@GlobalScope_JavaScript:
  34. - :ref:`JavaScript<class_javascript>` **JavaScript**
  35. .. _class_@GlobalScope_Marshalls:
  36. - :ref:`Reference<class_reference>` **Marshalls** - :ref:`Marshalls<class_marshalls>` singleton
  37. .. _class_@GlobalScope_OS:
  38. - :ref:`OS<class_os>` **OS** - :ref:`OS<class_os>` singleton
  39. .. _class_@GlobalScope_Performance:
  40. - :ref:`Performance<class_performance>` **Performance** - :ref:`Performance<class_performance>` singleton
  41. .. _class_@GlobalScope_Physics2DServer:
  42. - :ref:`Physics2DServer<class_physics2dserver>` **Physics2DServer** - :ref:`Physics2DServer<class_physics2dserver>` singleton
  43. .. _class_@GlobalScope_PhysicsServer:
  44. - :ref:`PhysicsServer<class_physicsserver>` **PhysicsServer** - :ref:`PhysicsServer<class_physicsserver>` singleton
  45. .. _class_@GlobalScope_ProjectSettings:
  46. - :ref:`ProjectSettings<class_projectsettings>` **ProjectSettings** - :ref:`ProjectSettings<class_projectsettings>` singleton
  47. .. _class_@GlobalScope_ResourceLoader:
  48. - :ref:`ResourceLoader<class_resourceloader>` **ResourceLoader** - :ref:`ResourceLoader<class_resourceloader>` singleton
  49. .. _class_@GlobalScope_ResourceSaver:
  50. - :ref:`ResourceSaver<class_resourcesaver>` **ResourceSaver** - :ref:`ResourceSaver<class_resourcesaver>` singleton
  51. .. _class_@GlobalScope_TranslationServer:
  52. - :ref:`TranslationServer<class_translationserver>` **TranslationServer** - :ref:`TranslationServer<class_translationserver>` singleton
  53. .. _class_@GlobalScope_VisualScriptEditor:
  54. - :ref:`VisualScriptEditor<class_visualscripteditor>` **VisualScriptEditor** - :ref:`VisualScriptEditor<class_visualscripteditor>` singleton
  55. .. _class_@GlobalScope_VisualServer:
  56. - :ref:`VisualServer<class_visualserver>` **VisualServer** - :ref:`VisualServer<class_visualserver>` singleton
  57. Numeric Constants
  58. -----------------
  59. - **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
  60. - **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
  61. - **MARGIN_RIGHT** = **2** --- Right margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
  62. - **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
  63. - **CORNER_TOP_LEFT** = **0**
  64. - **CORNER_TOP_RIGHT** = **1**
  65. - **CORNER_BOTTOM_RIGHT** = **2**
  66. - **CORNER_BOTTOM_LEFT** = **3**
  67. - **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator<class_separator>`, :ref:`ScrollBar<class_scrollbar>`, :ref:`Slider<class_slider>`, etc.
  68. - **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator<class_separator>`, :ref:`ScrollBar<class_scrollbar>`, :ref:`Slider<class_slider>`, etc.
  69. - **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes.
  70. - **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes.
  71. - **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes.
  72. - **VALIGN_TOP** = **0** --- Vertical top alignment, usually for text-derived classes.
  73. - **VALIGN_CENTER** = **1** --- Vertical center alignment, usually for text-derived classes.
  74. - **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes.
  75. - **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable.
  76. - **KEY_ESCAPE** = **16777217** --- Escape Key
  77. - **KEY_TAB** = **16777218** --- Tab Key
  78. - **KEY_BACKTAB** = **16777219** --- Shift-Tab Key
  79. - **KEY_BACKSPACE** = **16777220** --- Backspace Key
  80. - **KEY_ENTER** = **16777221** --- Return Key (On Main Keyboard)
  81. - **KEY_KP_ENTER** = **16777222** --- Enter Key (On Numpad)
  82. - **KEY_INSERT** = **16777223** --- Insert Key
  83. - **KEY_DELETE** = **16777224** --- Delete Key
  84. - **KEY_PAUSE** = **16777225** --- Pause Key
  85. - **KEY_PRINT** = **16777226** --- Printscreen Key
  86. - **KEY_SYSREQ** = **16777227** --- System Request Key
  87. - **KEY_CLEAR** = **16777228** --- Clear Key
  88. - **KEY_HOME** = **16777229** --- Home Key
  89. - **KEY_END** = **16777230** --- End Key
  90. - **KEY_LEFT** = **16777231** --- Left Arrow Key
  91. - **KEY_UP** = **16777232** --- Up Arrow Key
  92. - **KEY_RIGHT** = **16777233** --- Right Arrow Key
  93. - **KEY_DOWN** = **16777234** --- Down Arrow Key
  94. - **KEY_PAGEUP** = **16777235** --- Pageup Key
  95. - **KEY_PAGEDOWN** = **16777236** --- Pagedown Key
  96. - **KEY_SHIFT** = **16777237** --- Shift Key
  97. - **KEY_CONTROL** = **16777238** --- Control Key
  98. - **KEY_META** = **16777239** --- Meta Key
  99. - **KEY_ALT** = **16777240** --- Alt Key
  100. - **KEY_CAPSLOCK** = **16777241** --- Capslock Key
  101. - **KEY_NUMLOCK** = **16777242** --- Numlock Key
  102. - **KEY_SCROLLLOCK** = **16777243** --- Scrolllock Key
  103. - **KEY_F1** = **16777244** --- F1 Key
  104. - **KEY_F2** = **16777245** --- F2 Key
  105. - **KEY_F3** = **16777246** --- F3 Key
  106. - **KEY_F4** = **16777247** --- F4 Key
  107. - **KEY_F5** = **16777248** --- F5 Key
  108. - **KEY_F6** = **16777249** --- F6 Key
  109. - **KEY_F7** = **16777250** --- F7 Key
  110. - **KEY_F8** = **16777251** --- F8 Key
  111. - **KEY_F9** = **16777252** --- F9 Key
  112. - **KEY_F10** = **16777253** --- F10 Key
  113. - **KEY_F11** = **16777254** --- F11 Key
  114. - **KEY_F12** = **16777255** --- F12 Key
  115. - **KEY_F13** = **16777256** --- F13 Key
  116. - **KEY_F14** = **16777257** --- F14 Key
  117. - **KEY_F15** = **16777258** --- F15 Key
  118. - **KEY_F16** = **16777259** --- F16 Key
  119. - **KEY_KP_MULTIPLY** = **16777345** --- Multiply Key on Numpad
  120. - **KEY_KP_DIVIDE** = **16777346** --- Divide Key on Numpad
  121. - **KEY_KP_SUBTRACT** = **16777347** --- Subtract Key on Numpad
  122. - **KEY_KP_PERIOD** = **16777348** --- Period Key on Numpad
  123. - **KEY_KP_ADD** = **16777349** --- Add Key on Numpad
  124. - **KEY_KP_0** = **16777350** --- Number 0 on Numpad
  125. - **KEY_KP_1** = **16777351** --- Number 1 on Numpad
  126. - **KEY_KP_2** = **16777352** --- Number 2 on Numpad
  127. - **KEY_KP_3** = **16777353** --- Number 3 on Numpad
  128. - **KEY_KP_4** = **16777354** --- Number 4 on Numpad
  129. - **KEY_KP_5** = **16777355** --- Number 5 on Numpad
  130. - **KEY_KP_6** = **16777356** --- Number 6 on Numpad
  131. - **KEY_KP_7** = **16777357** --- Number 7 on Numpad
  132. - **KEY_KP_8** = **16777358** --- Number 8 on Numpad
  133. - **KEY_KP_9** = **16777359** --- Number 9 on Numpad
  134. - **KEY_SUPER_L** = **16777260** --- Left Super Key (Windows Key)
  135. - **KEY_SUPER_R** = **16777261** --- Right Super Key (Windows Key)
  136. - **KEY_MENU** = **16777262** --- Context menu key
  137. - **KEY_HYPER_L** = **16777263** --- Left Hyper Key
  138. - **KEY_HYPER_R** = **16777264** --- Right Hyper Key
  139. - **KEY_HELP** = **16777265** --- Help key
  140. - **KEY_DIRECTION_L** = **16777266** --- Left Direction Key
  141. - **KEY_DIRECTION_R** = **16777267** --- Right Direction Key
  142. - **KEY_BACK** = **16777280** --- Back key
  143. - **KEY_FORWARD** = **16777281** --- Forward key
  144. - **KEY_STOP** = **16777282** --- Stop key
  145. - **KEY_REFRESH** = **16777283** --- Refresh key
  146. - **KEY_VOLUMEDOWN** = **16777284** --- Volume down key
  147. - **KEY_VOLUMEMUTE** = **16777285** --- Mute volume key
  148. - **KEY_VOLUMEUP** = **16777286** --- Volume up key
  149. - **KEY_BASSBOOST** = **16777287** --- Bass Boost Key
  150. - **KEY_BASSUP** = **16777288** --- Bass Up Key
  151. - **KEY_BASSDOWN** = **16777289** --- Bass Down Key
  152. - **KEY_TREBLEUP** = **16777290** --- Treble Up Key
  153. - **KEY_TREBLEDOWN** = **16777291** --- Treble Down Key
  154. - **KEY_MEDIAPLAY** = **16777292** --- Media play key
  155. - **KEY_MEDIASTOP** = **16777293** --- Media stop key
  156. - **KEY_MEDIAPREVIOUS** = **16777294** --- Previous song key
  157. - **KEY_MEDIANEXT** = **16777295** --- Next song key
  158. - **KEY_MEDIARECORD** = **16777296** --- Media record key
  159. - **KEY_HOMEPAGE** = **16777297** --- Home page key
  160. - **KEY_FAVORITES** = **16777298** --- Favorites key
  161. - **KEY_SEARCH** = **16777299** --- Search key
  162. - **KEY_STANDBY** = **16777300** --- Standby Key
  163. - **KEY_OPENURL** = **16777301** --- Open URL / Launch Browser Key
  164. - **KEY_LAUNCHMAIL** = **16777302** --- Launch Mail Key
  165. - **KEY_LAUNCHMEDIA** = **16777303** --- Launch Media Key
  166. - **KEY_LAUNCH0** = **16777304** --- Launch Shortcut 0 Key
  167. - **KEY_LAUNCH1** = **16777305** --- Launch Shortcut 1 Key
  168. - **KEY_LAUNCH2** = **16777306** --- Launch Shortcut 2 Key
  169. - **KEY_LAUNCH3** = **16777307** --- Launch Shortcut 3 Key
  170. - **KEY_LAUNCH4** = **16777308** --- Launch Shortcut 4 Key
  171. - **KEY_LAUNCH5** = **16777309** --- Launch Shortcut 5 Key
  172. - **KEY_LAUNCH6** = **16777310** --- Launch Shortcut 6 Key
  173. - **KEY_LAUNCH7** = **16777311** --- Launch Shortcut 7 Key
  174. - **KEY_LAUNCH8** = **16777312** --- Launch Shortcut 8 Key
  175. - **KEY_LAUNCH9** = **16777313** --- Launch Shortcut 9 Key
  176. - **KEY_LAUNCHA** = **16777314** --- Launch Shortcut A Key
  177. - **KEY_LAUNCHB** = **16777315** --- Launch Shortcut B Key
  178. - **KEY_LAUNCHC** = **16777316** --- Launch Shortcut C Key
  179. - **KEY_LAUNCHD** = **16777317** --- Launch Shortcut D Key
  180. - **KEY_LAUNCHE** = **16777318** --- Launch Shortcut E Key
  181. - **KEY_LAUNCHF** = **16777319** --- Launch Shortcut F Key
  182. - **KEY_UNKNOWN** = **33554431** --- Unknown Key
  183. - **KEY_SPACE** = **32** --- Space Key
  184. - **KEY_EXCLAM** = **33** --- ! key
  185. - **KEY_QUOTEDBL** = **34** --- " key
  186. - **KEY_NUMBERSIGN** = **35** --- # key
  187. - **KEY_DOLLAR** = **36** --- $ key
  188. - **KEY_PERCENT** = **37** --- % key
  189. - **KEY_AMPERSAND** = **38** --- & key
  190. - **KEY_APOSTROPHE** = **39** --- ' key
  191. - **KEY_PARENLEFT** = **40** --- ( key
  192. - **KEY_PARENRIGHT** = **41** --- ) key
  193. - **KEY_ASTERISK** = **42** --- \* key
  194. - **KEY_PLUS** = **43** --- + key
  195. - **KEY_COMMA** = **44** --- , key
  196. - **KEY_MINUS** = **45** --- - key
  197. - **KEY_PERIOD** = **46** --- . key
  198. - **KEY_SLASH** = **47** --- / key
  199. - **KEY_0** = **48** --- Number 0
  200. - **KEY_1** = **49** --- Number 1
  201. - **KEY_2** = **50** --- Number 2
  202. - **KEY_3** = **51** --- Number 3
  203. - **KEY_4** = **52** --- Number 4
  204. - **KEY_5** = **53** --- Number 5
  205. - **KEY_6** = **54** --- Number 6
  206. - **KEY_7** = **55** --- Number 7
  207. - **KEY_8** = **56** --- Number 8
  208. - **KEY_9** = **57** --- Number 9
  209. - **KEY_COLON** = **58** --- : key
  210. - **KEY_SEMICOLON** = **59** --- ; key
  211. - **KEY_LESS** = **60** --- Lower than key
  212. - **KEY_EQUAL** = **61** --- = key
  213. - **KEY_GREATER** = **62** --- Greater than key
  214. - **KEY_QUESTION** = **63** --- ? key
  215. - **KEY_AT** = **64** --- @ key
  216. - **KEY_A** = **65** --- A Key
  217. - **KEY_B** = **66** --- B Key
  218. - **KEY_C** = **67** --- C Key
  219. - **KEY_D** = **68** --- D Key
  220. - **KEY_E** = **69** --- E Key
  221. - **KEY_F** = **70** --- F Key
  222. - **KEY_G** = **71** --- G Key
  223. - **KEY_H** = **72** --- H Key
  224. - **KEY_I** = **73** --- I Key
  225. - **KEY_J** = **74** --- J Key
  226. - **KEY_K** = **75** --- K Key
  227. - **KEY_L** = **76** --- L Key
  228. - **KEY_M** = **77** --- M Key
  229. - **KEY_N** = **78** --- N Key
  230. - **KEY_O** = **79** --- O Key
  231. - **KEY_P** = **80** --- P Key
  232. - **KEY_Q** = **81** --- Q Key
  233. - **KEY_R** = **82** --- R Key
  234. - **KEY_S** = **83** --- S Key
  235. - **KEY_T** = **84** --- T Key
  236. - **KEY_U** = **85** --- U Key
  237. - **KEY_V** = **86** --- V Key
  238. - **KEY_W** = **87** --- W Key
  239. - **KEY_X** = **88** --- X Key
  240. - **KEY_Y** = **89** --- Y Key
  241. - **KEY_Z** = **90** --- Z Key
  242. - **KEY_BRACKETLEFT** = **91** --- [ key
  243. - **KEY_BACKSLASH** = **92** --- \ key
  244. - **KEY_BRACKETRIGHT** = **93** --- ] key
  245. - **KEY_ASCIICIRCUM** = **94** --- ^ key
  246. - **KEY_UNDERSCORE** = **95** --- \_ key
  247. - **KEY_QUOTELEFT** = **96** --- Left Quote Key
  248. - **KEY_BRACELEFT** = **123** --- { key
  249. - **KEY_BAR** = **124** --- | key
  250. - **KEY_BRACERIGHT** = **125** --- } key
  251. - **KEY_ASCIITILDE** = **126** --- ~ key
  252. - **KEY_NOBREAKSPACE** = **160**
  253. - **KEY_EXCLAMDOWN** = **161**
  254. - **KEY_CENT** = **162** --- ¢ key
  255. - **KEY_STERLING** = **163**
  256. - **KEY_CURRENCY** = **164**
  257. - **KEY_YEN** = **165** --- Yen Key
  258. - **KEY_BROKENBAR** = **166** --- ¦ key
  259. - **KEY_SECTION** = **167** --- § key
  260. - **KEY_DIAERESIS** = **168** --- ¨ key
  261. - **KEY_COPYRIGHT** = **169** --- © key
  262. - **KEY_ORDFEMININE** = **170**
  263. - **KEY_GUILLEMOTLEFT** = **171** --- « key
  264. - **KEY_NOTSIGN** = **172** --- » key
  265. - **KEY_HYPHEN** = **173** --- ‐ key
  266. - **KEY_REGISTERED** = **174** --- ® key
  267. - **KEY_MACRON** = **175** --- Macron Key
  268. - **KEY_DEGREE** = **176** --- ° key
  269. - **KEY_PLUSMINUS** = **177** --- ± key
  270. - **KEY_TWOSUPERIOR** = **178** --- ² key
  271. - **KEY_THREESUPERIOR** = **179** --- ³ key
  272. - **KEY_ACUTE** = **180** --- ´ key
  273. - **KEY_MU** = **181** --- µ key
  274. - **KEY_PARAGRAPH** = **182** --- Paragraph Key
  275. - **KEY_PERIODCENTERED** = **183** --- · key
  276. - **KEY_CEDILLA** = **184** --- ¬ key
  277. - **KEY_ONESUPERIOR** = **185** --- ¹ key
  278. - **KEY_MASCULINE** = **186** --- ♂ key
  279. - **KEY_GUILLEMOTRIGHT** = **187** --- » key
  280. - **KEY_ONEQUARTER** = **188** --- ¼ key
  281. - **KEY_ONEHALF** = **189** --- ½ key
  282. - **KEY_THREEQUARTERS** = **190** --- ¾ key
  283. - **KEY_QUESTIONDOWN** = **191** --- ¿ key
  284. - **KEY_AGRAVE** = **192** --- à key
  285. - **KEY_AACUTE** = **193** --- á key
  286. - **KEY_ACIRCUMFLEX** = **194** --- â key
  287. - **KEY_ATILDE** = **195** --- ã key
  288. - **KEY_ADIAERESIS** = **196** --- ä key
  289. - **KEY_ARING** = **197** --- å key
  290. - **KEY_AE** = **198** --- æ key
  291. - **KEY_CCEDILLA** = **199** --- ç key
  292. - **KEY_EGRAVE** = **200** --- è key
  293. - **KEY_EACUTE** = **201** --- é key
  294. - **KEY_ECIRCUMFLEX** = **202** --- ê key
  295. - **KEY_EDIAERESIS** = **203** --- ë key
  296. - **KEY_IGRAVE** = **204** --- ì key
  297. - **KEY_IACUTE** = **205** --- í key
  298. - **KEY_ICIRCUMFLEX** = **206** --- î key
  299. - **KEY_IDIAERESIS** = **207** --- ë key
  300. - **KEY_ETH** = **208** --- ð key
  301. - **KEY_NTILDE** = **209** --- ñ key
  302. - **KEY_OGRAVE** = **210** --- ò key
  303. - **KEY_OACUTE** = **211** --- ó key
  304. - **KEY_OCIRCUMFLEX** = **212** --- ô key
  305. - **KEY_OTILDE** = **213** --- õ key
  306. - **KEY_ODIAERESIS** = **214** --- ö key
  307. - **KEY_MULTIPLY** = **215** --- × key
  308. - **KEY_OOBLIQUE** = **216** --- ø key
  309. - **KEY_UGRAVE** = **217** --- ù key
  310. - **KEY_UACUTE** = **218** --- ú key
  311. - **KEY_UCIRCUMFLEX** = **219** --- û key
  312. - **KEY_UDIAERESIS** = **220** --- ü key
  313. - **KEY_YACUTE** = **221** --- ý key
  314. - **KEY_THORN** = **222** --- þ key
  315. - **KEY_SSHARP** = **223** --- ß key
  316. - **KEY_DIVISION** = **247** --- ÷ key
  317. - **KEY_YDIAERESIS** = **255** --- ÿ key
  318. - **KEY_CODE_MASK** = **33554431** --- Key Code Mask
  319. - **KEY_MODIFIER_MASK** = **-16777216** --- Modifier Key Mask
  320. - **KEY_MASK_SHIFT** = **33554432** --- Shift Key Mask
  321. - **KEY_MASK_ALT** = **67108864** --- Alt Key Mask
  322. - **KEY_MASK_META** = **134217728** --- Meta Key Mask
  323. - **KEY_MASK_CTRL** = **268435456** --- CTRL Key Mask
  324. - **KEY_MASK_CMD** = **268435456** --- CMD Key Mask
  325. - **KEY_MASK_KPAD** = **536870912** --- Keypad Key Mask
  326. - **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask
  327. - **BUTTON_LEFT** = **1** --- Left Mouse Button
  328. - **BUTTON_RIGHT** = **2** --- Right Mouse Button
  329. - **BUTTON_MIDDLE** = **3** --- Middle Mouse Button
  330. - **BUTTON_WHEEL_UP** = **4** --- Mouse wheel up
  331. - **BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down
  332. - **BUTTON_WHEEL_LEFT** = **6** --- Mouse wheel left button
  333. - **BUTTON_WHEEL_RIGHT** = **7** --- Mouse wheel right button
  334. - **BUTTON_MASK_LEFT** = **1** --- Left Mouse Button Mask
  335. - **BUTTON_MASK_RIGHT** = **2** --- Right Mouse Button Mask
  336. - **BUTTON_MASK_MIDDLE** = **4** --- Middle Mouse Button Mask
  337. - **JOY_BUTTON_0** = **0** --- Joypad Button 0
  338. - **JOY_BUTTON_1** = **1** --- Joypad Button 1
  339. - **JOY_BUTTON_2** = **2** --- Joypad Button 2
  340. - **JOY_BUTTON_3** = **3** --- Joypad Button 3
  341. - **JOY_BUTTON_4** = **4** --- Joypad Button 4
  342. - **JOY_BUTTON_5** = **5** --- Joypad Button 5
  343. - **JOY_BUTTON_6** = **6** --- Joypad Button 6
  344. - **JOY_BUTTON_7** = **7** --- Joypad Button 7
  345. - **JOY_BUTTON_8** = **8** --- Joypad Button 8
  346. - **JOY_BUTTON_9** = **9** --- Joypad Button 9
  347. - **JOY_BUTTON_10** = **10** --- Joypad Button 10
  348. - **JOY_BUTTON_11** = **11** --- Joypad Button 11
  349. - **JOY_BUTTON_12** = **12** --- Joypad Button 12
  350. - **JOY_BUTTON_13** = **13** --- Joypad Button 13
  351. - **JOY_BUTTON_14** = **14** --- Joypad Button 14
  352. - **JOY_BUTTON_15** = **15** --- Joypad Button 15
  353. - **JOY_BUTTON_MAX** = **16** --- Joypad Button 16
  354. - **JOY_SONY_CIRCLE** = **1** --- DUALSHOCK circle button
  355. - **JOY_SONY_X** = **0** --- DUALSHOCK X button
  356. - **JOY_SONY_SQUARE** = **2** --- DUALSHOCK square button
  357. - **JOY_SONY_TRIANGLE** = **3** --- DUALSHOCK triangle button
  358. - **JOY_XBOX_B** = **1** --- XBOX controller B button
  359. - **JOY_XBOX_A** = **0** --- XBOX controller A button
  360. - **JOY_XBOX_X** = **2** --- XBOX controller X button
  361. - **JOY_XBOX_Y** = **3** --- XBOX controller Y button
  362. - **JOY_DS_A** = **1** --- DualShock controller A button
  363. - **JOY_DS_B** = **0** --- DualShock controller B button
  364. - **JOY_DS_X** = **3** --- DualShock controller X button
  365. - **JOY_DS_Y** = **2** --- DualShock controller Y button
  366. - **JOY_SELECT** = **10** --- Joypad Button Select
  367. - **JOY_START** = **11** --- Joypad Button Start
  368. - **JOY_DPAD_UP** = **12** --- Joypad DPad Up
  369. - **JOY_DPAD_DOWN** = **13** --- Joypad DPad Down
  370. - **JOY_DPAD_LEFT** = **14** --- Joypad DPad Left
  371. - **JOY_DPAD_RIGHT** = **15** --- Joypad DPad Right
  372. - **JOY_L** = **4** --- Joypad Left Shoulder Button
  373. - **JOY_L2** = **6** --- Joypad Left Trigger
  374. - **JOY_L3** = **8** --- Joypad Left Stick Click
  375. - **JOY_R** = **5** --- Joypad Right Shoulder Button
  376. - **JOY_R2** = **7** --- Joypad Right Trigger
  377. - **JOY_R3** = **9** --- Joypad Right Stick Click
  378. - **JOY_AXIS_0** = **0** --- Joypad Left Stick Horizontal Axis
  379. - **JOY_AXIS_1** = **1** --- Joypad Left Stick Vertical Axis
  380. - **JOY_AXIS_2** = **2** --- Joypad Right Stick Horizontal Axis
  381. - **JOY_AXIS_3** = **3** --- Joypad Right Stick Vertical Axis
  382. - **JOY_AXIS_4** = **4**
  383. - **JOY_AXIS_5** = **5**
  384. - **JOY_AXIS_6** = **6** --- Joypad Left Trigger Analog Axis
  385. - **JOY_AXIS_7** = **7** --- Joypad Right Trigger Analog Axis
  386. - **JOY_AXIS_8** = **8**
  387. - **JOY_AXIS_9** = **9**
  388. - **JOY_AXIS_MAX** = **10**
  389. - **JOY_ANALOG_LX** = **0** --- Joypad Left Stick Horizontal Axis
  390. - **JOY_ANALOG_LY** = **1** --- Joypad Left Stick Vertical Axis
  391. - **JOY_ANALOG_RX** = **2** --- Joypad Right Stick Horizontal Axis
  392. - **JOY_ANALOG_RY** = **3** --- Joypad Right Stick Vertical Axis
  393. - **JOY_ANALOG_L2** = **6** --- Joypad Left Analog Trigger
  394. - **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger
  395. - **OK** = **0** --- Functions that return Error return OK when no error occured. Most functions don't return errors and/or just print errors to STDOUT.
  396. - **FAILED** = **1** --- Generic error.
  397. - **ERR_UNAVAILABLE** = **2** --- Unavailable error
  398. - **ERR_UNCONFIGURED** = **3** --- Unconfigured error
  399. - **ERR_UNAUTHORIZED** = **4** --- Unauthorized error
  400. - **ERR_PARAMETER_RANGE_ERROR** = **5** --- Parameter range error
  401. - **ERR_OUT_OF_MEMORY** = **6** --- Out of memory (OOM) error
  402. - **ERR_FILE_NOT_FOUND** = **7** --- File: Not found error
  403. - **ERR_FILE_BAD_DRIVE** = **8** --- File: Bad drive error
  404. - **ERR_FILE_BAD_PATH** = **9** --- File: Bad path error
  405. - **ERR_FILE_NO_PERMISSION** = **10** --- File: No permission error
  406. - **ERR_FILE_ALREADY_IN_USE** = **11** --- File: Already in use error
  407. - **ERR_FILE_CANT_OPEN** = **12** --- File: Can't open error
  408. - **ERR_FILE_CANT_WRITE** = **13** --- File: Can't write error
  409. - **ERR_FILE_CANT_READ** = **14** --- File: Can't read error
  410. - **ERR_FILE_UNRECOGNIZED** = **15** --- File: Unrecognized error
  411. - **ERR_FILE_CORRUPT** = **16** --- File: Corrupt error
  412. - **ERR_FILE_MISSING_DEPENDENCIES** = **17** --- File: Missing dependencies error
  413. - **ERR_FILE_EOF** = **18** --- File: End of file (EOF) error
  414. - **ERR_CANT_OPEN** = **19** --- Can't open error
  415. - **ERR_CANT_CREATE** = **20** --- Can't create error
  416. - **ERR_PARSE_ERROR** = **43** --- Parse error
  417. - **ERR_QUERY_FAILED** = **21** --- Query failed error
  418. - **ERR_ALREADY_IN_USE** = **22** --- Already in use error
  419. - **ERR_LOCKED** = **23** --- Locked error
  420. - **ERR_TIMEOUT** = **24** --- Timeout error
  421. - **ERR_CANT_ACQUIRE_RESOURCE** = **28** --- Can't acquire resource error
  422. - **ERR_INVALID_DATA** = **30** --- Invalid data error
  423. - **ERR_INVALID_PARAMETER** = **31** --- Invalid parameter error
  424. - **ERR_ALREADY_EXISTS** = **32** --- Already exists error
  425. - **ERR_DOES_NOT_EXIST** = **33** --- Does not exist error
  426. - **ERR_DATABASE_CANT_READ** = **34** --- Database: Read error
  427. - **ERR_DATABASE_CANT_WRITE** = **35** --- Database: Write error
  428. - **ERR_COMPILATION_FAILED** = **36** --- Compilation failed error
  429. - **ERR_METHOD_NOT_FOUND** = **37** --- Method not found error
  430. - **ERR_LINK_FAILED** = **38** --- Linking failed error
  431. - **ERR_SCRIPT_FAILED** = **39** --- Script failed error
  432. - **ERR_CYCLIC_LINK** = **40** --- Cycling link (import cycle) error
  433. - **ERR_BUSY** = **44** --- Busy error
  434. - **ERR_HELP** = **46** --- Help error
  435. - **ERR_BUG** = **47** --- Bug error
  436. - **PROPERTY_HINT_NONE** = **0** --- No hint for edited property.
  437. - **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.
  438. - **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.
  439. - **PROPERTY_HINT_ENUM** = **3** --- Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
  440. - **PROPERTY_HINT_EXP_EASING** = **4**
  441. - **PROPERTY_HINT_LENGTH** = **5**
  442. - **PROPERTY_HINT_KEY_ACCEL** = **7**
  443. - **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.
  444. - **PROPERTY_HINT_LAYERS_2D_RENDER** = **9**
  445. - **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10**
  446. - **PROPERTY_HINT_LAYERS_3D_RENDER** = **11**
  447. - **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12**
  448. - **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".
  449. - **PROPERTY_HINT_DIR** = **14** --- String property is a directory (so pop up a file dialog when edited).
  450. - **PROPERTY_HINT_GLOBAL_FILE** = **15**
  451. - **PROPERTY_HINT_GLOBAL_DIR** = **16**
  452. - **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- String property is a resource, so open the resource popup menu when edited.
  453. - **PROPERTY_HINT_MULTILINE_TEXT** = **18**
  454. - **PROPERTY_HINT_COLOR_NO_ALPHA** = **19**
  455. - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **20** --- Hints that the image is compressed using lossy compression.
  456. - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **21** --- Hints that the image is compressed using lossless compression.
  457. - **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default).
  458. - **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default).
  459. - **PROPERTY_USAGE_NETWORK** = **4**
  460. - **PROPERTY_USAGE_EDITOR_HELPER** = **8**
  461. - **PROPERTY_USAGE_CHECKABLE** = **16**
  462. - **PROPERTY_USAGE_CHECKED** = **32**
  463. - **PROPERTY_USAGE_INTERNATIONALIZED** = **64**
  464. - **PROPERTY_USAGE_GROUP** = **128**
  465. - **PROPERTY_USAGE_CATEGORY** = **256**
  466. - **PROPERTY_USAGE_STORE_IF_NONZERO** = **512**
  467. - **PROPERTY_USAGE_STORE_IF_NONONE** = **1024**
  468. - **PROPERTY_USAGE_NO_INSTANCE_STATE** = **2048**
  469. - **PROPERTY_USAGE_RESTART_IF_CHANGED** = **4096**
  470. - **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192**
  471. - **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor).
  472. - **PROPERTY_USAGE_DEFAULT_INTL** = **71**
  473. - **PROPERTY_USAGE_NOEDITOR** = **1048581**
  474. - **METHOD_FLAG_NORMAL** = **1** --- Flag for normal method
  475. - **METHOD_FLAG_EDITOR** = **2** --- Flag for editor method
  476. - **METHOD_FLAG_NOSCRIPT** = **4**
  477. - **METHOD_FLAG_CONST** = **8** --- Flag for constant method
  478. - **METHOD_FLAG_REVERSE** = **16**
  479. - **METHOD_FLAG_VIRTUAL** = **32** --- Flag for virtual method
  480. - **METHOD_FLAG_FROM_SCRIPT** = **64** --- Flag for method from script
  481. - **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags
  482. - **TYPE_NIL** = **0** --- Variable is of type nil (only applied for null).
  483. - **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool<class_bool>`.
  484. - **TYPE_INT** = **2** --- Variable is of type :ref:`int<class_int>`.
  485. - **TYPE_REAL** = **3** --- Variable is of type :ref:`float<class_float>`/real.
  486. - **TYPE_STRING** = **4** --- Variable is of type :ref:`String<class_string>`.
  487. - **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2<class_vector2>`.
  488. - **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2<class_rect2>`.
  489. - **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3<class_vector3>`.
  490. - **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D<class_transform2d>`.
  491. - **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane<class_plane>`.
  492. - **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat<class_quat>`.
  493. - **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB<class_aabb>`.
  494. - **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis<class_basis>`.
  495. - **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform<class_transform>`.
  496. - **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color<class_color>`.
  497. - **TYPE_NODE_PATH** = **15** --- Variable is of type :ref:`NodePath<class_nodepath>`.
  498. - **TYPE_RID** = **16** --- Variable is of type :ref:`RID<class_rid>`.
  499. - **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object<class_object>`.
  500. - **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary<class_dictionary>`.
  501. - **TYPE_ARRAY** = **19** --- Variable is of type :ref:`Array<class_array>`.
  502. - **TYPE_RAW_ARRAY** = **20** --- Variable is of type :ref:`PoolByteArray<class_poolbytearray>`.
  503. - **TYPE_INT_ARRAY** = **21** --- Variable is of type :ref:`PoolIntArray<class_poolintarray>`.
  504. - **TYPE_REAL_ARRAY** = **22** --- Variable is of type :ref:`PoolRealArray<class_poolrealarray>`.
  505. - **TYPE_STRING_ARRAY** = **23** --- Variable is of type :ref:`PoolStringArray<class_poolstringarray>`.
  506. - **TYPE_VECTOR2_ARRAY** = **24** --- Variable is of type :ref:`PoolVector2Array<class_poolvector2array>`.
  507. - **TYPE_VECTOR3_ARRAY** = **25** --- Variable is of type :ref:`PoolVector3Array<class_poolvector3array>`.
  508. - **TYPE_COLOR_ARRAY** = **26** --- Variable is of type :ref:`PoolColorArray<class_poolcolorarray>`.
  509. - **TYPE_MAX** = **27** --- Marker for end of type constants.
  510. - **OP_EQUAL** = **0**
  511. - **OP_NOT_EQUAL** = **1**
  512. - **OP_LESS** = **2**
  513. - **OP_LESS_EQUAL** = **3**
  514. - **OP_GREATER** = **4**
  515. - **OP_GREATER_EQUAL** = **5**
  516. - **OP_ADD** = **6**
  517. - **OP_SUBTRACT** = **7**
  518. - **OP_MULTIPLY** = **8**
  519. - **OP_DIVIDE** = **9**
  520. - **OP_NEGATE** = **10**
  521. - **OP_POSITIVE** = **11**
  522. - **OP_MODULE** = **12**
  523. - **OP_STRING_CONCAT** = **13**
  524. - **OP_SHIFT_LEFT** = **14**
  525. - **OP_SHIFT_RIGHT** = **15**
  526. - **OP_BIT_AND** = **16**
  527. - **OP_BIT_OR** = **17**
  528. - **OP_BIT_XOR** = **18**
  529. - **OP_BIT_NEGATE** = **19**
  530. - **OP_AND** = **20**
  531. - **OP_OR** = **21**
  532. - **OP_XOR** = **22**
  533. - **OP_NOT** = **23**
  534. - **OP_IN** = **24**
  535. - **OP_MAX** = **25**
  536. Description
  537. -----------
  538. 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.
  539. Singletons are also documented here, since they can be accessed from anywhere.