class_@global scope.rst 21 KB

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