[email protected] 62 KB

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