class_@global scope.rst 23 KB

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