[email protected] 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223
  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. Properties
  12. ----------
  13. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  14. | :ref:`ARVRServer<class_ARVRServer>` | :ref:`ARVRServer<class_@GlobalScope_property_ARVRServer>` |
  15. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  16. | :ref:`AudioServer<class_AudioServer>` | :ref:`AudioServer<class_@GlobalScope_property_AudioServer>` |
  17. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  18. | :ref:`ClassDB<class_ClassDB>` | :ref:`ClassDB<class_@GlobalScope_property_ClassDB>` |
  19. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  20. | :ref:`Engine<class_Engine>` | :ref:`Engine<class_@GlobalScope_property_Engine>` |
  21. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  22. | :ref:`Geometry<class_Geometry>` | :ref:`Geometry<class_@GlobalScope_property_Geometry>` |
  23. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  24. | :ref:`IP<class_IP>` | :ref:`IP<class_@GlobalScope_property_IP>` |
  25. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  26. | :ref:`Input<class_Input>` | :ref:`Input<class_@GlobalScope_property_Input>` |
  27. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  28. | :ref:`InputMap<class_InputMap>` | :ref:`InputMap<class_@GlobalScope_property_InputMap>` |
  29. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  30. | :ref:`JSON<class_JSON>` | :ref:`JSON<class_@GlobalScope_property_JSON>` |
  31. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  32. | :ref:`JavaScript<class_JavaScript>` | :ref:`JavaScript<class_@GlobalScope_property_JavaScript>` |
  33. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  34. | :ref:`Reference<class_Reference>` | :ref:`Marshalls<class_@GlobalScope_property_Marshalls>` |
  35. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  36. | :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>` | :ref:`NavigationMeshGenerator<class_@GlobalScope_property_NavigationMeshGenerator>` |
  37. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  38. | :ref:`OS<class_OS>` | :ref:`OS<class_@GlobalScope_property_OS>` |
  39. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  40. | :ref:`Performance<class_Performance>` | :ref:`Performance<class_@GlobalScope_property_Performance>` |
  41. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  42. | :ref:`Physics2DServer<class_Physics2DServer>` | :ref:`Physics2DServer<class_@GlobalScope_property_Physics2DServer>` |
  43. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  44. | :ref:`PhysicsServer<class_PhysicsServer>` | :ref:`PhysicsServer<class_@GlobalScope_property_PhysicsServer>` |
  45. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  46. | :ref:`ProjectSettings<class_ProjectSettings>` | :ref:`ProjectSettings<class_@GlobalScope_property_ProjectSettings>` |
  47. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  48. | :ref:`ResourceLoader<class_ResourceLoader>` | :ref:`ResourceLoader<class_@GlobalScope_property_ResourceLoader>` |
  49. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  50. | :ref:`ResourceSaver<class_ResourceSaver>` | :ref:`ResourceSaver<class_@GlobalScope_property_ResourceSaver>` |
  51. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  52. | :ref:`TranslationServer<class_TranslationServer>` | :ref:`TranslationServer<class_@GlobalScope_property_TranslationServer>` |
  53. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  54. | :ref:`VisualScriptEditor<class_VisualScriptEditor>` | :ref:`VisualScriptEditor<class_@GlobalScope_property_VisualScriptEditor>` |
  55. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  56. | :ref:`VisualServer<class_VisualServer>` | :ref:`VisualServer<class_@GlobalScope_property_VisualServer>` |
  57. +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
  58. Enumerations
  59. ------------
  60. .. _enum_@GlobalScope_Margin:
  61. .. _class_@GlobalScope_constant_MARGIN_LEFT:
  62. .. _class_@GlobalScope_constant_MARGIN_TOP:
  63. .. _class_@GlobalScope_constant_MARGIN_RIGHT:
  64. .. _class_@GlobalScope_constant_MARGIN_BOTTOM:
  65. enum **Margin**:
  66. - **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
  67. - **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
  68. - **MARGIN_RIGHT** = **2** --- Right margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
  69. - **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
  70. .. _enum_@GlobalScope_Corner:
  71. .. _class_@GlobalScope_constant_CORNER_TOP_LEFT:
  72. .. _class_@GlobalScope_constant_CORNER_TOP_RIGHT:
  73. .. _class_@GlobalScope_constant_CORNER_BOTTOM_RIGHT:
  74. .. _class_@GlobalScope_constant_CORNER_BOTTOM_LEFT:
  75. enum **Corner**:
  76. - **CORNER_TOP_LEFT** = **0**
  77. - **CORNER_TOP_RIGHT** = **1**
  78. - **CORNER_BOTTOM_RIGHT** = **2**
  79. - **CORNER_BOTTOM_LEFT** = **3**
  80. .. _enum_@GlobalScope_Orientation:
  81. .. _class_@GlobalScope_constant_VERTICAL:
  82. .. _class_@GlobalScope_constant_HORIZONTAL:
  83. enum **Orientation**:
  84. - **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc.
  85. - **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc.
  86. .. _enum_@GlobalScope_HAlign:
  87. .. _class_@GlobalScope_constant_HALIGN_LEFT:
  88. .. _class_@GlobalScope_constant_HALIGN_CENTER:
  89. .. _class_@GlobalScope_constant_HALIGN_RIGHT:
  90. enum **HAlign**:
  91. - **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes.
  92. - **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes.
  93. - **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes.
  94. .. _enum_@GlobalScope_VAlign:
  95. .. _class_@GlobalScope_constant_VALIGN_TOP:
  96. .. _class_@GlobalScope_constant_VALIGN_CENTER:
  97. .. _class_@GlobalScope_constant_VALIGN_BOTTOM:
  98. enum **VAlign**:
  99. - **VALIGN_TOP** = **0** --- Vertical top alignment, usually for text-derived classes.
  100. - **VALIGN_CENTER** = **1** --- Vertical center alignment, usually for text-derived classes.
  101. - **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes.
  102. .. _enum_@GlobalScope_KeyList:
  103. .. _class_@GlobalScope_constant_KEY_ESCAPE:
  104. .. _class_@GlobalScope_constant_KEY_TAB:
  105. .. _class_@GlobalScope_constant_KEY_BACKTAB:
  106. .. _class_@GlobalScope_constant_KEY_BACKSPACE:
  107. .. _class_@GlobalScope_constant_KEY_ENTER:
  108. .. _class_@GlobalScope_constant_KEY_KP_ENTER:
  109. .. _class_@GlobalScope_constant_KEY_INSERT:
  110. .. _class_@GlobalScope_constant_KEY_DELETE:
  111. .. _class_@GlobalScope_constant_KEY_PAUSE:
  112. .. _class_@GlobalScope_constant_KEY_PRINT:
  113. .. _class_@GlobalScope_constant_KEY_SYSREQ:
  114. .. _class_@GlobalScope_constant_KEY_CLEAR:
  115. .. _class_@GlobalScope_constant_KEY_HOME:
  116. .. _class_@GlobalScope_constant_KEY_END:
  117. .. _class_@GlobalScope_constant_KEY_LEFT:
  118. .. _class_@GlobalScope_constant_KEY_UP:
  119. .. _class_@GlobalScope_constant_KEY_RIGHT:
  120. .. _class_@GlobalScope_constant_KEY_DOWN:
  121. .. _class_@GlobalScope_constant_KEY_PAGEUP:
  122. .. _class_@GlobalScope_constant_KEY_PAGEDOWN:
  123. .. _class_@GlobalScope_constant_KEY_SHIFT:
  124. .. _class_@GlobalScope_constant_KEY_CONTROL:
  125. .. _class_@GlobalScope_constant_KEY_META:
  126. .. _class_@GlobalScope_constant_KEY_ALT:
  127. .. _class_@GlobalScope_constant_KEY_CAPSLOCK:
  128. .. _class_@GlobalScope_constant_KEY_NUMLOCK:
  129. .. _class_@GlobalScope_constant_KEY_SCROLLLOCK:
  130. .. _class_@GlobalScope_constant_KEY_F1:
  131. .. _class_@GlobalScope_constant_KEY_F2:
  132. .. _class_@GlobalScope_constant_KEY_F3:
  133. .. _class_@GlobalScope_constant_KEY_F4:
  134. .. _class_@GlobalScope_constant_KEY_F5:
  135. .. _class_@GlobalScope_constant_KEY_F6:
  136. .. _class_@GlobalScope_constant_KEY_F7:
  137. .. _class_@GlobalScope_constant_KEY_F8:
  138. .. _class_@GlobalScope_constant_KEY_F9:
  139. .. _class_@GlobalScope_constant_KEY_F10:
  140. .. _class_@GlobalScope_constant_KEY_F11:
  141. .. _class_@GlobalScope_constant_KEY_F12:
  142. .. _class_@GlobalScope_constant_KEY_F13:
  143. .. _class_@GlobalScope_constant_KEY_F14:
  144. .. _class_@GlobalScope_constant_KEY_F15:
  145. .. _class_@GlobalScope_constant_KEY_F16:
  146. .. _class_@GlobalScope_constant_KEY_KP_MULTIPLY:
  147. .. _class_@GlobalScope_constant_KEY_KP_DIVIDE:
  148. .. _class_@GlobalScope_constant_KEY_KP_SUBTRACT:
  149. .. _class_@GlobalScope_constant_KEY_KP_PERIOD:
  150. .. _class_@GlobalScope_constant_KEY_KP_ADD:
  151. .. _class_@GlobalScope_constant_KEY_KP_0:
  152. .. _class_@GlobalScope_constant_KEY_KP_1:
  153. .. _class_@GlobalScope_constant_KEY_KP_2:
  154. .. _class_@GlobalScope_constant_KEY_KP_3:
  155. .. _class_@GlobalScope_constant_KEY_KP_4:
  156. .. _class_@GlobalScope_constant_KEY_KP_5:
  157. .. _class_@GlobalScope_constant_KEY_KP_6:
  158. .. _class_@GlobalScope_constant_KEY_KP_7:
  159. .. _class_@GlobalScope_constant_KEY_KP_8:
  160. .. _class_@GlobalScope_constant_KEY_KP_9:
  161. .. _class_@GlobalScope_constant_KEY_SUPER_L:
  162. .. _class_@GlobalScope_constant_KEY_SUPER_R:
  163. .. _class_@GlobalScope_constant_KEY_MENU:
  164. .. _class_@GlobalScope_constant_KEY_HYPER_L:
  165. .. _class_@GlobalScope_constant_KEY_HYPER_R:
  166. .. _class_@GlobalScope_constant_KEY_HELP:
  167. .. _class_@GlobalScope_constant_KEY_DIRECTION_L:
  168. .. _class_@GlobalScope_constant_KEY_DIRECTION_R:
  169. .. _class_@GlobalScope_constant_KEY_BACK:
  170. .. _class_@GlobalScope_constant_KEY_FORWARD:
  171. .. _class_@GlobalScope_constant_KEY_STOP:
  172. .. _class_@GlobalScope_constant_KEY_REFRESH:
  173. .. _class_@GlobalScope_constant_KEY_VOLUMEDOWN:
  174. .. _class_@GlobalScope_constant_KEY_VOLUMEMUTE:
  175. .. _class_@GlobalScope_constant_KEY_VOLUMEUP:
  176. .. _class_@GlobalScope_constant_KEY_BASSBOOST:
  177. .. _class_@GlobalScope_constant_KEY_BASSUP:
  178. .. _class_@GlobalScope_constant_KEY_BASSDOWN:
  179. .. _class_@GlobalScope_constant_KEY_TREBLEUP:
  180. .. _class_@GlobalScope_constant_KEY_TREBLEDOWN:
  181. .. _class_@GlobalScope_constant_KEY_MEDIAPLAY:
  182. .. _class_@GlobalScope_constant_KEY_MEDIASTOP:
  183. .. _class_@GlobalScope_constant_KEY_MEDIAPREVIOUS:
  184. .. _class_@GlobalScope_constant_KEY_MEDIANEXT:
  185. .. _class_@GlobalScope_constant_KEY_MEDIARECORD:
  186. .. _class_@GlobalScope_constant_KEY_HOMEPAGE:
  187. .. _class_@GlobalScope_constant_KEY_FAVORITES:
  188. .. _class_@GlobalScope_constant_KEY_SEARCH:
  189. .. _class_@GlobalScope_constant_KEY_STANDBY:
  190. .. _class_@GlobalScope_constant_KEY_OPENURL:
  191. .. _class_@GlobalScope_constant_KEY_LAUNCHMAIL:
  192. .. _class_@GlobalScope_constant_KEY_LAUNCHMEDIA:
  193. .. _class_@GlobalScope_constant_KEY_LAUNCH0:
  194. .. _class_@GlobalScope_constant_KEY_LAUNCH1:
  195. .. _class_@GlobalScope_constant_KEY_LAUNCH2:
  196. .. _class_@GlobalScope_constant_KEY_LAUNCH3:
  197. .. _class_@GlobalScope_constant_KEY_LAUNCH4:
  198. .. _class_@GlobalScope_constant_KEY_LAUNCH5:
  199. .. _class_@GlobalScope_constant_KEY_LAUNCH6:
  200. .. _class_@GlobalScope_constant_KEY_LAUNCH7:
  201. .. _class_@GlobalScope_constant_KEY_LAUNCH8:
  202. .. _class_@GlobalScope_constant_KEY_LAUNCH9:
  203. .. _class_@GlobalScope_constant_KEY_LAUNCHA:
  204. .. _class_@GlobalScope_constant_KEY_LAUNCHB:
  205. .. _class_@GlobalScope_constant_KEY_LAUNCHC:
  206. .. _class_@GlobalScope_constant_KEY_LAUNCHD:
  207. .. _class_@GlobalScope_constant_KEY_LAUNCHE:
  208. .. _class_@GlobalScope_constant_KEY_LAUNCHF:
  209. .. _class_@GlobalScope_constant_KEY_UNKNOWN:
  210. .. _class_@GlobalScope_constant_KEY_SPACE:
  211. .. _class_@GlobalScope_constant_KEY_EXCLAM:
  212. .. _class_@GlobalScope_constant_KEY_QUOTEDBL:
  213. .. _class_@GlobalScope_constant_KEY_NUMBERSIGN:
  214. .. _class_@GlobalScope_constant_KEY_DOLLAR:
  215. .. _class_@GlobalScope_constant_KEY_PERCENT:
  216. .. _class_@GlobalScope_constant_KEY_AMPERSAND:
  217. .. _class_@GlobalScope_constant_KEY_APOSTROPHE:
  218. .. _class_@GlobalScope_constant_KEY_PARENLEFT:
  219. .. _class_@GlobalScope_constant_KEY_PARENRIGHT:
  220. .. _class_@GlobalScope_constant_KEY_ASTERISK:
  221. .. _class_@GlobalScope_constant_KEY_PLUS:
  222. .. _class_@GlobalScope_constant_KEY_COMMA:
  223. .. _class_@GlobalScope_constant_KEY_MINUS:
  224. .. _class_@GlobalScope_constant_KEY_PERIOD:
  225. .. _class_@GlobalScope_constant_KEY_SLASH:
  226. .. _class_@GlobalScope_constant_KEY_0:
  227. .. _class_@GlobalScope_constant_KEY_1:
  228. .. _class_@GlobalScope_constant_KEY_2:
  229. .. _class_@GlobalScope_constant_KEY_3:
  230. .. _class_@GlobalScope_constant_KEY_4:
  231. .. _class_@GlobalScope_constant_KEY_5:
  232. .. _class_@GlobalScope_constant_KEY_6:
  233. .. _class_@GlobalScope_constant_KEY_7:
  234. .. _class_@GlobalScope_constant_KEY_8:
  235. .. _class_@GlobalScope_constant_KEY_9:
  236. .. _class_@GlobalScope_constant_KEY_COLON:
  237. .. _class_@GlobalScope_constant_KEY_SEMICOLON:
  238. .. _class_@GlobalScope_constant_KEY_LESS:
  239. .. _class_@GlobalScope_constant_KEY_EQUAL:
  240. .. _class_@GlobalScope_constant_KEY_GREATER:
  241. .. _class_@GlobalScope_constant_KEY_QUESTION:
  242. .. _class_@GlobalScope_constant_KEY_AT:
  243. .. _class_@GlobalScope_constant_KEY_A:
  244. .. _class_@GlobalScope_constant_KEY_B:
  245. .. _class_@GlobalScope_constant_KEY_C:
  246. .. _class_@GlobalScope_constant_KEY_D:
  247. .. _class_@GlobalScope_constant_KEY_E:
  248. .. _class_@GlobalScope_constant_KEY_F:
  249. .. _class_@GlobalScope_constant_KEY_G:
  250. .. _class_@GlobalScope_constant_KEY_H:
  251. .. _class_@GlobalScope_constant_KEY_I:
  252. .. _class_@GlobalScope_constant_KEY_J:
  253. .. _class_@GlobalScope_constant_KEY_K:
  254. .. _class_@GlobalScope_constant_KEY_L:
  255. .. _class_@GlobalScope_constant_KEY_M:
  256. .. _class_@GlobalScope_constant_KEY_N:
  257. .. _class_@GlobalScope_constant_KEY_O:
  258. .. _class_@GlobalScope_constant_KEY_P:
  259. .. _class_@GlobalScope_constant_KEY_Q:
  260. .. _class_@GlobalScope_constant_KEY_R:
  261. .. _class_@GlobalScope_constant_KEY_S:
  262. .. _class_@GlobalScope_constant_KEY_T:
  263. .. _class_@GlobalScope_constant_KEY_U:
  264. .. _class_@GlobalScope_constant_KEY_V:
  265. .. _class_@GlobalScope_constant_KEY_W:
  266. .. _class_@GlobalScope_constant_KEY_X:
  267. .. _class_@GlobalScope_constant_KEY_Y:
  268. .. _class_@GlobalScope_constant_KEY_Z:
  269. .. _class_@GlobalScope_constant_KEY_BRACKETLEFT:
  270. .. _class_@GlobalScope_constant_KEY_BACKSLASH:
  271. .. _class_@GlobalScope_constant_KEY_BRACKETRIGHT:
  272. .. _class_@GlobalScope_constant_KEY_ASCIICIRCUM:
  273. .. _class_@GlobalScope_constant_KEY_UNDERSCORE:
  274. .. _class_@GlobalScope_constant_KEY_QUOTELEFT:
  275. .. _class_@GlobalScope_constant_KEY_BRACELEFT:
  276. .. _class_@GlobalScope_constant_KEY_BAR:
  277. .. _class_@GlobalScope_constant_KEY_BRACERIGHT:
  278. .. _class_@GlobalScope_constant_KEY_ASCIITILDE:
  279. .. _class_@GlobalScope_constant_KEY_NOBREAKSPACE:
  280. .. _class_@GlobalScope_constant_KEY_EXCLAMDOWN:
  281. .. _class_@GlobalScope_constant_KEY_CENT:
  282. .. _class_@GlobalScope_constant_KEY_STERLING:
  283. .. _class_@GlobalScope_constant_KEY_CURRENCY:
  284. .. _class_@GlobalScope_constant_KEY_YEN:
  285. .. _class_@GlobalScope_constant_KEY_BROKENBAR:
  286. .. _class_@GlobalScope_constant_KEY_SECTION:
  287. .. _class_@GlobalScope_constant_KEY_DIAERESIS:
  288. .. _class_@GlobalScope_constant_KEY_COPYRIGHT:
  289. .. _class_@GlobalScope_constant_KEY_ORDFEMININE:
  290. .. _class_@GlobalScope_constant_KEY_GUILLEMOTLEFT:
  291. .. _class_@GlobalScope_constant_KEY_NOTSIGN:
  292. .. _class_@GlobalScope_constant_KEY_HYPHEN:
  293. .. _class_@GlobalScope_constant_KEY_REGISTERED:
  294. .. _class_@GlobalScope_constant_KEY_MACRON:
  295. .. _class_@GlobalScope_constant_KEY_DEGREE:
  296. .. _class_@GlobalScope_constant_KEY_PLUSMINUS:
  297. .. _class_@GlobalScope_constant_KEY_TWOSUPERIOR:
  298. .. _class_@GlobalScope_constant_KEY_THREESUPERIOR:
  299. .. _class_@GlobalScope_constant_KEY_ACUTE:
  300. .. _class_@GlobalScope_constant_KEY_MU:
  301. .. _class_@GlobalScope_constant_KEY_PARAGRAPH:
  302. .. _class_@GlobalScope_constant_KEY_PERIODCENTERED:
  303. .. _class_@GlobalScope_constant_KEY_CEDILLA:
  304. .. _class_@GlobalScope_constant_KEY_ONESUPERIOR:
  305. .. _class_@GlobalScope_constant_KEY_MASCULINE:
  306. .. _class_@GlobalScope_constant_KEY_GUILLEMOTRIGHT:
  307. .. _class_@GlobalScope_constant_KEY_ONEQUARTER:
  308. .. _class_@GlobalScope_constant_KEY_ONEHALF:
  309. .. _class_@GlobalScope_constant_KEY_THREEQUARTERS:
  310. .. _class_@GlobalScope_constant_KEY_QUESTIONDOWN:
  311. .. _class_@GlobalScope_constant_KEY_AGRAVE:
  312. .. _class_@GlobalScope_constant_KEY_AACUTE:
  313. .. _class_@GlobalScope_constant_KEY_ACIRCUMFLEX:
  314. .. _class_@GlobalScope_constant_KEY_ATILDE:
  315. .. _class_@GlobalScope_constant_KEY_ADIAERESIS:
  316. .. _class_@GlobalScope_constant_KEY_ARING:
  317. .. _class_@GlobalScope_constant_KEY_AE:
  318. .. _class_@GlobalScope_constant_KEY_CCEDILLA:
  319. .. _class_@GlobalScope_constant_KEY_EGRAVE:
  320. .. _class_@GlobalScope_constant_KEY_EACUTE:
  321. .. _class_@GlobalScope_constant_KEY_ECIRCUMFLEX:
  322. .. _class_@GlobalScope_constant_KEY_EDIAERESIS:
  323. .. _class_@GlobalScope_constant_KEY_IGRAVE:
  324. .. _class_@GlobalScope_constant_KEY_IACUTE:
  325. .. _class_@GlobalScope_constant_KEY_ICIRCUMFLEX:
  326. .. _class_@GlobalScope_constant_KEY_IDIAERESIS:
  327. .. _class_@GlobalScope_constant_KEY_ETH:
  328. .. _class_@GlobalScope_constant_KEY_NTILDE:
  329. .. _class_@GlobalScope_constant_KEY_OGRAVE:
  330. .. _class_@GlobalScope_constant_KEY_OACUTE:
  331. .. _class_@GlobalScope_constant_KEY_OCIRCUMFLEX:
  332. .. _class_@GlobalScope_constant_KEY_OTILDE:
  333. .. _class_@GlobalScope_constant_KEY_ODIAERESIS:
  334. .. _class_@GlobalScope_constant_KEY_MULTIPLY:
  335. .. _class_@GlobalScope_constant_KEY_OOBLIQUE:
  336. .. _class_@GlobalScope_constant_KEY_UGRAVE:
  337. .. _class_@GlobalScope_constant_KEY_UACUTE:
  338. .. _class_@GlobalScope_constant_KEY_UCIRCUMFLEX:
  339. .. _class_@GlobalScope_constant_KEY_UDIAERESIS:
  340. .. _class_@GlobalScope_constant_KEY_YACUTE:
  341. .. _class_@GlobalScope_constant_KEY_THORN:
  342. .. _class_@GlobalScope_constant_KEY_SSHARP:
  343. .. _class_@GlobalScope_constant_KEY_DIVISION:
  344. .. _class_@GlobalScope_constant_KEY_YDIAERESIS:
  345. enum **KeyList**:
  346. - **KEY_ESCAPE** = **16777217** --- Escape Key
  347. - **KEY_TAB** = **16777218** --- Tab Key
  348. - **KEY_BACKTAB** = **16777219** --- Shift-Tab Key
  349. - **KEY_BACKSPACE** = **16777220** --- Backspace Key
  350. - **KEY_ENTER** = **16777221** --- Return Key (On Main Keyboard)
  351. - **KEY_KP_ENTER** = **16777222** --- Enter Key (On Numpad)
  352. - **KEY_INSERT** = **16777223** --- Insert Key
  353. - **KEY_DELETE** = **16777224** --- Delete Key
  354. - **KEY_PAUSE** = **16777225** --- Pause Key
  355. - **KEY_PRINT** = **16777226** --- Printscreen Key
  356. - **KEY_SYSREQ** = **16777227** --- System Request Key
  357. - **KEY_CLEAR** = **16777228** --- Clear Key
  358. - **KEY_HOME** = **16777229** --- Home Key
  359. - **KEY_END** = **16777230** --- End Key
  360. - **KEY_LEFT** = **16777231** --- Left Arrow Key
  361. - **KEY_UP** = **16777232** --- Up Arrow Key
  362. - **KEY_RIGHT** = **16777233** --- Right Arrow Key
  363. - **KEY_DOWN** = **16777234** --- Down Arrow Key
  364. - **KEY_PAGEUP** = **16777235** --- Pageup Key
  365. - **KEY_PAGEDOWN** = **16777236** --- Pagedown Key
  366. - **KEY_SHIFT** = **16777237** --- Shift Key
  367. - **KEY_CONTROL** = **16777238** --- Control Key
  368. - **KEY_META** = **16777239** --- Meta Key
  369. - **KEY_ALT** = **16777240** --- Alt Key
  370. - **KEY_CAPSLOCK** = **16777241** --- Capslock Key
  371. - **KEY_NUMLOCK** = **16777242** --- Numlock Key
  372. - **KEY_SCROLLLOCK** = **16777243** --- Scrolllock Key
  373. - **KEY_F1** = **16777244** --- F1 Key
  374. - **KEY_F2** = **16777245** --- F2 Key
  375. - **KEY_F3** = **16777246** --- F3 Key
  376. - **KEY_F4** = **16777247** --- F4 Key
  377. - **KEY_F5** = **16777248** --- F5 Key
  378. - **KEY_F6** = **16777249** --- F6 Key
  379. - **KEY_F7** = **16777250** --- F7 Key
  380. - **KEY_F8** = **16777251** --- F8 Key
  381. - **KEY_F9** = **16777252** --- F9 Key
  382. - **KEY_F10** = **16777253** --- F10 Key
  383. - **KEY_F11** = **16777254** --- F11 Key
  384. - **KEY_F12** = **16777255** --- F12 Key
  385. - **KEY_F13** = **16777256** --- F13 Key
  386. - **KEY_F14** = **16777257** --- F14 Key
  387. - **KEY_F15** = **16777258** --- F15 Key
  388. - **KEY_F16** = **16777259** --- F16 Key
  389. - **KEY_KP_MULTIPLY** = **16777345** --- Multiply Key on Numpad
  390. - **KEY_KP_DIVIDE** = **16777346** --- Divide Key on Numpad
  391. - **KEY_KP_SUBTRACT** = **16777347** --- Subtract Key on Numpad
  392. - **KEY_KP_PERIOD** = **16777348** --- Period Key on Numpad
  393. - **KEY_KP_ADD** = **16777349** --- Add Key on Numpad
  394. - **KEY_KP_0** = **16777350** --- Number 0 on Numpad
  395. - **KEY_KP_1** = **16777351** --- Number 1 on Numpad
  396. - **KEY_KP_2** = **16777352** --- Number 2 on Numpad
  397. - **KEY_KP_3** = **16777353** --- Number 3 on Numpad
  398. - **KEY_KP_4** = **16777354** --- Number 4 on Numpad
  399. - **KEY_KP_5** = **16777355** --- Number 5 on Numpad
  400. - **KEY_KP_6** = **16777356** --- Number 6 on Numpad
  401. - **KEY_KP_7** = **16777357** --- Number 7 on Numpad
  402. - **KEY_KP_8** = **16777358** --- Number 8 on Numpad
  403. - **KEY_KP_9** = **16777359** --- Number 9 on Numpad
  404. - **KEY_SUPER_L** = **16777260** --- Left Super Key (Windows Key)
  405. - **KEY_SUPER_R** = **16777261** --- Right Super Key (Windows Key)
  406. - **KEY_MENU** = **16777262** --- Context menu key
  407. - **KEY_HYPER_L** = **16777263** --- Left Hyper Key
  408. - **KEY_HYPER_R** = **16777264** --- Right Hyper Key
  409. - **KEY_HELP** = **16777265** --- Help key
  410. - **KEY_DIRECTION_L** = **16777266** --- Left Direction Key
  411. - **KEY_DIRECTION_R** = **16777267** --- Right Direction Key
  412. - **KEY_BACK** = **16777280** --- Back key
  413. - **KEY_FORWARD** = **16777281** --- Forward key
  414. - **KEY_STOP** = **16777282** --- Stop key
  415. - **KEY_REFRESH** = **16777283** --- Refresh key
  416. - **KEY_VOLUMEDOWN** = **16777284** --- Volume down key
  417. - **KEY_VOLUMEMUTE** = **16777285** --- Mute volume key
  418. - **KEY_VOLUMEUP** = **16777286** --- Volume up key
  419. - **KEY_BASSBOOST** = **16777287** --- Bass Boost Key
  420. - **KEY_BASSUP** = **16777288** --- Bass Up Key
  421. - **KEY_BASSDOWN** = **16777289** --- Bass Down Key
  422. - **KEY_TREBLEUP** = **16777290** --- Treble Up Key
  423. - **KEY_TREBLEDOWN** = **16777291** --- Treble Down Key
  424. - **KEY_MEDIAPLAY** = **16777292** --- Media play key
  425. - **KEY_MEDIASTOP** = **16777293** --- Media stop key
  426. - **KEY_MEDIAPREVIOUS** = **16777294** --- Previous song key
  427. - **KEY_MEDIANEXT** = **16777295** --- Next song key
  428. - **KEY_MEDIARECORD** = **16777296** --- Media record key
  429. - **KEY_HOMEPAGE** = **16777297** --- Home page key
  430. - **KEY_FAVORITES** = **16777298** --- Favorites key
  431. - **KEY_SEARCH** = **16777299** --- Search key
  432. - **KEY_STANDBY** = **16777300** --- Standby Key
  433. - **KEY_OPENURL** = **16777301** --- Open URL / Launch Browser Key
  434. - **KEY_LAUNCHMAIL** = **16777302** --- Launch Mail Key
  435. - **KEY_LAUNCHMEDIA** = **16777303** --- Launch Media Key
  436. - **KEY_LAUNCH0** = **16777304** --- Launch Shortcut 0 Key
  437. - **KEY_LAUNCH1** = **16777305** --- Launch Shortcut 1 Key
  438. - **KEY_LAUNCH2** = **16777306** --- Launch Shortcut 2 Key
  439. - **KEY_LAUNCH3** = **16777307** --- Launch Shortcut 3 Key
  440. - **KEY_LAUNCH4** = **16777308** --- Launch Shortcut 4 Key
  441. - **KEY_LAUNCH5** = **16777309** --- Launch Shortcut 5 Key
  442. - **KEY_LAUNCH6** = **16777310** --- Launch Shortcut 6 Key
  443. - **KEY_LAUNCH7** = **16777311** --- Launch Shortcut 7 Key
  444. - **KEY_LAUNCH8** = **16777312** --- Launch Shortcut 8 Key
  445. - **KEY_LAUNCH9** = **16777313** --- Launch Shortcut 9 Key
  446. - **KEY_LAUNCHA** = **16777314** --- Launch Shortcut A Key
  447. - **KEY_LAUNCHB** = **16777315** --- Launch Shortcut B Key
  448. - **KEY_LAUNCHC** = **16777316** --- Launch Shortcut C Key
  449. - **KEY_LAUNCHD** = **16777317** --- Launch Shortcut D Key
  450. - **KEY_LAUNCHE** = **16777318** --- Launch Shortcut E Key
  451. - **KEY_LAUNCHF** = **16777319** --- Launch Shortcut F Key
  452. - **KEY_UNKNOWN** = **33554431** --- Unknown Key
  453. - **KEY_SPACE** = **32** --- Space Key
  454. - **KEY_EXCLAM** = **33** --- ! key
  455. - **KEY_QUOTEDBL** = **34** --- " key
  456. - **KEY_NUMBERSIGN** = **35** --- # key
  457. - **KEY_DOLLAR** = **36** --- $ key
  458. - **KEY_PERCENT** = **37** --- % key
  459. - **KEY_AMPERSAND** = **38** --- & key
  460. - **KEY_APOSTROPHE** = **39** --- ' key
  461. - **KEY_PARENLEFT** = **40** --- ( key
  462. - **KEY_PARENRIGHT** = **41** --- ) key
  463. - **KEY_ASTERISK** = **42** --- \* key
  464. - **KEY_PLUS** = **43** --- + key
  465. - **KEY_COMMA** = **44** --- , key
  466. - **KEY_MINUS** = **45** --- - key
  467. - **KEY_PERIOD** = **46** --- . key
  468. - **KEY_SLASH** = **47** --- / key
  469. - **KEY_0** = **48** --- Number 0
  470. - **KEY_1** = **49** --- Number 1
  471. - **KEY_2** = **50** --- Number 2
  472. - **KEY_3** = **51** --- Number 3
  473. - **KEY_4** = **52** --- Number 4
  474. - **KEY_5** = **53** --- Number 5
  475. - **KEY_6** = **54** --- Number 6
  476. - **KEY_7** = **55** --- Number 7
  477. - **KEY_8** = **56** --- Number 8
  478. - **KEY_9** = **57** --- Number 9
  479. - **KEY_COLON** = **58** --- : key
  480. - **KEY_SEMICOLON** = **59** --- ; key
  481. - **KEY_LESS** = **60** --- Lower than key
  482. - **KEY_EQUAL** = **61** --- = key
  483. - **KEY_GREATER** = **62** --- Greater than key
  484. - **KEY_QUESTION** = **63** --- ? key
  485. - **KEY_AT** = **64** --- @ key
  486. - **KEY_A** = **65** --- A Key
  487. - **KEY_B** = **66** --- B Key
  488. - **KEY_C** = **67** --- C Key
  489. - **KEY_D** = **68** --- D Key
  490. - **KEY_E** = **69** --- E Key
  491. - **KEY_F** = **70** --- F Key
  492. - **KEY_G** = **71** --- G Key
  493. - **KEY_H** = **72** --- H Key
  494. - **KEY_I** = **73** --- I Key
  495. - **KEY_J** = **74** --- J Key
  496. - **KEY_K** = **75** --- K Key
  497. - **KEY_L** = **76** --- L Key
  498. - **KEY_M** = **77** --- M Key
  499. - **KEY_N** = **78** --- N Key
  500. - **KEY_O** = **79** --- O Key
  501. - **KEY_P** = **80** --- P Key
  502. - **KEY_Q** = **81** --- Q Key
  503. - **KEY_R** = **82** --- R Key
  504. - **KEY_S** = **83** --- S Key
  505. - **KEY_T** = **84** --- T Key
  506. - **KEY_U** = **85** --- U Key
  507. - **KEY_V** = **86** --- V Key
  508. - **KEY_W** = **87** --- W Key
  509. - **KEY_X** = **88** --- X Key
  510. - **KEY_Y** = **89** --- Y Key
  511. - **KEY_Z** = **90** --- Z Key
  512. - **KEY_BRACKETLEFT** = **91** --- [ key
  513. - **KEY_BACKSLASH** = **92** --- \\ key
  514. - **KEY_BRACKETRIGHT** = **93** --- ] key
  515. - **KEY_ASCIICIRCUM** = **94** --- ^ key
  516. - **KEY_UNDERSCORE** = **95** --- \_ key
  517. - **KEY_QUOTELEFT** = **96** --- Left Quote Key
  518. - **KEY_BRACELEFT** = **123** --- { key
  519. - **KEY_BAR** = **124** --- | key
  520. - **KEY_BRACERIGHT** = **125** --- } key
  521. - **KEY_ASCIITILDE** = **126** --- ~ key
  522. - **KEY_NOBREAKSPACE** = **160**
  523. - **KEY_EXCLAMDOWN** = **161**
  524. - **KEY_CENT** = **162** --- ¢ key
  525. - **KEY_STERLING** = **163**
  526. - **KEY_CURRENCY** = **164**
  527. - **KEY_YEN** = **165** --- Yen Key
  528. - **KEY_BROKENBAR** = **166** --- ¦ key
  529. - **KEY_SECTION** = **167** --- § key
  530. - **KEY_DIAERESIS** = **168** --- ¨ key
  531. - **KEY_COPYRIGHT** = **169** --- © key
  532. - **KEY_ORDFEMININE** = **170**
  533. - **KEY_GUILLEMOTLEFT** = **171** --- « key
  534. - **KEY_NOTSIGN** = **172** --- » key
  535. - **KEY_HYPHEN** = **173** --- ‐ key
  536. - **KEY_REGISTERED** = **174** --- ® key
  537. - **KEY_MACRON** = **175** --- Macron Key
  538. - **KEY_DEGREE** = **176** --- ° key
  539. - **KEY_PLUSMINUS** = **177** --- ± key
  540. - **KEY_TWOSUPERIOR** = **178** --- ² key
  541. - **KEY_THREESUPERIOR** = **179** --- ³ key
  542. - **KEY_ACUTE** = **180** --- ´ key
  543. - **KEY_MU** = **181** --- µ key
  544. - **KEY_PARAGRAPH** = **182** --- Paragraph Key
  545. - **KEY_PERIODCENTERED** = **183** --- · key
  546. - **KEY_CEDILLA** = **184** --- ¬ key
  547. - **KEY_ONESUPERIOR** = **185** --- ¹ key
  548. - **KEY_MASCULINE** = **186** --- ♂ key
  549. - **KEY_GUILLEMOTRIGHT** = **187** --- » key
  550. - **KEY_ONEQUARTER** = **188** --- ¼ key
  551. - **KEY_ONEHALF** = **189** --- ½ key
  552. - **KEY_THREEQUARTERS** = **190** --- ¾ key
  553. - **KEY_QUESTIONDOWN** = **191** --- ¿ key
  554. - **KEY_AGRAVE** = **192** --- à key
  555. - **KEY_AACUTE** = **193** --- á key
  556. - **KEY_ACIRCUMFLEX** = **194** --- â key
  557. - **KEY_ATILDE** = **195** --- ã key
  558. - **KEY_ADIAERESIS** = **196** --- ä key
  559. - **KEY_ARING** = **197** --- å key
  560. - **KEY_AE** = **198** --- æ key
  561. - **KEY_CCEDILLA** = **199** --- ç key
  562. - **KEY_EGRAVE** = **200** --- è key
  563. - **KEY_EACUTE** = **201** --- é key
  564. - **KEY_ECIRCUMFLEX** = **202** --- ê key
  565. - **KEY_EDIAERESIS** = **203** --- ë key
  566. - **KEY_IGRAVE** = **204** --- ì key
  567. - **KEY_IACUTE** = **205** --- í key
  568. - **KEY_ICIRCUMFLEX** = **206** --- î key
  569. - **KEY_IDIAERESIS** = **207** --- ë key
  570. - **KEY_ETH** = **208** --- ð key
  571. - **KEY_NTILDE** = **209** --- ñ key
  572. - **KEY_OGRAVE** = **210** --- ò key
  573. - **KEY_OACUTE** = **211** --- ó key
  574. - **KEY_OCIRCUMFLEX** = **212** --- ô key
  575. - **KEY_OTILDE** = **213** --- õ key
  576. - **KEY_ODIAERESIS** = **214** --- ö key
  577. - **KEY_MULTIPLY** = **215** --- × key
  578. - **KEY_OOBLIQUE** = **216** --- ø key
  579. - **KEY_UGRAVE** = **217** --- ù key
  580. - **KEY_UACUTE** = **218** --- ú key
  581. - **KEY_UCIRCUMFLEX** = **219** --- û key
  582. - **KEY_UDIAERESIS** = **220** --- ü key
  583. - **KEY_YACUTE** = **221** --- ý key
  584. - **KEY_THORN** = **222** --- þ key
  585. - **KEY_SSHARP** = **223** --- ß key
  586. - **KEY_DIVISION** = **247** --- ÷ key
  587. - **KEY_YDIAERESIS** = **255** --- ÿ key
  588. .. _enum_@GlobalScope_KeyModifierMask:
  589. .. _class_@GlobalScope_constant_KEY_CODE_MASK:
  590. .. _class_@GlobalScope_constant_KEY_MODIFIER_MASK:
  591. .. _class_@GlobalScope_constant_KEY_MASK_SHIFT:
  592. .. _class_@GlobalScope_constant_KEY_MASK_ALT:
  593. .. _class_@GlobalScope_constant_KEY_MASK_META:
  594. .. _class_@GlobalScope_constant_KEY_MASK_CTRL:
  595. .. _class_@GlobalScope_constant_KEY_MASK_CMD:
  596. .. _class_@GlobalScope_constant_KEY_MASK_KPAD:
  597. .. _class_@GlobalScope_constant_KEY_MASK_GROUP_SWITCH:
  598. enum **KeyModifierMask**:
  599. - **KEY_CODE_MASK** = **33554431** --- Key Code Mask
  600. - **KEY_MODIFIER_MASK** = **-16777216** --- Modifier Key Mask
  601. - **KEY_MASK_SHIFT** = **33554432** --- Shift Key Mask
  602. - **KEY_MASK_ALT** = **67108864** --- Alt Key Mask
  603. - **KEY_MASK_META** = **134217728** --- Meta Key Mask
  604. - **KEY_MASK_CTRL** = **268435456** --- CTRL Key Mask
  605. - **KEY_MASK_CMD** = **268435456** --- CMD Key Mask
  606. - **KEY_MASK_KPAD** = **536870912** --- Keypad Key Mask
  607. - **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask
  608. .. _enum_@GlobalScope_ButtonList:
  609. .. _class_@GlobalScope_constant_BUTTON_LEFT:
  610. .. _class_@GlobalScope_constant_BUTTON_RIGHT:
  611. .. _class_@GlobalScope_constant_BUTTON_MIDDLE:
  612. .. _class_@GlobalScope_constant_BUTTON_XBUTTON1:
  613. .. _class_@GlobalScope_constant_BUTTON_XBUTTON2:
  614. .. _class_@GlobalScope_constant_BUTTON_WHEEL_UP:
  615. .. _class_@GlobalScope_constant_BUTTON_WHEEL_DOWN:
  616. .. _class_@GlobalScope_constant_BUTTON_WHEEL_LEFT:
  617. .. _class_@GlobalScope_constant_BUTTON_WHEEL_RIGHT:
  618. .. _class_@GlobalScope_constant_BUTTON_MASK_LEFT:
  619. .. _class_@GlobalScope_constant_BUTTON_MASK_RIGHT:
  620. .. _class_@GlobalScope_constant_BUTTON_MASK_MIDDLE:
  621. .. _class_@GlobalScope_constant_BUTTON_MASK_XBUTTON1:
  622. .. _class_@GlobalScope_constant_BUTTON_MASK_XBUTTON2:
  623. enum **ButtonList**:
  624. - **BUTTON_LEFT** = **1** --- Left Mouse Button
  625. - **BUTTON_RIGHT** = **2** --- Right Mouse Button
  626. - **BUTTON_MIDDLE** = **3** --- Middle Mouse Button
  627. - **BUTTON_XBUTTON1** = **8** --- Extra Mouse Button 1
  628. - **BUTTON_XBUTTON2** = **9** --- Extra Mouse Button 2
  629. - **BUTTON_WHEEL_UP** = **4** --- Mouse wheel up
  630. - **BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down
  631. - **BUTTON_WHEEL_LEFT** = **6** --- Mouse wheel left button
  632. - **BUTTON_WHEEL_RIGHT** = **7** --- Mouse wheel right button
  633. - **BUTTON_MASK_LEFT** = **1** --- Left Mouse Button Mask
  634. - **BUTTON_MASK_RIGHT** = **2** --- Right Mouse Button Mask
  635. - **BUTTON_MASK_MIDDLE** = **4** --- Middle Mouse Button Mask
  636. - **BUTTON_MASK_XBUTTON1** = **128** --- Extra Mouse Button 1 Mask
  637. - **BUTTON_MASK_XBUTTON2** = **256** --- Extra Mouse Button 2 Mask
  638. .. _enum_@GlobalScope_JoystickList:
  639. .. _class_@GlobalScope_constant_JOY_BUTTON_0:
  640. .. _class_@GlobalScope_constant_JOY_BUTTON_1:
  641. .. _class_@GlobalScope_constant_JOY_BUTTON_2:
  642. .. _class_@GlobalScope_constant_JOY_BUTTON_3:
  643. .. _class_@GlobalScope_constant_JOY_BUTTON_4:
  644. .. _class_@GlobalScope_constant_JOY_BUTTON_5:
  645. .. _class_@GlobalScope_constant_JOY_BUTTON_6:
  646. .. _class_@GlobalScope_constant_JOY_BUTTON_7:
  647. .. _class_@GlobalScope_constant_JOY_BUTTON_8:
  648. .. _class_@GlobalScope_constant_JOY_BUTTON_9:
  649. .. _class_@GlobalScope_constant_JOY_BUTTON_10:
  650. .. _class_@GlobalScope_constant_JOY_BUTTON_11:
  651. .. _class_@GlobalScope_constant_JOY_BUTTON_12:
  652. .. _class_@GlobalScope_constant_JOY_BUTTON_13:
  653. .. _class_@GlobalScope_constant_JOY_BUTTON_14:
  654. .. _class_@GlobalScope_constant_JOY_BUTTON_15:
  655. .. _class_@GlobalScope_constant_JOY_BUTTON_MAX:
  656. .. _class_@GlobalScope_constant_JOY_SONY_CIRCLE:
  657. .. _class_@GlobalScope_constant_JOY_SONY_X:
  658. .. _class_@GlobalScope_constant_JOY_SONY_SQUARE:
  659. .. _class_@GlobalScope_constant_JOY_SONY_TRIANGLE:
  660. .. _class_@GlobalScope_constant_JOY_XBOX_B:
  661. .. _class_@GlobalScope_constant_JOY_XBOX_A:
  662. .. _class_@GlobalScope_constant_JOY_XBOX_X:
  663. .. _class_@GlobalScope_constant_JOY_XBOX_Y:
  664. .. _class_@GlobalScope_constant_JOY_DS_A:
  665. .. _class_@GlobalScope_constant_JOY_DS_B:
  666. .. _class_@GlobalScope_constant_JOY_DS_X:
  667. .. _class_@GlobalScope_constant_JOY_DS_Y:
  668. .. _class_@GlobalScope_constant_JOY_SELECT:
  669. .. _class_@GlobalScope_constant_JOY_START:
  670. .. _class_@GlobalScope_constant_JOY_DPAD_UP:
  671. .. _class_@GlobalScope_constant_JOY_DPAD_DOWN:
  672. .. _class_@GlobalScope_constant_JOY_DPAD_LEFT:
  673. .. _class_@GlobalScope_constant_JOY_DPAD_RIGHT:
  674. .. _class_@GlobalScope_constant_JOY_L:
  675. .. _class_@GlobalScope_constant_JOY_L2:
  676. .. _class_@GlobalScope_constant_JOY_L3:
  677. .. _class_@GlobalScope_constant_JOY_R:
  678. .. _class_@GlobalScope_constant_JOY_R2:
  679. .. _class_@GlobalScope_constant_JOY_R3:
  680. .. _class_@GlobalScope_constant_JOY_AXIS_0:
  681. .. _class_@GlobalScope_constant_JOY_AXIS_1:
  682. .. _class_@GlobalScope_constant_JOY_AXIS_2:
  683. .. _class_@GlobalScope_constant_JOY_AXIS_3:
  684. .. _class_@GlobalScope_constant_JOY_AXIS_4:
  685. .. _class_@GlobalScope_constant_JOY_AXIS_5:
  686. .. _class_@GlobalScope_constant_JOY_AXIS_6:
  687. .. _class_@GlobalScope_constant_JOY_AXIS_7:
  688. .. _class_@GlobalScope_constant_JOY_AXIS_8:
  689. .. _class_@GlobalScope_constant_JOY_AXIS_9:
  690. .. _class_@GlobalScope_constant_JOY_AXIS_MAX:
  691. .. _class_@GlobalScope_constant_JOY_ANALOG_LX:
  692. .. _class_@GlobalScope_constant_JOY_ANALOG_LY:
  693. .. _class_@GlobalScope_constant_JOY_ANALOG_RX:
  694. .. _class_@GlobalScope_constant_JOY_ANALOG_RY:
  695. .. _class_@GlobalScope_constant_JOY_ANALOG_L2:
  696. .. _class_@GlobalScope_constant_JOY_ANALOG_R2:
  697. enum **JoystickList**:
  698. - **JOY_BUTTON_0** = **0** --- Joypad Button 0
  699. - **JOY_BUTTON_1** = **1** --- Joypad Button 1
  700. - **JOY_BUTTON_2** = **2** --- Joypad Button 2
  701. - **JOY_BUTTON_3** = **3** --- Joypad Button 3
  702. - **JOY_BUTTON_4** = **4** --- Joypad Button 4
  703. - **JOY_BUTTON_5** = **5** --- Joypad Button 5
  704. - **JOY_BUTTON_6** = **6** --- Joypad Button 6
  705. - **JOY_BUTTON_7** = **7** --- Joypad Button 7
  706. - **JOY_BUTTON_8** = **8** --- Joypad Button 8
  707. - **JOY_BUTTON_9** = **9** --- Joypad Button 9
  708. - **JOY_BUTTON_10** = **10** --- Joypad Button 10
  709. - **JOY_BUTTON_11** = **11** --- Joypad Button 11
  710. - **JOY_BUTTON_12** = **12** --- Joypad Button 12
  711. - **JOY_BUTTON_13** = **13** --- Joypad Button 13
  712. - **JOY_BUTTON_14** = **14** --- Joypad Button 14
  713. - **JOY_BUTTON_15** = **15** --- Joypad Button 15
  714. - **JOY_BUTTON_MAX** = **16** --- Joypad Button 16
  715. - **JOY_SONY_CIRCLE** = **1** --- DUALSHOCK circle button
  716. - **JOY_SONY_X** = **0** --- DUALSHOCK X button
  717. - **JOY_SONY_SQUARE** = **2** --- DUALSHOCK square button
  718. - **JOY_SONY_TRIANGLE** = **3** --- DUALSHOCK triangle button
  719. - **JOY_XBOX_B** = **1** --- XBOX controller B button
  720. - **JOY_XBOX_A** = **0** --- XBOX controller A button
  721. - **JOY_XBOX_X** = **2** --- XBOX controller X button
  722. - **JOY_XBOX_Y** = **3** --- XBOX controller Y button
  723. - **JOY_DS_A** = **1** --- DualShock controller A button
  724. - **JOY_DS_B** = **0** --- DualShock controller B button
  725. - **JOY_DS_X** = **3** --- DualShock controller X button
  726. - **JOY_DS_Y** = **2** --- DualShock controller Y button
  727. - **JOY_SELECT** = **10** --- Joypad Button Select
  728. - **JOY_START** = **11** --- Joypad Button Start
  729. - **JOY_DPAD_UP** = **12** --- Joypad DPad Up
  730. - **JOY_DPAD_DOWN** = **13** --- Joypad DPad Down
  731. - **JOY_DPAD_LEFT** = **14** --- Joypad DPad Left
  732. - **JOY_DPAD_RIGHT** = **15** --- Joypad DPad Right
  733. - **JOY_L** = **4** --- Joypad Left Shoulder Button
  734. - **JOY_L2** = **6** --- Joypad Left Trigger
  735. - **JOY_L3** = **8** --- Joypad Left Stick Click
  736. - **JOY_R** = **5** --- Joypad Right Shoulder Button
  737. - **JOY_R2** = **7** --- Joypad Right Trigger
  738. - **JOY_R3** = **9** --- Joypad Right Stick Click
  739. - **JOY_AXIS_0** = **0** --- Joypad Left Stick Horizontal Axis
  740. - **JOY_AXIS_1** = **1** --- Joypad Left Stick Vertical Axis
  741. - **JOY_AXIS_2** = **2** --- Joypad Right Stick Horizontal Axis
  742. - **JOY_AXIS_3** = **3** --- Joypad Right Stick Vertical Axis
  743. - **JOY_AXIS_4** = **4**
  744. - **JOY_AXIS_5** = **5**
  745. - **JOY_AXIS_6** = **6** --- Joypad Left Trigger Analog Axis
  746. - **JOY_AXIS_7** = **7** --- Joypad Right Trigger Analog Axis
  747. - **JOY_AXIS_8** = **8**
  748. - **JOY_AXIS_9** = **9**
  749. - **JOY_AXIS_MAX** = **10**
  750. - **JOY_ANALOG_LX** = **0** --- Joypad Left Stick Horizontal Axis
  751. - **JOY_ANALOG_LY** = **1** --- Joypad Left Stick Vertical Axis
  752. - **JOY_ANALOG_RX** = **2** --- Joypad Right Stick Horizontal Axis
  753. - **JOY_ANALOG_RY** = **3** --- Joypad Right Stick Vertical Axis
  754. - **JOY_ANALOG_L2** = **6** --- Joypad Left Analog Trigger
  755. - **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger
  756. .. _enum_@GlobalScope_MidiMessageList:
  757. .. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF:
  758. .. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON:
  759. .. _class_@GlobalScope_constant_MIDI_MESSAGE_AFTERTOUCH:
  760. .. _class_@GlobalScope_constant_MIDI_MESSAGE_CONTROL_CHANGE:
  761. .. _class_@GlobalScope_constant_MIDI_MESSAGE_PROGRAM_CHANGE:
  762. .. _class_@GlobalScope_constant_MIDI_MESSAGE_CHANNEL_PRESSURE:
  763. .. _class_@GlobalScope_constant_MIDI_MESSAGE_PITCH_BEND:
  764. enum **MidiMessageList**:
  765. - **MIDI_MESSAGE_NOTE_OFF** = **8**
  766. - **MIDI_MESSAGE_NOTE_ON** = **9**
  767. - **MIDI_MESSAGE_AFTERTOUCH** = **10**
  768. - **MIDI_MESSAGE_CONTROL_CHANGE** = **11**
  769. - **MIDI_MESSAGE_PROGRAM_CHANGE** = **12**
  770. - **MIDI_MESSAGE_CHANNEL_PRESSURE** = **13**
  771. - **MIDI_MESSAGE_PITCH_BEND** = **14**
  772. .. _enum_@GlobalScope_Error:
  773. .. _class_@GlobalScope_constant_OK:
  774. .. _class_@GlobalScope_constant_FAILED:
  775. .. _class_@GlobalScope_constant_ERR_UNAVAILABLE:
  776. .. _class_@GlobalScope_constant_ERR_UNCONFIGURED:
  777. .. _class_@GlobalScope_constant_ERR_UNAUTHORIZED:
  778. .. _class_@GlobalScope_constant_ERR_PARAMETER_RANGE_ERROR:
  779. .. _class_@GlobalScope_constant_ERR_OUT_OF_MEMORY:
  780. .. _class_@GlobalScope_constant_ERR_FILE_NOT_FOUND:
  781. .. _class_@GlobalScope_constant_ERR_FILE_BAD_DRIVE:
  782. .. _class_@GlobalScope_constant_ERR_FILE_BAD_PATH:
  783. .. _class_@GlobalScope_constant_ERR_FILE_NO_PERMISSION:
  784. .. _class_@GlobalScope_constant_ERR_FILE_ALREADY_IN_USE:
  785. .. _class_@GlobalScope_constant_ERR_FILE_CANT_OPEN:
  786. .. _class_@GlobalScope_constant_ERR_FILE_CANT_WRITE:
  787. .. _class_@GlobalScope_constant_ERR_FILE_CANT_READ:
  788. .. _class_@GlobalScope_constant_ERR_FILE_UNRECOGNIZED:
  789. .. _class_@GlobalScope_constant_ERR_FILE_CORRUPT:
  790. .. _class_@GlobalScope_constant_ERR_FILE_MISSING_DEPENDENCIES:
  791. .. _class_@GlobalScope_constant_ERR_FILE_EOF:
  792. .. _class_@GlobalScope_constant_ERR_CANT_OPEN:
  793. .. _class_@GlobalScope_constant_ERR_CANT_CREATE:
  794. .. _class_@GlobalScope_constant_ERR_PARSE_ERROR:
  795. .. _class_@GlobalScope_constant_ERR_QUERY_FAILED:
  796. .. _class_@GlobalScope_constant_ERR_ALREADY_IN_USE:
  797. .. _class_@GlobalScope_constant_ERR_LOCKED:
  798. .. _class_@GlobalScope_constant_ERR_TIMEOUT:
  799. .. _class_@GlobalScope_constant_ERR_CANT_ACQUIRE_RESOURCE:
  800. .. _class_@GlobalScope_constant_ERR_INVALID_DATA:
  801. .. _class_@GlobalScope_constant_ERR_INVALID_PARAMETER:
  802. .. _class_@GlobalScope_constant_ERR_ALREADY_EXISTS:
  803. .. _class_@GlobalScope_constant_ERR_DOES_NOT_EXIST:
  804. .. _class_@GlobalScope_constant_ERR_DATABASE_CANT_READ:
  805. .. _class_@GlobalScope_constant_ERR_DATABASE_CANT_WRITE:
  806. .. _class_@GlobalScope_constant_ERR_COMPILATION_FAILED:
  807. .. _class_@GlobalScope_constant_ERR_METHOD_NOT_FOUND:
  808. .. _class_@GlobalScope_constant_ERR_LINK_FAILED:
  809. .. _class_@GlobalScope_constant_ERR_SCRIPT_FAILED:
  810. .. _class_@GlobalScope_constant_ERR_CYCLIC_LINK:
  811. .. _class_@GlobalScope_constant_ERR_BUSY:
  812. .. _class_@GlobalScope_constant_ERR_HELP:
  813. .. _class_@GlobalScope_constant_ERR_BUG:
  814. enum **Error**:
  815. - **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.
  816. - **FAILED** = **1** --- Generic error.
  817. - **ERR_UNAVAILABLE** = **2** --- Unavailable error
  818. - **ERR_UNCONFIGURED** = **3** --- Unconfigured error
  819. - **ERR_UNAUTHORIZED** = **4** --- Unauthorized error
  820. - **ERR_PARAMETER_RANGE_ERROR** = **5** --- Parameter range error
  821. - **ERR_OUT_OF_MEMORY** = **6** --- Out of memory (OOM) error
  822. - **ERR_FILE_NOT_FOUND** = **7** --- File: Not found error
  823. - **ERR_FILE_BAD_DRIVE** = **8** --- File: Bad drive error
  824. - **ERR_FILE_BAD_PATH** = **9** --- File: Bad path error
  825. - **ERR_FILE_NO_PERMISSION** = **10** --- File: No permission error
  826. - **ERR_FILE_ALREADY_IN_USE** = **11** --- File: Already in use error
  827. - **ERR_FILE_CANT_OPEN** = **12** --- File: Can't open error
  828. - **ERR_FILE_CANT_WRITE** = **13** --- File: Can't write error
  829. - **ERR_FILE_CANT_READ** = **14** --- File: Can't read error
  830. - **ERR_FILE_UNRECOGNIZED** = **15** --- File: Unrecognized error
  831. - **ERR_FILE_CORRUPT** = **16** --- File: Corrupt error
  832. - **ERR_FILE_MISSING_DEPENDENCIES** = **17** --- File: Missing dependencies error
  833. - **ERR_FILE_EOF** = **18** --- File: End of file (EOF) error
  834. - **ERR_CANT_OPEN** = **19** --- Can't open error
  835. - **ERR_CANT_CREATE** = **20** --- Can't create error
  836. - **ERR_PARSE_ERROR** = **43** --- Parse error
  837. - **ERR_QUERY_FAILED** = **21** --- Query failed error
  838. - **ERR_ALREADY_IN_USE** = **22** --- Already in use error
  839. - **ERR_LOCKED** = **23** --- Locked error
  840. - **ERR_TIMEOUT** = **24** --- Timeout error
  841. - **ERR_CANT_ACQUIRE_RESOURCE** = **28** --- Can't acquire resource error
  842. - **ERR_INVALID_DATA** = **30** --- Invalid data error
  843. - **ERR_INVALID_PARAMETER** = **31** --- Invalid parameter error
  844. - **ERR_ALREADY_EXISTS** = **32** --- Already exists error
  845. - **ERR_DOES_NOT_EXIST** = **33** --- Does not exist error
  846. - **ERR_DATABASE_CANT_READ** = **34** --- Database: Read error
  847. - **ERR_DATABASE_CANT_WRITE** = **35** --- Database: Write error
  848. - **ERR_COMPILATION_FAILED** = **36** --- Compilation failed error
  849. - **ERR_METHOD_NOT_FOUND** = **37** --- Method not found error
  850. - **ERR_LINK_FAILED** = **38** --- Linking failed error
  851. - **ERR_SCRIPT_FAILED** = **39** --- Script failed error
  852. - **ERR_CYCLIC_LINK** = **40** --- Cycling link (import cycle) error
  853. - **ERR_BUSY** = **44** --- Busy error
  854. - **ERR_HELP** = **46** --- Help error
  855. - **ERR_BUG** = **47** --- Bug error
  856. .. _enum_@GlobalScope_PropertyHint:
  857. .. _class_@GlobalScope_constant_PROPERTY_HINT_NONE:
  858. .. _class_@GlobalScope_constant_PROPERTY_HINT_RANGE:
  859. .. _class_@GlobalScope_constant_PROPERTY_HINT_EXP_RANGE:
  860. .. _class_@GlobalScope_constant_PROPERTY_HINT_ENUM:
  861. .. _class_@GlobalScope_constant_PROPERTY_HINT_EXP_EASING:
  862. .. _class_@GlobalScope_constant_PROPERTY_HINT_LENGTH:
  863. .. _class_@GlobalScope_constant_PROPERTY_HINT_KEY_ACCEL:
  864. .. _class_@GlobalScope_constant_PROPERTY_HINT_FLAGS:
  865. .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_RENDER:
  866. .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_PHYSICS:
  867. .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_RENDER:
  868. .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_PHYSICS:
  869. .. _class_@GlobalScope_constant_PROPERTY_HINT_FILE:
  870. .. _class_@GlobalScope_constant_PROPERTY_HINT_DIR:
  871. .. _class_@GlobalScope_constant_PROPERTY_HINT_GLOBAL_FILE:
  872. .. _class_@GlobalScope_constant_PROPERTY_HINT_GLOBAL_DIR:
  873. .. _class_@GlobalScope_constant_PROPERTY_HINT_RESOURCE_TYPE:
  874. .. _class_@GlobalScope_constant_PROPERTY_HINT_MULTILINE_TEXT:
  875. .. _class_@GlobalScope_constant_PROPERTY_HINT_PLACEHOLDER_TEXT:
  876. .. _class_@GlobalScope_constant_PROPERTY_HINT_COLOR_NO_ALPHA:
  877. .. _class_@GlobalScope_constant_PROPERTY_HINT_IMAGE_COMPRESS_LOSSY:
  878. .. _class_@GlobalScope_constant_PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS:
  879. enum **PropertyHint**:
  880. - **PROPERTY_HINT_NONE** = **0** --- No hint for edited property.
  881. - **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.
  882. - **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.
  883. - **PROPERTY_HINT_ENUM** = **3** --- Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
  884. - **PROPERTY_HINT_EXP_EASING** = **4**
  885. - **PROPERTY_HINT_LENGTH** = **5**
  886. - **PROPERTY_HINT_KEY_ACCEL** = **7**
  887. - **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.
  888. - **PROPERTY_HINT_LAYERS_2D_RENDER** = **9**
  889. - **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10**
  890. - **PROPERTY_HINT_LAYERS_3D_RENDER** = **11**
  891. - **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12**
  892. - **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".
  893. - **PROPERTY_HINT_DIR** = **14** --- String property is a directory (so pop up a file dialog when edited).
  894. - **PROPERTY_HINT_GLOBAL_FILE** = **15**
  895. - **PROPERTY_HINT_GLOBAL_DIR** = **16**
  896. - **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- String property is a resource, so open the resource popup menu when edited.
  897. - **PROPERTY_HINT_MULTILINE_TEXT** = **18**
  898. - **PROPERTY_HINT_PLACEHOLDER_TEXT** = **19**
  899. - **PROPERTY_HINT_COLOR_NO_ALPHA** = **20**
  900. - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that the image is compressed using lossy compression.
  901. - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that the image is compressed using lossless compression.
  902. .. _enum_@GlobalScope_PropertyUsageFlags:
  903. .. _class_@GlobalScope_constant_PROPERTY_USAGE_STORAGE:
  904. .. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR:
  905. .. _class_@GlobalScope_constant_PROPERTY_USAGE_NETWORK:
  906. .. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR_HELPER:
  907. .. _class_@GlobalScope_constant_PROPERTY_USAGE_CHECKABLE:
  908. .. _class_@GlobalScope_constant_PROPERTY_USAGE_CHECKED:
  909. .. _class_@GlobalScope_constant_PROPERTY_USAGE_INTERNATIONALIZED:
  910. .. _class_@GlobalScope_constant_PROPERTY_USAGE_GROUP:
  911. .. _class_@GlobalScope_constant_PROPERTY_USAGE_CATEGORY:
  912. .. _class_@GlobalScope_constant_PROPERTY_USAGE_NO_INSTANCE_STATE:
  913. .. _class_@GlobalScope_constant_PROPERTY_USAGE_RESTART_IF_CHANGED:
  914. .. _class_@GlobalScope_constant_PROPERTY_USAGE_SCRIPT_VARIABLE:
  915. .. _class_@GlobalScope_constant_PROPERTY_USAGE_DEFAULT:
  916. .. _class_@GlobalScope_constant_PROPERTY_USAGE_DEFAULT_INTL:
  917. .. _class_@GlobalScope_constant_PROPERTY_USAGE_NOEDITOR:
  918. enum **PropertyUsageFlags**:
  919. - **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default).
  920. - **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default).
  921. - **PROPERTY_USAGE_NETWORK** = **4**
  922. - **PROPERTY_USAGE_EDITOR_HELPER** = **8**
  923. - **PROPERTY_USAGE_CHECKABLE** = **16**
  924. - **PROPERTY_USAGE_CHECKED** = **32**
  925. - **PROPERTY_USAGE_INTERNATIONALIZED** = **64**
  926. - **PROPERTY_USAGE_GROUP** = **128**
  927. - **PROPERTY_USAGE_CATEGORY** = **256**
  928. - **PROPERTY_USAGE_NO_INSTANCE_STATE** = **2048**
  929. - **PROPERTY_USAGE_RESTART_IF_CHANGED** = **4096**
  930. - **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192**
  931. - **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor).
  932. - **PROPERTY_USAGE_DEFAULT_INTL** = **71**
  933. - **PROPERTY_USAGE_NOEDITOR** = **5**
  934. .. _enum_@GlobalScope_MethodFlags:
  935. .. _class_@GlobalScope_constant_METHOD_FLAG_NORMAL:
  936. .. _class_@GlobalScope_constant_METHOD_FLAG_EDITOR:
  937. .. _class_@GlobalScope_constant_METHOD_FLAG_NOSCRIPT:
  938. .. _class_@GlobalScope_constant_METHOD_FLAG_CONST:
  939. .. _class_@GlobalScope_constant_METHOD_FLAG_REVERSE:
  940. .. _class_@GlobalScope_constant_METHOD_FLAG_VIRTUAL:
  941. .. _class_@GlobalScope_constant_METHOD_FLAG_FROM_SCRIPT:
  942. .. _class_@GlobalScope_constant_METHOD_FLAGS_DEFAULT:
  943. enum **MethodFlags**:
  944. - **METHOD_FLAG_NORMAL** = **1** --- Flag for normal method
  945. - **METHOD_FLAG_EDITOR** = **2** --- Flag for editor method
  946. - **METHOD_FLAG_NOSCRIPT** = **4**
  947. - **METHOD_FLAG_CONST** = **8** --- Flag for constant method
  948. - **METHOD_FLAG_REVERSE** = **16**
  949. - **METHOD_FLAG_VIRTUAL** = **32** --- Flag for virtual method
  950. - **METHOD_FLAG_FROM_SCRIPT** = **64** --- Flag for method from script
  951. - **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags
  952. .. _enum_@GlobalScope_Variant.Type:
  953. .. _class_@GlobalScope_constant_TYPE_NIL:
  954. .. _class_@GlobalScope_constant_TYPE_BOOL:
  955. .. _class_@GlobalScope_constant_TYPE_INT:
  956. .. _class_@GlobalScope_constant_TYPE_REAL:
  957. .. _class_@GlobalScope_constant_TYPE_STRING:
  958. .. _class_@GlobalScope_constant_TYPE_VECTOR2:
  959. .. _class_@GlobalScope_constant_TYPE_RECT2:
  960. .. _class_@GlobalScope_constant_TYPE_VECTOR3:
  961. .. _class_@GlobalScope_constant_TYPE_TRANSFORM2D:
  962. .. _class_@GlobalScope_constant_TYPE_PLANE:
  963. .. _class_@GlobalScope_constant_TYPE_QUAT:
  964. .. _class_@GlobalScope_constant_TYPE_AABB:
  965. .. _class_@GlobalScope_constant_TYPE_BASIS:
  966. .. _class_@GlobalScope_constant_TYPE_TRANSFORM:
  967. .. _class_@GlobalScope_constant_TYPE_COLOR:
  968. .. _class_@GlobalScope_constant_TYPE_NODE_PATH:
  969. .. _class_@GlobalScope_constant_TYPE_RID:
  970. .. _class_@GlobalScope_constant_TYPE_OBJECT:
  971. .. _class_@GlobalScope_constant_TYPE_DICTIONARY:
  972. .. _class_@GlobalScope_constant_TYPE_ARRAY:
  973. .. _class_@GlobalScope_constant_TYPE_RAW_ARRAY:
  974. .. _class_@GlobalScope_constant_TYPE_INT_ARRAY:
  975. .. _class_@GlobalScope_constant_TYPE_REAL_ARRAY:
  976. .. _class_@GlobalScope_constant_TYPE_STRING_ARRAY:
  977. .. _class_@GlobalScope_constant_TYPE_VECTOR2_ARRAY:
  978. .. _class_@GlobalScope_constant_TYPE_VECTOR3_ARRAY:
  979. .. _class_@GlobalScope_constant_TYPE_COLOR_ARRAY:
  980. .. _class_@GlobalScope_constant_TYPE_MAX:
  981. enum **Variant.Type**:
  982. - **TYPE_NIL** = **0** --- Variable is of type nil (only applied for null).
  983. - **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool<class_bool>`.
  984. - **TYPE_INT** = **2** --- Variable is of type :ref:`int<class_int>`.
  985. - **TYPE_REAL** = **3** --- Variable is of type :ref:`float<class_float>`/real.
  986. - **TYPE_STRING** = **4** --- Variable is of type :ref:`String<class_String>`.
  987. - **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2<class_Vector2>`.
  988. - **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2<class_Rect2>`.
  989. - **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3<class_Vector3>`.
  990. - **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D<class_Transform2D>`.
  991. - **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane<class_Plane>`.
  992. - **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat<class_Quat>`.
  993. - **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB<class_AABB>`.
  994. - **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis<class_Basis>`.
  995. - **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform<class_Transform>`.
  996. - **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color<class_Color>`.
  997. - **TYPE_NODE_PATH** = **15** --- Variable is of type :ref:`NodePath<class_NodePath>`.
  998. - **TYPE_RID** = **16** --- Variable is of type :ref:`RID<class_RID>`.
  999. - **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object<class_Object>`.
  1000. - **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary<class_Dictionary>`.
  1001. - **TYPE_ARRAY** = **19** --- Variable is of type :ref:`Array<class_Array>`.
  1002. - **TYPE_RAW_ARRAY** = **20** --- Variable is of type :ref:`PoolByteArray<class_PoolByteArray>`.
  1003. - **TYPE_INT_ARRAY** = **21** --- Variable is of type :ref:`PoolIntArray<class_PoolIntArray>`.
  1004. - **TYPE_REAL_ARRAY** = **22** --- Variable is of type :ref:`PoolRealArray<class_PoolRealArray>`.
  1005. - **TYPE_STRING_ARRAY** = **23** --- Variable is of type :ref:`PoolStringArray<class_PoolStringArray>`.
  1006. - **TYPE_VECTOR2_ARRAY** = **24** --- Variable is of type :ref:`PoolVector2Array<class_PoolVector2Array>`.
  1007. - **TYPE_VECTOR3_ARRAY** = **25** --- Variable is of type :ref:`PoolVector3Array<class_PoolVector3Array>`.
  1008. - **TYPE_COLOR_ARRAY** = **26** --- Variable is of type :ref:`PoolColorArray<class_PoolColorArray>`.
  1009. - **TYPE_MAX** = **27** --- Marker for end of type constants.
  1010. .. _enum_@GlobalScope_Variant.Operator:
  1011. .. _class_@GlobalScope_constant_OP_EQUAL:
  1012. .. _class_@GlobalScope_constant_OP_NOT_EQUAL:
  1013. .. _class_@GlobalScope_constant_OP_LESS:
  1014. .. _class_@GlobalScope_constant_OP_LESS_EQUAL:
  1015. .. _class_@GlobalScope_constant_OP_GREATER:
  1016. .. _class_@GlobalScope_constant_OP_GREATER_EQUAL:
  1017. .. _class_@GlobalScope_constant_OP_ADD:
  1018. .. _class_@GlobalScope_constant_OP_SUBTRACT:
  1019. .. _class_@GlobalScope_constant_OP_MULTIPLY:
  1020. .. _class_@GlobalScope_constant_OP_DIVIDE:
  1021. .. _class_@GlobalScope_constant_OP_NEGATE:
  1022. .. _class_@GlobalScope_constant_OP_POSITIVE:
  1023. .. _class_@GlobalScope_constant_OP_MODULE:
  1024. .. _class_@GlobalScope_constant_OP_STRING_CONCAT:
  1025. .. _class_@GlobalScope_constant_OP_SHIFT_LEFT:
  1026. .. _class_@GlobalScope_constant_OP_SHIFT_RIGHT:
  1027. .. _class_@GlobalScope_constant_OP_BIT_AND:
  1028. .. _class_@GlobalScope_constant_OP_BIT_OR:
  1029. .. _class_@GlobalScope_constant_OP_BIT_XOR:
  1030. .. _class_@GlobalScope_constant_OP_BIT_NEGATE:
  1031. .. _class_@GlobalScope_constant_OP_AND:
  1032. .. _class_@GlobalScope_constant_OP_OR:
  1033. .. _class_@GlobalScope_constant_OP_XOR:
  1034. .. _class_@GlobalScope_constant_OP_NOT:
  1035. .. _class_@GlobalScope_constant_OP_IN:
  1036. .. _class_@GlobalScope_constant_OP_MAX:
  1037. enum **Variant.Operator**:
  1038. - **OP_EQUAL** = **0**
  1039. - **OP_NOT_EQUAL** = **1**
  1040. - **OP_LESS** = **2**
  1041. - **OP_LESS_EQUAL** = **3**
  1042. - **OP_GREATER** = **4**
  1043. - **OP_GREATER_EQUAL** = **5**
  1044. - **OP_ADD** = **6**
  1045. - **OP_SUBTRACT** = **7**
  1046. - **OP_MULTIPLY** = **8**
  1047. - **OP_DIVIDE** = **9**
  1048. - **OP_NEGATE** = **10**
  1049. - **OP_POSITIVE** = **11**
  1050. - **OP_MODULE** = **12**
  1051. - **OP_STRING_CONCAT** = **13**
  1052. - **OP_SHIFT_LEFT** = **14**
  1053. - **OP_SHIFT_RIGHT** = **15**
  1054. - **OP_BIT_AND** = **16**
  1055. - **OP_BIT_OR** = **17**
  1056. - **OP_BIT_XOR** = **18**
  1057. - **OP_BIT_NEGATE** = **19**
  1058. - **OP_AND** = **20**
  1059. - **OP_OR** = **21**
  1060. - **OP_XOR** = **22**
  1061. - **OP_NOT** = **23**
  1062. - **OP_IN** = **24**
  1063. - **OP_MAX** = **25**
  1064. Constants
  1065. ---------
  1066. .. _class_@GlobalScope_constant_SPKEY:
  1067. - **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable.
  1068. Description
  1069. -----------
  1070. 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.
  1071. Singletons are also documented here, since they can be accessed from anywhere.
  1072. Property Descriptions
  1073. ---------------------
  1074. .. _class_@GlobalScope_property_ARVRServer:
  1075. - :ref:`ARVRServer<class_ARVRServer>` **ARVRServer**
  1076. :ref:`ARVRServer<class_ARVRServer>` singleton
  1077. .. _class_@GlobalScope_property_AudioServer:
  1078. - :ref:`AudioServer<class_AudioServer>` **AudioServer**
  1079. :ref:`AudioServer<class_AudioServer>` singleton
  1080. .. _class_@GlobalScope_property_ClassDB:
  1081. - :ref:`ClassDB<class_ClassDB>` **ClassDB**
  1082. :ref:`ClassDB<class_ClassDB>` singleton
  1083. .. _class_@GlobalScope_property_Engine:
  1084. - :ref:`Engine<class_Engine>` **Engine**
  1085. :ref:`Engine<class_Engine>` singleton
  1086. .. _class_@GlobalScope_property_Geometry:
  1087. - :ref:`Geometry<class_Geometry>` **Geometry**
  1088. :ref:`Geometry<class_Geometry>` singleton
  1089. .. _class_@GlobalScope_property_IP:
  1090. - :ref:`IP<class_IP>` **IP**
  1091. :ref:`IP<class_IP>` singleton
  1092. .. _class_@GlobalScope_property_Input:
  1093. - :ref:`Input<class_Input>` **Input**
  1094. :ref:`Input<class_Input>` singleton
  1095. .. _class_@GlobalScope_property_InputMap:
  1096. - :ref:`InputMap<class_InputMap>` **InputMap**
  1097. :ref:`InputMap<class_InputMap>` singleton
  1098. .. _class_@GlobalScope_property_JSON:
  1099. - :ref:`JSON<class_JSON>` **JSON**
  1100. :ref:`JSON<class_JSON>` singleton
  1101. .. _class_@GlobalScope_property_JavaScript:
  1102. - :ref:`JavaScript<class_JavaScript>` **JavaScript**
  1103. :ref:`JavaScript<class_JavaScript>` singleton
  1104. .. _class_@GlobalScope_property_Marshalls:
  1105. - :ref:`Reference<class_Reference>` **Marshalls**
  1106. :ref:`Marshalls<class_Marshalls>` singleton
  1107. .. _class_@GlobalScope_property_NavigationMeshGenerator:
  1108. - :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>` **NavigationMeshGenerator**
  1109. .. _class_@GlobalScope_property_OS:
  1110. - :ref:`OS<class_OS>` **OS**
  1111. :ref:`OS<class_OS>` singleton
  1112. .. _class_@GlobalScope_property_Performance:
  1113. - :ref:`Performance<class_Performance>` **Performance**
  1114. :ref:`Performance<class_Performance>` singleton
  1115. .. _class_@GlobalScope_property_Physics2DServer:
  1116. - :ref:`Physics2DServer<class_Physics2DServer>` **Physics2DServer**
  1117. :ref:`Physics2DServer<class_Physics2DServer>` singleton
  1118. .. _class_@GlobalScope_property_PhysicsServer:
  1119. - :ref:`PhysicsServer<class_PhysicsServer>` **PhysicsServer**
  1120. :ref:`PhysicsServer<class_PhysicsServer>` singleton
  1121. .. _class_@GlobalScope_property_ProjectSettings:
  1122. - :ref:`ProjectSettings<class_ProjectSettings>` **ProjectSettings**
  1123. :ref:`ProjectSettings<class_ProjectSettings>` singleton
  1124. .. _class_@GlobalScope_property_ResourceLoader:
  1125. - :ref:`ResourceLoader<class_ResourceLoader>` **ResourceLoader**
  1126. :ref:`ResourceLoader<class_ResourceLoader>` singleton
  1127. .. _class_@GlobalScope_property_ResourceSaver:
  1128. - :ref:`ResourceSaver<class_ResourceSaver>` **ResourceSaver**
  1129. :ref:`ResourceSaver<class_ResourceSaver>` singleton
  1130. .. _class_@GlobalScope_property_TranslationServer:
  1131. - :ref:`TranslationServer<class_TranslationServer>` **TranslationServer**
  1132. :ref:`TranslationServer<class_TranslationServer>` singleton
  1133. .. _class_@GlobalScope_property_VisualScriptEditor:
  1134. - :ref:`VisualScriptEditor<class_VisualScriptEditor>` **VisualScriptEditor**
  1135. :ref:`VisualScriptEditor<class_VisualScriptEditor>` singleton
  1136. .. _class_@GlobalScope_property_VisualServer:
  1137. - :ref:`VisualServer<class_VisualServer>` **VisualServer**
  1138. :ref:`VisualServer<class_VisualServer>` singleton