123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the @GlobalScope.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_@GlobalScope:
- @GlobalScope
- ============
- **Category:** Core
- Brief Description
- -----------------
- Global scope constants and variables.
- Properties
- ----------
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`ARVRServer<class_ARVRServer>` | :ref:`ARVRServer<class_@GlobalScope_property_ARVRServer>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`AudioServer<class_AudioServer>` | :ref:`AudioServer<class_@GlobalScope_property_AudioServer>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`ClassDB<class_ClassDB>` | :ref:`ClassDB<class_@GlobalScope_property_ClassDB>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`Engine<class_Engine>` | :ref:`Engine<class_@GlobalScope_property_Engine>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`Geometry<class_Geometry>` | :ref:`Geometry<class_@GlobalScope_property_Geometry>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`IP<class_IP>` | :ref:`IP<class_@GlobalScope_property_IP>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`Input<class_Input>` | :ref:`Input<class_@GlobalScope_property_Input>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`InputMap<class_InputMap>` | :ref:`InputMap<class_@GlobalScope_property_InputMap>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`JSON<class_JSON>` | :ref:`JSON<class_@GlobalScope_property_JSON>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`JavaScript<class_JavaScript>` | :ref:`JavaScript<class_@GlobalScope_property_JavaScript>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`Reference<class_Reference>` | :ref:`Marshalls<class_@GlobalScope_property_Marshalls>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>` | :ref:`NavigationMeshGenerator<class_@GlobalScope_property_NavigationMeshGenerator>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`OS<class_OS>` | :ref:`OS<class_@GlobalScope_property_OS>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`Performance<class_Performance>` | :ref:`Performance<class_@GlobalScope_property_Performance>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`Physics2DServer<class_Physics2DServer>` | :ref:`Physics2DServer<class_@GlobalScope_property_Physics2DServer>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`PhysicsServer<class_PhysicsServer>` | :ref:`PhysicsServer<class_@GlobalScope_property_PhysicsServer>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`ProjectSettings<class_ProjectSettings>` | :ref:`ProjectSettings<class_@GlobalScope_property_ProjectSettings>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`ResourceLoader<class_ResourceLoader>` | :ref:`ResourceLoader<class_@GlobalScope_property_ResourceLoader>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`ResourceSaver<class_ResourceSaver>` | :ref:`ResourceSaver<class_@GlobalScope_property_ResourceSaver>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`TranslationServer<class_TranslationServer>` | :ref:`TranslationServer<class_@GlobalScope_property_TranslationServer>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`VisualScriptEditor<class_VisualScriptEditor>` | :ref:`VisualScriptEditor<class_@GlobalScope_property_VisualScriptEditor>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | :ref:`VisualServer<class_VisualServer>` | :ref:`VisualServer<class_@GlobalScope_property_VisualServer>` |
- +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
- Enumerations
- ------------
- .. _enum_@GlobalScope_Margin:
- .. _class_@GlobalScope_constant_MARGIN_LEFT:
- .. _class_@GlobalScope_constant_MARGIN_TOP:
- .. _class_@GlobalScope_constant_MARGIN_RIGHT:
- .. _class_@GlobalScope_constant_MARGIN_BOTTOM:
- enum **Margin**:
- - **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
- - **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
- - **MARGIN_RIGHT** = **2** --- Right margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
- - **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
- .. _enum_@GlobalScope_Corner:
- .. _class_@GlobalScope_constant_CORNER_TOP_LEFT:
- .. _class_@GlobalScope_constant_CORNER_TOP_RIGHT:
- .. _class_@GlobalScope_constant_CORNER_BOTTOM_RIGHT:
- .. _class_@GlobalScope_constant_CORNER_BOTTOM_LEFT:
- enum **Corner**:
- - **CORNER_TOP_LEFT** = **0**
- - **CORNER_TOP_RIGHT** = **1**
- - **CORNER_BOTTOM_RIGHT** = **2**
- - **CORNER_BOTTOM_LEFT** = **3**
- .. _enum_@GlobalScope_Orientation:
- .. _class_@GlobalScope_constant_VERTICAL:
- .. _class_@GlobalScope_constant_HORIZONTAL:
- enum **Orientation**:
- - **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc.
- - **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc.
- .. _enum_@GlobalScope_HAlign:
- .. _class_@GlobalScope_constant_HALIGN_LEFT:
- .. _class_@GlobalScope_constant_HALIGN_CENTER:
- .. _class_@GlobalScope_constant_HALIGN_RIGHT:
- enum **HAlign**:
- - **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes.
- - **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes.
- - **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes.
- .. _enum_@GlobalScope_VAlign:
- .. _class_@GlobalScope_constant_VALIGN_TOP:
- .. _class_@GlobalScope_constant_VALIGN_CENTER:
- .. _class_@GlobalScope_constant_VALIGN_BOTTOM:
- enum **VAlign**:
- - **VALIGN_TOP** = **0** --- Vertical top alignment, usually for text-derived classes.
- - **VALIGN_CENTER** = **1** --- Vertical center alignment, usually for text-derived classes.
- - **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes.
- .. _enum_@GlobalScope_KeyList:
- .. _class_@GlobalScope_constant_KEY_ESCAPE:
- .. _class_@GlobalScope_constant_KEY_TAB:
- .. _class_@GlobalScope_constant_KEY_BACKTAB:
- .. _class_@GlobalScope_constant_KEY_BACKSPACE:
- .. _class_@GlobalScope_constant_KEY_ENTER:
- .. _class_@GlobalScope_constant_KEY_KP_ENTER:
- .. _class_@GlobalScope_constant_KEY_INSERT:
- .. _class_@GlobalScope_constant_KEY_DELETE:
- .. _class_@GlobalScope_constant_KEY_PAUSE:
- .. _class_@GlobalScope_constant_KEY_PRINT:
- .. _class_@GlobalScope_constant_KEY_SYSREQ:
- .. _class_@GlobalScope_constant_KEY_CLEAR:
- .. _class_@GlobalScope_constant_KEY_HOME:
- .. _class_@GlobalScope_constant_KEY_END:
- .. _class_@GlobalScope_constant_KEY_LEFT:
- .. _class_@GlobalScope_constant_KEY_UP:
- .. _class_@GlobalScope_constant_KEY_RIGHT:
- .. _class_@GlobalScope_constant_KEY_DOWN:
- .. _class_@GlobalScope_constant_KEY_PAGEUP:
- .. _class_@GlobalScope_constant_KEY_PAGEDOWN:
- .. _class_@GlobalScope_constant_KEY_SHIFT:
- .. _class_@GlobalScope_constant_KEY_CONTROL:
- .. _class_@GlobalScope_constant_KEY_META:
- .. _class_@GlobalScope_constant_KEY_ALT:
- .. _class_@GlobalScope_constant_KEY_CAPSLOCK:
- .. _class_@GlobalScope_constant_KEY_NUMLOCK:
- .. _class_@GlobalScope_constant_KEY_SCROLLLOCK:
- .. _class_@GlobalScope_constant_KEY_F1:
- .. _class_@GlobalScope_constant_KEY_F2:
- .. _class_@GlobalScope_constant_KEY_F3:
- .. _class_@GlobalScope_constant_KEY_F4:
- .. _class_@GlobalScope_constant_KEY_F5:
- .. _class_@GlobalScope_constant_KEY_F6:
- .. _class_@GlobalScope_constant_KEY_F7:
- .. _class_@GlobalScope_constant_KEY_F8:
- .. _class_@GlobalScope_constant_KEY_F9:
- .. _class_@GlobalScope_constant_KEY_F10:
- .. _class_@GlobalScope_constant_KEY_F11:
- .. _class_@GlobalScope_constant_KEY_F12:
- .. _class_@GlobalScope_constant_KEY_F13:
- .. _class_@GlobalScope_constant_KEY_F14:
- .. _class_@GlobalScope_constant_KEY_F15:
- .. _class_@GlobalScope_constant_KEY_F16:
- .. _class_@GlobalScope_constant_KEY_KP_MULTIPLY:
- .. _class_@GlobalScope_constant_KEY_KP_DIVIDE:
- .. _class_@GlobalScope_constant_KEY_KP_SUBTRACT:
- .. _class_@GlobalScope_constant_KEY_KP_PERIOD:
- .. _class_@GlobalScope_constant_KEY_KP_ADD:
- .. _class_@GlobalScope_constant_KEY_KP_0:
- .. _class_@GlobalScope_constant_KEY_KP_1:
- .. _class_@GlobalScope_constant_KEY_KP_2:
- .. _class_@GlobalScope_constant_KEY_KP_3:
- .. _class_@GlobalScope_constant_KEY_KP_4:
- .. _class_@GlobalScope_constant_KEY_KP_5:
- .. _class_@GlobalScope_constant_KEY_KP_6:
- .. _class_@GlobalScope_constant_KEY_KP_7:
- .. _class_@GlobalScope_constant_KEY_KP_8:
- .. _class_@GlobalScope_constant_KEY_KP_9:
- .. _class_@GlobalScope_constant_KEY_SUPER_L:
- .. _class_@GlobalScope_constant_KEY_SUPER_R:
- .. _class_@GlobalScope_constant_KEY_MENU:
- .. _class_@GlobalScope_constant_KEY_HYPER_L:
- .. _class_@GlobalScope_constant_KEY_HYPER_R:
- .. _class_@GlobalScope_constant_KEY_HELP:
- .. _class_@GlobalScope_constant_KEY_DIRECTION_L:
- .. _class_@GlobalScope_constant_KEY_DIRECTION_R:
- .. _class_@GlobalScope_constant_KEY_BACK:
- .. _class_@GlobalScope_constant_KEY_FORWARD:
- .. _class_@GlobalScope_constant_KEY_STOP:
- .. _class_@GlobalScope_constant_KEY_REFRESH:
- .. _class_@GlobalScope_constant_KEY_VOLUMEDOWN:
- .. _class_@GlobalScope_constant_KEY_VOLUMEMUTE:
- .. _class_@GlobalScope_constant_KEY_VOLUMEUP:
- .. _class_@GlobalScope_constant_KEY_BASSBOOST:
- .. _class_@GlobalScope_constant_KEY_BASSUP:
- .. _class_@GlobalScope_constant_KEY_BASSDOWN:
- .. _class_@GlobalScope_constant_KEY_TREBLEUP:
- .. _class_@GlobalScope_constant_KEY_TREBLEDOWN:
- .. _class_@GlobalScope_constant_KEY_MEDIAPLAY:
- .. _class_@GlobalScope_constant_KEY_MEDIASTOP:
- .. _class_@GlobalScope_constant_KEY_MEDIAPREVIOUS:
- .. _class_@GlobalScope_constant_KEY_MEDIANEXT:
- .. _class_@GlobalScope_constant_KEY_MEDIARECORD:
- .. _class_@GlobalScope_constant_KEY_HOMEPAGE:
- .. _class_@GlobalScope_constant_KEY_FAVORITES:
- .. _class_@GlobalScope_constant_KEY_SEARCH:
- .. _class_@GlobalScope_constant_KEY_STANDBY:
- .. _class_@GlobalScope_constant_KEY_OPENURL:
- .. _class_@GlobalScope_constant_KEY_LAUNCHMAIL:
- .. _class_@GlobalScope_constant_KEY_LAUNCHMEDIA:
- .. _class_@GlobalScope_constant_KEY_LAUNCH0:
- .. _class_@GlobalScope_constant_KEY_LAUNCH1:
- .. _class_@GlobalScope_constant_KEY_LAUNCH2:
- .. _class_@GlobalScope_constant_KEY_LAUNCH3:
- .. _class_@GlobalScope_constant_KEY_LAUNCH4:
- .. _class_@GlobalScope_constant_KEY_LAUNCH5:
- .. _class_@GlobalScope_constant_KEY_LAUNCH6:
- .. _class_@GlobalScope_constant_KEY_LAUNCH7:
- .. _class_@GlobalScope_constant_KEY_LAUNCH8:
- .. _class_@GlobalScope_constant_KEY_LAUNCH9:
- .. _class_@GlobalScope_constant_KEY_LAUNCHA:
- .. _class_@GlobalScope_constant_KEY_LAUNCHB:
- .. _class_@GlobalScope_constant_KEY_LAUNCHC:
- .. _class_@GlobalScope_constant_KEY_LAUNCHD:
- .. _class_@GlobalScope_constant_KEY_LAUNCHE:
- .. _class_@GlobalScope_constant_KEY_LAUNCHF:
- .. _class_@GlobalScope_constant_KEY_UNKNOWN:
- .. _class_@GlobalScope_constant_KEY_SPACE:
- .. _class_@GlobalScope_constant_KEY_EXCLAM:
- .. _class_@GlobalScope_constant_KEY_QUOTEDBL:
- .. _class_@GlobalScope_constant_KEY_NUMBERSIGN:
- .. _class_@GlobalScope_constant_KEY_DOLLAR:
- .. _class_@GlobalScope_constant_KEY_PERCENT:
- .. _class_@GlobalScope_constant_KEY_AMPERSAND:
- .. _class_@GlobalScope_constant_KEY_APOSTROPHE:
- .. _class_@GlobalScope_constant_KEY_PARENLEFT:
- .. _class_@GlobalScope_constant_KEY_PARENRIGHT:
- .. _class_@GlobalScope_constant_KEY_ASTERISK:
- .. _class_@GlobalScope_constant_KEY_PLUS:
- .. _class_@GlobalScope_constant_KEY_COMMA:
- .. _class_@GlobalScope_constant_KEY_MINUS:
- .. _class_@GlobalScope_constant_KEY_PERIOD:
- .. _class_@GlobalScope_constant_KEY_SLASH:
- .. _class_@GlobalScope_constant_KEY_0:
- .. _class_@GlobalScope_constant_KEY_1:
- .. _class_@GlobalScope_constant_KEY_2:
- .. _class_@GlobalScope_constant_KEY_3:
- .. _class_@GlobalScope_constant_KEY_4:
- .. _class_@GlobalScope_constant_KEY_5:
- .. _class_@GlobalScope_constant_KEY_6:
- .. _class_@GlobalScope_constant_KEY_7:
- .. _class_@GlobalScope_constant_KEY_8:
- .. _class_@GlobalScope_constant_KEY_9:
- .. _class_@GlobalScope_constant_KEY_COLON:
- .. _class_@GlobalScope_constant_KEY_SEMICOLON:
- .. _class_@GlobalScope_constant_KEY_LESS:
- .. _class_@GlobalScope_constant_KEY_EQUAL:
- .. _class_@GlobalScope_constant_KEY_GREATER:
- .. _class_@GlobalScope_constant_KEY_QUESTION:
- .. _class_@GlobalScope_constant_KEY_AT:
- .. _class_@GlobalScope_constant_KEY_A:
- .. _class_@GlobalScope_constant_KEY_B:
- .. _class_@GlobalScope_constant_KEY_C:
- .. _class_@GlobalScope_constant_KEY_D:
- .. _class_@GlobalScope_constant_KEY_E:
- .. _class_@GlobalScope_constant_KEY_F:
- .. _class_@GlobalScope_constant_KEY_G:
- .. _class_@GlobalScope_constant_KEY_H:
- .. _class_@GlobalScope_constant_KEY_I:
- .. _class_@GlobalScope_constant_KEY_J:
- .. _class_@GlobalScope_constant_KEY_K:
- .. _class_@GlobalScope_constant_KEY_L:
- .. _class_@GlobalScope_constant_KEY_M:
- .. _class_@GlobalScope_constant_KEY_N:
- .. _class_@GlobalScope_constant_KEY_O:
- .. _class_@GlobalScope_constant_KEY_P:
- .. _class_@GlobalScope_constant_KEY_Q:
- .. _class_@GlobalScope_constant_KEY_R:
- .. _class_@GlobalScope_constant_KEY_S:
- .. _class_@GlobalScope_constant_KEY_T:
- .. _class_@GlobalScope_constant_KEY_U:
- .. _class_@GlobalScope_constant_KEY_V:
- .. _class_@GlobalScope_constant_KEY_W:
- .. _class_@GlobalScope_constant_KEY_X:
- .. _class_@GlobalScope_constant_KEY_Y:
- .. _class_@GlobalScope_constant_KEY_Z:
- .. _class_@GlobalScope_constant_KEY_BRACKETLEFT:
- .. _class_@GlobalScope_constant_KEY_BACKSLASH:
- .. _class_@GlobalScope_constant_KEY_BRACKETRIGHT:
- .. _class_@GlobalScope_constant_KEY_ASCIICIRCUM:
- .. _class_@GlobalScope_constant_KEY_UNDERSCORE:
- .. _class_@GlobalScope_constant_KEY_QUOTELEFT:
- .. _class_@GlobalScope_constant_KEY_BRACELEFT:
- .. _class_@GlobalScope_constant_KEY_BAR:
- .. _class_@GlobalScope_constant_KEY_BRACERIGHT:
- .. _class_@GlobalScope_constant_KEY_ASCIITILDE:
- .. _class_@GlobalScope_constant_KEY_NOBREAKSPACE:
- .. _class_@GlobalScope_constant_KEY_EXCLAMDOWN:
- .. _class_@GlobalScope_constant_KEY_CENT:
- .. _class_@GlobalScope_constant_KEY_STERLING:
- .. _class_@GlobalScope_constant_KEY_CURRENCY:
- .. _class_@GlobalScope_constant_KEY_YEN:
- .. _class_@GlobalScope_constant_KEY_BROKENBAR:
- .. _class_@GlobalScope_constant_KEY_SECTION:
- .. _class_@GlobalScope_constant_KEY_DIAERESIS:
- .. _class_@GlobalScope_constant_KEY_COPYRIGHT:
- .. _class_@GlobalScope_constant_KEY_ORDFEMININE:
- .. _class_@GlobalScope_constant_KEY_GUILLEMOTLEFT:
- .. _class_@GlobalScope_constant_KEY_NOTSIGN:
- .. _class_@GlobalScope_constant_KEY_HYPHEN:
- .. _class_@GlobalScope_constant_KEY_REGISTERED:
- .. _class_@GlobalScope_constant_KEY_MACRON:
- .. _class_@GlobalScope_constant_KEY_DEGREE:
- .. _class_@GlobalScope_constant_KEY_PLUSMINUS:
- .. _class_@GlobalScope_constant_KEY_TWOSUPERIOR:
- .. _class_@GlobalScope_constant_KEY_THREESUPERIOR:
- .. _class_@GlobalScope_constant_KEY_ACUTE:
- .. _class_@GlobalScope_constant_KEY_MU:
- .. _class_@GlobalScope_constant_KEY_PARAGRAPH:
- .. _class_@GlobalScope_constant_KEY_PERIODCENTERED:
- .. _class_@GlobalScope_constant_KEY_CEDILLA:
- .. _class_@GlobalScope_constant_KEY_ONESUPERIOR:
- .. _class_@GlobalScope_constant_KEY_MASCULINE:
- .. _class_@GlobalScope_constant_KEY_GUILLEMOTRIGHT:
- .. _class_@GlobalScope_constant_KEY_ONEQUARTER:
- .. _class_@GlobalScope_constant_KEY_ONEHALF:
- .. _class_@GlobalScope_constant_KEY_THREEQUARTERS:
- .. _class_@GlobalScope_constant_KEY_QUESTIONDOWN:
- .. _class_@GlobalScope_constant_KEY_AGRAVE:
- .. _class_@GlobalScope_constant_KEY_AACUTE:
- .. _class_@GlobalScope_constant_KEY_ACIRCUMFLEX:
- .. _class_@GlobalScope_constant_KEY_ATILDE:
- .. _class_@GlobalScope_constant_KEY_ADIAERESIS:
- .. _class_@GlobalScope_constant_KEY_ARING:
- .. _class_@GlobalScope_constant_KEY_AE:
- .. _class_@GlobalScope_constant_KEY_CCEDILLA:
- .. _class_@GlobalScope_constant_KEY_EGRAVE:
- .. _class_@GlobalScope_constant_KEY_EACUTE:
- .. _class_@GlobalScope_constant_KEY_ECIRCUMFLEX:
- .. _class_@GlobalScope_constant_KEY_EDIAERESIS:
- .. _class_@GlobalScope_constant_KEY_IGRAVE:
- .. _class_@GlobalScope_constant_KEY_IACUTE:
- .. _class_@GlobalScope_constant_KEY_ICIRCUMFLEX:
- .. _class_@GlobalScope_constant_KEY_IDIAERESIS:
- .. _class_@GlobalScope_constant_KEY_ETH:
- .. _class_@GlobalScope_constant_KEY_NTILDE:
- .. _class_@GlobalScope_constant_KEY_OGRAVE:
- .. _class_@GlobalScope_constant_KEY_OACUTE:
- .. _class_@GlobalScope_constant_KEY_OCIRCUMFLEX:
- .. _class_@GlobalScope_constant_KEY_OTILDE:
- .. _class_@GlobalScope_constant_KEY_ODIAERESIS:
- .. _class_@GlobalScope_constant_KEY_MULTIPLY:
- .. _class_@GlobalScope_constant_KEY_OOBLIQUE:
- .. _class_@GlobalScope_constant_KEY_UGRAVE:
- .. _class_@GlobalScope_constant_KEY_UACUTE:
- .. _class_@GlobalScope_constant_KEY_UCIRCUMFLEX:
- .. _class_@GlobalScope_constant_KEY_UDIAERESIS:
- .. _class_@GlobalScope_constant_KEY_YACUTE:
- .. _class_@GlobalScope_constant_KEY_THORN:
- .. _class_@GlobalScope_constant_KEY_SSHARP:
- .. _class_@GlobalScope_constant_KEY_DIVISION:
- .. _class_@GlobalScope_constant_KEY_YDIAERESIS:
- enum **KeyList**:
- - **KEY_ESCAPE** = **16777217** --- Escape Key
- - **KEY_TAB** = **16777218** --- Tab Key
- - **KEY_BACKTAB** = **16777219** --- Shift-Tab Key
- - **KEY_BACKSPACE** = **16777220** --- Backspace Key
- - **KEY_ENTER** = **16777221** --- Return Key (On Main Keyboard)
- - **KEY_KP_ENTER** = **16777222** --- Enter Key (On Numpad)
- - **KEY_INSERT** = **16777223** --- Insert Key
- - **KEY_DELETE** = **16777224** --- Delete Key
- - **KEY_PAUSE** = **16777225** --- Pause Key
- - **KEY_PRINT** = **16777226** --- Printscreen Key
- - **KEY_SYSREQ** = **16777227** --- System Request Key
- - **KEY_CLEAR** = **16777228** --- Clear Key
- - **KEY_HOME** = **16777229** --- Home Key
- - **KEY_END** = **16777230** --- End Key
- - **KEY_LEFT** = **16777231** --- Left Arrow Key
- - **KEY_UP** = **16777232** --- Up Arrow Key
- - **KEY_RIGHT** = **16777233** --- Right Arrow Key
- - **KEY_DOWN** = **16777234** --- Down Arrow Key
- - **KEY_PAGEUP** = **16777235** --- Pageup Key
- - **KEY_PAGEDOWN** = **16777236** --- Pagedown Key
- - **KEY_SHIFT** = **16777237** --- Shift Key
- - **KEY_CONTROL** = **16777238** --- Control Key
- - **KEY_META** = **16777239** --- Meta Key
- - **KEY_ALT** = **16777240** --- Alt Key
- - **KEY_CAPSLOCK** = **16777241** --- Capslock Key
- - **KEY_NUMLOCK** = **16777242** --- Numlock Key
- - **KEY_SCROLLLOCK** = **16777243** --- Scrolllock Key
- - **KEY_F1** = **16777244** --- F1 Key
- - **KEY_F2** = **16777245** --- F2 Key
- - **KEY_F3** = **16777246** --- F3 Key
- - **KEY_F4** = **16777247** --- F4 Key
- - **KEY_F5** = **16777248** --- F5 Key
- - **KEY_F6** = **16777249** --- F6 Key
- - **KEY_F7** = **16777250** --- F7 Key
- - **KEY_F8** = **16777251** --- F8 Key
- - **KEY_F9** = **16777252** --- F9 Key
- - **KEY_F10** = **16777253** --- F10 Key
- - **KEY_F11** = **16777254** --- F11 Key
- - **KEY_F12** = **16777255** --- F12 Key
- - **KEY_F13** = **16777256** --- F13 Key
- - **KEY_F14** = **16777257** --- F14 Key
- - **KEY_F15** = **16777258** --- F15 Key
- - **KEY_F16** = **16777259** --- F16 Key
- - **KEY_KP_MULTIPLY** = **16777345** --- Multiply Key on Numpad
- - **KEY_KP_DIVIDE** = **16777346** --- Divide Key on Numpad
- - **KEY_KP_SUBTRACT** = **16777347** --- Subtract Key on Numpad
- - **KEY_KP_PERIOD** = **16777348** --- Period Key on Numpad
- - **KEY_KP_ADD** = **16777349** --- Add Key on Numpad
- - **KEY_KP_0** = **16777350** --- Number 0 on Numpad
- - **KEY_KP_1** = **16777351** --- Number 1 on Numpad
- - **KEY_KP_2** = **16777352** --- Number 2 on Numpad
- - **KEY_KP_3** = **16777353** --- Number 3 on Numpad
- - **KEY_KP_4** = **16777354** --- Number 4 on Numpad
- - **KEY_KP_5** = **16777355** --- Number 5 on Numpad
- - **KEY_KP_6** = **16777356** --- Number 6 on Numpad
- - **KEY_KP_7** = **16777357** --- Number 7 on Numpad
- - **KEY_KP_8** = **16777358** --- Number 8 on Numpad
- - **KEY_KP_9** = **16777359** --- Number 9 on Numpad
- - **KEY_SUPER_L** = **16777260** --- Left Super Key (Windows Key)
- - **KEY_SUPER_R** = **16777261** --- Right Super Key (Windows Key)
- - **KEY_MENU** = **16777262** --- Context menu key
- - **KEY_HYPER_L** = **16777263** --- Left Hyper Key
- - **KEY_HYPER_R** = **16777264** --- Right Hyper Key
- - **KEY_HELP** = **16777265** --- Help key
- - **KEY_DIRECTION_L** = **16777266** --- Left Direction Key
- - **KEY_DIRECTION_R** = **16777267** --- Right Direction Key
- - **KEY_BACK** = **16777280** --- Back key
- - **KEY_FORWARD** = **16777281** --- Forward key
- - **KEY_STOP** = **16777282** --- Stop key
- - **KEY_REFRESH** = **16777283** --- Refresh key
- - **KEY_VOLUMEDOWN** = **16777284** --- Volume down key
- - **KEY_VOLUMEMUTE** = **16777285** --- Mute volume key
- - **KEY_VOLUMEUP** = **16777286** --- Volume up key
- - **KEY_BASSBOOST** = **16777287** --- Bass Boost Key
- - **KEY_BASSUP** = **16777288** --- Bass Up Key
- - **KEY_BASSDOWN** = **16777289** --- Bass Down Key
- - **KEY_TREBLEUP** = **16777290** --- Treble Up Key
- - **KEY_TREBLEDOWN** = **16777291** --- Treble Down Key
- - **KEY_MEDIAPLAY** = **16777292** --- Media play key
- - **KEY_MEDIASTOP** = **16777293** --- Media stop key
- - **KEY_MEDIAPREVIOUS** = **16777294** --- Previous song key
- - **KEY_MEDIANEXT** = **16777295** --- Next song key
- - **KEY_MEDIARECORD** = **16777296** --- Media record key
- - **KEY_HOMEPAGE** = **16777297** --- Home page key
- - **KEY_FAVORITES** = **16777298** --- Favorites key
- - **KEY_SEARCH** = **16777299** --- Search key
- - **KEY_STANDBY** = **16777300** --- Standby Key
- - **KEY_OPENURL** = **16777301** --- Open URL / Launch Browser Key
- - **KEY_LAUNCHMAIL** = **16777302** --- Launch Mail Key
- - **KEY_LAUNCHMEDIA** = **16777303** --- Launch Media Key
- - **KEY_LAUNCH0** = **16777304** --- Launch Shortcut 0 Key
- - **KEY_LAUNCH1** = **16777305** --- Launch Shortcut 1 Key
- - **KEY_LAUNCH2** = **16777306** --- Launch Shortcut 2 Key
- - **KEY_LAUNCH3** = **16777307** --- Launch Shortcut 3 Key
- - **KEY_LAUNCH4** = **16777308** --- Launch Shortcut 4 Key
- - **KEY_LAUNCH5** = **16777309** --- Launch Shortcut 5 Key
- - **KEY_LAUNCH6** = **16777310** --- Launch Shortcut 6 Key
- - **KEY_LAUNCH7** = **16777311** --- Launch Shortcut 7 Key
- - **KEY_LAUNCH8** = **16777312** --- Launch Shortcut 8 Key
- - **KEY_LAUNCH9** = **16777313** --- Launch Shortcut 9 Key
- - **KEY_LAUNCHA** = **16777314** --- Launch Shortcut A Key
- - **KEY_LAUNCHB** = **16777315** --- Launch Shortcut B Key
- - **KEY_LAUNCHC** = **16777316** --- Launch Shortcut C Key
- - **KEY_LAUNCHD** = **16777317** --- Launch Shortcut D Key
- - **KEY_LAUNCHE** = **16777318** --- Launch Shortcut E Key
- - **KEY_LAUNCHF** = **16777319** --- Launch Shortcut F Key
- - **KEY_UNKNOWN** = **33554431** --- Unknown Key
- - **KEY_SPACE** = **32** --- Space Key
- - **KEY_EXCLAM** = **33** --- ! key
- - **KEY_QUOTEDBL** = **34** --- " key
- - **KEY_NUMBERSIGN** = **35** --- # key
- - **KEY_DOLLAR** = **36** --- $ key
- - **KEY_PERCENT** = **37** --- % key
- - **KEY_AMPERSAND** = **38** --- & key
- - **KEY_APOSTROPHE** = **39** --- ' key
- - **KEY_PARENLEFT** = **40** --- ( key
- - **KEY_PARENRIGHT** = **41** --- ) key
- - **KEY_ASTERISK** = **42** --- \* key
- - **KEY_PLUS** = **43** --- + key
- - **KEY_COMMA** = **44** --- , key
- - **KEY_MINUS** = **45** --- - key
- - **KEY_PERIOD** = **46** --- . key
- - **KEY_SLASH** = **47** --- / key
- - **KEY_0** = **48** --- Number 0
- - **KEY_1** = **49** --- Number 1
- - **KEY_2** = **50** --- Number 2
- - **KEY_3** = **51** --- Number 3
- - **KEY_4** = **52** --- Number 4
- - **KEY_5** = **53** --- Number 5
- - **KEY_6** = **54** --- Number 6
- - **KEY_7** = **55** --- Number 7
- - **KEY_8** = **56** --- Number 8
- - **KEY_9** = **57** --- Number 9
- - **KEY_COLON** = **58** --- : key
- - **KEY_SEMICOLON** = **59** --- ; key
- - **KEY_LESS** = **60** --- Lower than key
- - **KEY_EQUAL** = **61** --- = key
- - **KEY_GREATER** = **62** --- Greater than key
- - **KEY_QUESTION** = **63** --- ? key
- - **KEY_AT** = **64** --- @ key
- - **KEY_A** = **65** --- A Key
- - **KEY_B** = **66** --- B Key
- - **KEY_C** = **67** --- C Key
- - **KEY_D** = **68** --- D Key
- - **KEY_E** = **69** --- E Key
- - **KEY_F** = **70** --- F Key
- - **KEY_G** = **71** --- G Key
- - **KEY_H** = **72** --- H Key
- - **KEY_I** = **73** --- I Key
- - **KEY_J** = **74** --- J Key
- - **KEY_K** = **75** --- K Key
- - **KEY_L** = **76** --- L Key
- - **KEY_M** = **77** --- M Key
- - **KEY_N** = **78** --- N Key
- - **KEY_O** = **79** --- O Key
- - **KEY_P** = **80** --- P Key
- - **KEY_Q** = **81** --- Q Key
- - **KEY_R** = **82** --- R Key
- - **KEY_S** = **83** --- S Key
- - **KEY_T** = **84** --- T Key
- - **KEY_U** = **85** --- U Key
- - **KEY_V** = **86** --- V Key
- - **KEY_W** = **87** --- W Key
- - **KEY_X** = **88** --- X Key
- - **KEY_Y** = **89** --- Y Key
- - **KEY_Z** = **90** --- Z Key
- - **KEY_BRACKETLEFT** = **91** --- [ key
- - **KEY_BACKSLASH** = **92** --- \\ key
- - **KEY_BRACKETRIGHT** = **93** --- ] key
- - **KEY_ASCIICIRCUM** = **94** --- ^ key
- - **KEY_UNDERSCORE** = **95** --- \_ key
- - **KEY_QUOTELEFT** = **96** --- Left Quote Key
- - **KEY_BRACELEFT** = **123** --- { key
- - **KEY_BAR** = **124** --- | key
- - **KEY_BRACERIGHT** = **125** --- } key
- - **KEY_ASCIITILDE** = **126** --- ~ key
- - **KEY_NOBREAKSPACE** = **160**
- - **KEY_EXCLAMDOWN** = **161**
- - **KEY_CENT** = **162** --- ¢ key
- - **KEY_STERLING** = **163**
- - **KEY_CURRENCY** = **164**
- - **KEY_YEN** = **165** --- Yen Key
- - **KEY_BROKENBAR** = **166** --- ¦ key
- - **KEY_SECTION** = **167** --- § key
- - **KEY_DIAERESIS** = **168** --- ¨ key
- - **KEY_COPYRIGHT** = **169** --- © key
- - **KEY_ORDFEMININE** = **170**
- - **KEY_GUILLEMOTLEFT** = **171** --- « key
- - **KEY_NOTSIGN** = **172** --- » key
- - **KEY_HYPHEN** = **173** --- ‐ key
- - **KEY_REGISTERED** = **174** --- ® key
- - **KEY_MACRON** = **175** --- Macron Key
- - **KEY_DEGREE** = **176** --- ° key
- - **KEY_PLUSMINUS** = **177** --- ± key
- - **KEY_TWOSUPERIOR** = **178** --- ² key
- - **KEY_THREESUPERIOR** = **179** --- ³ key
- - **KEY_ACUTE** = **180** --- ´ key
- - **KEY_MU** = **181** --- µ key
- - **KEY_PARAGRAPH** = **182** --- Paragraph Key
- - **KEY_PERIODCENTERED** = **183** --- · key
- - **KEY_CEDILLA** = **184** --- ¬ key
- - **KEY_ONESUPERIOR** = **185** --- ¹ key
- - **KEY_MASCULINE** = **186** --- ♂ key
- - **KEY_GUILLEMOTRIGHT** = **187** --- » key
- - **KEY_ONEQUARTER** = **188** --- ¼ key
- - **KEY_ONEHALF** = **189** --- ½ key
- - **KEY_THREEQUARTERS** = **190** --- ¾ key
- - **KEY_QUESTIONDOWN** = **191** --- ¿ key
- - **KEY_AGRAVE** = **192** --- à key
- - **KEY_AACUTE** = **193** --- á key
- - **KEY_ACIRCUMFLEX** = **194** --- â key
- - **KEY_ATILDE** = **195** --- ã key
- - **KEY_ADIAERESIS** = **196** --- ä key
- - **KEY_ARING** = **197** --- å key
- - **KEY_AE** = **198** --- æ key
- - **KEY_CCEDILLA** = **199** --- ç key
- - **KEY_EGRAVE** = **200** --- è key
- - **KEY_EACUTE** = **201** --- é key
- - **KEY_ECIRCUMFLEX** = **202** --- ê key
- - **KEY_EDIAERESIS** = **203** --- ë key
- - **KEY_IGRAVE** = **204** --- ì key
- - **KEY_IACUTE** = **205** --- í key
- - **KEY_ICIRCUMFLEX** = **206** --- î key
- - **KEY_IDIAERESIS** = **207** --- ë key
- - **KEY_ETH** = **208** --- ð key
- - **KEY_NTILDE** = **209** --- ñ key
- - **KEY_OGRAVE** = **210** --- ò key
- - **KEY_OACUTE** = **211** --- ó key
- - **KEY_OCIRCUMFLEX** = **212** --- ô key
- - **KEY_OTILDE** = **213** --- õ key
- - **KEY_ODIAERESIS** = **214** --- ö key
- - **KEY_MULTIPLY** = **215** --- × key
- - **KEY_OOBLIQUE** = **216** --- ø key
- - **KEY_UGRAVE** = **217** --- ù key
- - **KEY_UACUTE** = **218** --- ú key
- - **KEY_UCIRCUMFLEX** = **219** --- û key
- - **KEY_UDIAERESIS** = **220** --- ü key
- - **KEY_YACUTE** = **221** --- ý key
- - **KEY_THORN** = **222** --- þ key
- - **KEY_SSHARP** = **223** --- ß key
- - **KEY_DIVISION** = **247** --- ÷ key
- - **KEY_YDIAERESIS** = **255** --- ÿ key
- .. _enum_@GlobalScope_KeyModifierMask:
- .. _class_@GlobalScope_constant_KEY_CODE_MASK:
- .. _class_@GlobalScope_constant_KEY_MODIFIER_MASK:
- .. _class_@GlobalScope_constant_KEY_MASK_SHIFT:
- .. _class_@GlobalScope_constant_KEY_MASK_ALT:
- .. _class_@GlobalScope_constant_KEY_MASK_META:
- .. _class_@GlobalScope_constant_KEY_MASK_CTRL:
- .. _class_@GlobalScope_constant_KEY_MASK_CMD:
- .. _class_@GlobalScope_constant_KEY_MASK_KPAD:
- .. _class_@GlobalScope_constant_KEY_MASK_GROUP_SWITCH:
- enum **KeyModifierMask**:
- - **KEY_CODE_MASK** = **33554431** --- Key Code Mask
- - **KEY_MODIFIER_MASK** = **-16777216** --- Modifier Key Mask
- - **KEY_MASK_SHIFT** = **33554432** --- Shift Key Mask
- - **KEY_MASK_ALT** = **67108864** --- Alt Key Mask
- - **KEY_MASK_META** = **134217728** --- Meta Key Mask
- - **KEY_MASK_CTRL** = **268435456** --- CTRL Key Mask
- - **KEY_MASK_CMD** = **268435456** --- CMD Key Mask
- - **KEY_MASK_KPAD** = **536870912** --- Keypad Key Mask
- - **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask
- .. _enum_@GlobalScope_ButtonList:
- .. _class_@GlobalScope_constant_BUTTON_LEFT:
- .. _class_@GlobalScope_constant_BUTTON_RIGHT:
- .. _class_@GlobalScope_constant_BUTTON_MIDDLE:
- .. _class_@GlobalScope_constant_BUTTON_XBUTTON1:
- .. _class_@GlobalScope_constant_BUTTON_XBUTTON2:
- .. _class_@GlobalScope_constant_BUTTON_WHEEL_UP:
- .. _class_@GlobalScope_constant_BUTTON_WHEEL_DOWN:
- .. _class_@GlobalScope_constant_BUTTON_WHEEL_LEFT:
- .. _class_@GlobalScope_constant_BUTTON_WHEEL_RIGHT:
- .. _class_@GlobalScope_constant_BUTTON_MASK_LEFT:
- .. _class_@GlobalScope_constant_BUTTON_MASK_RIGHT:
- .. _class_@GlobalScope_constant_BUTTON_MASK_MIDDLE:
- .. _class_@GlobalScope_constant_BUTTON_MASK_XBUTTON1:
- .. _class_@GlobalScope_constant_BUTTON_MASK_XBUTTON2:
- enum **ButtonList**:
- - **BUTTON_LEFT** = **1** --- Left Mouse Button
- - **BUTTON_RIGHT** = **2** --- Right Mouse Button
- - **BUTTON_MIDDLE** = **3** --- Middle Mouse Button
- - **BUTTON_XBUTTON1** = **8** --- Extra Mouse Button 1
- - **BUTTON_XBUTTON2** = **9** --- Extra Mouse Button 2
- - **BUTTON_WHEEL_UP** = **4** --- Mouse wheel up
- - **BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down
- - **BUTTON_WHEEL_LEFT** = **6** --- Mouse wheel left button
- - **BUTTON_WHEEL_RIGHT** = **7** --- Mouse wheel right button
- - **BUTTON_MASK_LEFT** = **1** --- Left Mouse Button Mask
- - **BUTTON_MASK_RIGHT** = **2** --- Right Mouse Button Mask
- - **BUTTON_MASK_MIDDLE** = **4** --- Middle Mouse Button Mask
- - **BUTTON_MASK_XBUTTON1** = **128** --- Extra Mouse Button 1 Mask
- - **BUTTON_MASK_XBUTTON2** = **256** --- Extra Mouse Button 2 Mask
- .. _enum_@GlobalScope_JoystickList:
- .. _class_@GlobalScope_constant_JOY_BUTTON_0:
- .. _class_@GlobalScope_constant_JOY_BUTTON_1:
- .. _class_@GlobalScope_constant_JOY_BUTTON_2:
- .. _class_@GlobalScope_constant_JOY_BUTTON_3:
- .. _class_@GlobalScope_constant_JOY_BUTTON_4:
- .. _class_@GlobalScope_constant_JOY_BUTTON_5:
- .. _class_@GlobalScope_constant_JOY_BUTTON_6:
- .. _class_@GlobalScope_constant_JOY_BUTTON_7:
- .. _class_@GlobalScope_constant_JOY_BUTTON_8:
- .. _class_@GlobalScope_constant_JOY_BUTTON_9:
- .. _class_@GlobalScope_constant_JOY_BUTTON_10:
- .. _class_@GlobalScope_constant_JOY_BUTTON_11:
- .. _class_@GlobalScope_constant_JOY_BUTTON_12:
- .. _class_@GlobalScope_constant_JOY_BUTTON_13:
- .. _class_@GlobalScope_constant_JOY_BUTTON_14:
- .. _class_@GlobalScope_constant_JOY_BUTTON_15:
- .. _class_@GlobalScope_constant_JOY_BUTTON_MAX:
- .. _class_@GlobalScope_constant_JOY_SONY_CIRCLE:
- .. _class_@GlobalScope_constant_JOY_SONY_X:
- .. _class_@GlobalScope_constant_JOY_SONY_SQUARE:
- .. _class_@GlobalScope_constant_JOY_SONY_TRIANGLE:
- .. _class_@GlobalScope_constant_JOY_XBOX_B:
- .. _class_@GlobalScope_constant_JOY_XBOX_A:
- .. _class_@GlobalScope_constant_JOY_XBOX_X:
- .. _class_@GlobalScope_constant_JOY_XBOX_Y:
- .. _class_@GlobalScope_constant_JOY_DS_A:
- .. _class_@GlobalScope_constant_JOY_DS_B:
- .. _class_@GlobalScope_constant_JOY_DS_X:
- .. _class_@GlobalScope_constant_JOY_DS_Y:
- .. _class_@GlobalScope_constant_JOY_SELECT:
- .. _class_@GlobalScope_constant_JOY_START:
- .. _class_@GlobalScope_constant_JOY_DPAD_UP:
- .. _class_@GlobalScope_constant_JOY_DPAD_DOWN:
- .. _class_@GlobalScope_constant_JOY_DPAD_LEFT:
- .. _class_@GlobalScope_constant_JOY_DPAD_RIGHT:
- .. _class_@GlobalScope_constant_JOY_L:
- .. _class_@GlobalScope_constant_JOY_L2:
- .. _class_@GlobalScope_constant_JOY_L3:
- .. _class_@GlobalScope_constant_JOY_R:
- .. _class_@GlobalScope_constant_JOY_R2:
- .. _class_@GlobalScope_constant_JOY_R3:
- .. _class_@GlobalScope_constant_JOY_AXIS_0:
- .. _class_@GlobalScope_constant_JOY_AXIS_1:
- .. _class_@GlobalScope_constant_JOY_AXIS_2:
- .. _class_@GlobalScope_constant_JOY_AXIS_3:
- .. _class_@GlobalScope_constant_JOY_AXIS_4:
- .. _class_@GlobalScope_constant_JOY_AXIS_5:
- .. _class_@GlobalScope_constant_JOY_AXIS_6:
- .. _class_@GlobalScope_constant_JOY_AXIS_7:
- .. _class_@GlobalScope_constant_JOY_AXIS_8:
- .. _class_@GlobalScope_constant_JOY_AXIS_9:
- .. _class_@GlobalScope_constant_JOY_AXIS_MAX:
- .. _class_@GlobalScope_constant_JOY_ANALOG_LX:
- .. _class_@GlobalScope_constant_JOY_ANALOG_LY:
- .. _class_@GlobalScope_constant_JOY_ANALOG_RX:
- .. _class_@GlobalScope_constant_JOY_ANALOG_RY:
- .. _class_@GlobalScope_constant_JOY_ANALOG_L2:
- .. _class_@GlobalScope_constant_JOY_ANALOG_R2:
- enum **JoystickList**:
- - **JOY_BUTTON_0** = **0** --- Joypad Button 0
- - **JOY_BUTTON_1** = **1** --- Joypad Button 1
- - **JOY_BUTTON_2** = **2** --- Joypad Button 2
- - **JOY_BUTTON_3** = **3** --- Joypad Button 3
- - **JOY_BUTTON_4** = **4** --- Joypad Button 4
- - **JOY_BUTTON_5** = **5** --- Joypad Button 5
- - **JOY_BUTTON_6** = **6** --- Joypad Button 6
- - **JOY_BUTTON_7** = **7** --- Joypad Button 7
- - **JOY_BUTTON_8** = **8** --- Joypad Button 8
- - **JOY_BUTTON_9** = **9** --- Joypad Button 9
- - **JOY_BUTTON_10** = **10** --- Joypad Button 10
- - **JOY_BUTTON_11** = **11** --- Joypad Button 11
- - **JOY_BUTTON_12** = **12** --- Joypad Button 12
- - **JOY_BUTTON_13** = **13** --- Joypad Button 13
- - **JOY_BUTTON_14** = **14** --- Joypad Button 14
- - **JOY_BUTTON_15** = **15** --- Joypad Button 15
- - **JOY_BUTTON_MAX** = **16** --- Joypad Button 16
- - **JOY_SONY_CIRCLE** = **1** --- DUALSHOCK circle button
- - **JOY_SONY_X** = **0** --- DUALSHOCK X button
- - **JOY_SONY_SQUARE** = **2** --- DUALSHOCK square button
- - **JOY_SONY_TRIANGLE** = **3** --- DUALSHOCK triangle button
- - **JOY_XBOX_B** = **1** --- XBOX controller B button
- - **JOY_XBOX_A** = **0** --- XBOX controller A button
- - **JOY_XBOX_X** = **2** --- XBOX controller X button
- - **JOY_XBOX_Y** = **3** --- XBOX controller Y button
- - **JOY_DS_A** = **1** --- DualShock controller A button
- - **JOY_DS_B** = **0** --- DualShock controller B button
- - **JOY_DS_X** = **3** --- DualShock controller X button
- - **JOY_DS_Y** = **2** --- DualShock controller Y button
- - **JOY_SELECT** = **10** --- Joypad Button Select
- - **JOY_START** = **11** --- Joypad Button Start
- - **JOY_DPAD_UP** = **12** --- Joypad DPad Up
- - **JOY_DPAD_DOWN** = **13** --- Joypad DPad Down
- - **JOY_DPAD_LEFT** = **14** --- Joypad DPad Left
- - **JOY_DPAD_RIGHT** = **15** --- Joypad DPad Right
- - **JOY_L** = **4** --- Joypad Left Shoulder Button
- - **JOY_L2** = **6** --- Joypad Left Trigger
- - **JOY_L3** = **8** --- Joypad Left Stick Click
- - **JOY_R** = **5** --- Joypad Right Shoulder Button
- - **JOY_R2** = **7** --- Joypad Right Trigger
- - **JOY_R3** = **9** --- Joypad Right Stick Click
- - **JOY_AXIS_0** = **0** --- Joypad Left Stick Horizontal Axis
- - **JOY_AXIS_1** = **1** --- Joypad Left Stick Vertical Axis
- - **JOY_AXIS_2** = **2** --- Joypad Right Stick Horizontal Axis
- - **JOY_AXIS_3** = **3** --- Joypad Right Stick Vertical Axis
- - **JOY_AXIS_4** = **4**
- - **JOY_AXIS_5** = **5**
- - **JOY_AXIS_6** = **6** --- Joypad Left Trigger Analog Axis
- - **JOY_AXIS_7** = **7** --- Joypad Right Trigger Analog Axis
- - **JOY_AXIS_8** = **8**
- - **JOY_AXIS_9** = **9**
- - **JOY_AXIS_MAX** = **10**
- - **JOY_ANALOG_LX** = **0** --- Joypad Left Stick Horizontal Axis
- - **JOY_ANALOG_LY** = **1** --- Joypad Left Stick Vertical Axis
- - **JOY_ANALOG_RX** = **2** --- Joypad Right Stick Horizontal Axis
- - **JOY_ANALOG_RY** = **3** --- Joypad Right Stick Vertical Axis
- - **JOY_ANALOG_L2** = **6** --- Joypad Left Analog Trigger
- - **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger
- .. _enum_@GlobalScope_MidiMessageList:
- .. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF:
- .. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON:
- .. _class_@GlobalScope_constant_MIDI_MESSAGE_AFTERTOUCH:
- .. _class_@GlobalScope_constant_MIDI_MESSAGE_CONTROL_CHANGE:
- .. _class_@GlobalScope_constant_MIDI_MESSAGE_PROGRAM_CHANGE:
- .. _class_@GlobalScope_constant_MIDI_MESSAGE_CHANNEL_PRESSURE:
- .. _class_@GlobalScope_constant_MIDI_MESSAGE_PITCH_BEND:
- enum **MidiMessageList**:
- - **MIDI_MESSAGE_NOTE_OFF** = **8**
- - **MIDI_MESSAGE_NOTE_ON** = **9**
- - **MIDI_MESSAGE_AFTERTOUCH** = **10**
- - **MIDI_MESSAGE_CONTROL_CHANGE** = **11**
- - **MIDI_MESSAGE_PROGRAM_CHANGE** = **12**
- - **MIDI_MESSAGE_CHANNEL_PRESSURE** = **13**
- - **MIDI_MESSAGE_PITCH_BEND** = **14**
- .. _enum_@GlobalScope_Error:
- .. _class_@GlobalScope_constant_OK:
- .. _class_@GlobalScope_constant_FAILED:
- .. _class_@GlobalScope_constant_ERR_UNAVAILABLE:
- .. _class_@GlobalScope_constant_ERR_UNCONFIGURED:
- .. _class_@GlobalScope_constant_ERR_UNAUTHORIZED:
- .. _class_@GlobalScope_constant_ERR_PARAMETER_RANGE_ERROR:
- .. _class_@GlobalScope_constant_ERR_OUT_OF_MEMORY:
- .. _class_@GlobalScope_constant_ERR_FILE_NOT_FOUND:
- .. _class_@GlobalScope_constant_ERR_FILE_BAD_DRIVE:
- .. _class_@GlobalScope_constant_ERR_FILE_BAD_PATH:
- .. _class_@GlobalScope_constant_ERR_FILE_NO_PERMISSION:
- .. _class_@GlobalScope_constant_ERR_FILE_ALREADY_IN_USE:
- .. _class_@GlobalScope_constant_ERR_FILE_CANT_OPEN:
- .. _class_@GlobalScope_constant_ERR_FILE_CANT_WRITE:
- .. _class_@GlobalScope_constant_ERR_FILE_CANT_READ:
- .. _class_@GlobalScope_constant_ERR_FILE_UNRECOGNIZED:
- .. _class_@GlobalScope_constant_ERR_FILE_CORRUPT:
- .. _class_@GlobalScope_constant_ERR_FILE_MISSING_DEPENDENCIES:
- .. _class_@GlobalScope_constant_ERR_FILE_EOF:
- .. _class_@GlobalScope_constant_ERR_CANT_OPEN:
- .. _class_@GlobalScope_constant_ERR_CANT_CREATE:
- .. _class_@GlobalScope_constant_ERR_PARSE_ERROR:
- .. _class_@GlobalScope_constant_ERR_QUERY_FAILED:
- .. _class_@GlobalScope_constant_ERR_ALREADY_IN_USE:
- .. _class_@GlobalScope_constant_ERR_LOCKED:
- .. _class_@GlobalScope_constant_ERR_TIMEOUT:
- .. _class_@GlobalScope_constant_ERR_CANT_ACQUIRE_RESOURCE:
- .. _class_@GlobalScope_constant_ERR_INVALID_DATA:
- .. _class_@GlobalScope_constant_ERR_INVALID_PARAMETER:
- .. _class_@GlobalScope_constant_ERR_ALREADY_EXISTS:
- .. _class_@GlobalScope_constant_ERR_DOES_NOT_EXIST:
- .. _class_@GlobalScope_constant_ERR_DATABASE_CANT_READ:
- .. _class_@GlobalScope_constant_ERR_DATABASE_CANT_WRITE:
- .. _class_@GlobalScope_constant_ERR_COMPILATION_FAILED:
- .. _class_@GlobalScope_constant_ERR_METHOD_NOT_FOUND:
- .. _class_@GlobalScope_constant_ERR_LINK_FAILED:
- .. _class_@GlobalScope_constant_ERR_SCRIPT_FAILED:
- .. _class_@GlobalScope_constant_ERR_CYCLIC_LINK:
- .. _class_@GlobalScope_constant_ERR_BUSY:
- .. _class_@GlobalScope_constant_ERR_HELP:
- .. _class_@GlobalScope_constant_ERR_BUG:
- enum **Error**:
- - **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.
- - **FAILED** = **1** --- Generic error.
- - **ERR_UNAVAILABLE** = **2** --- Unavailable error
- - **ERR_UNCONFIGURED** = **3** --- Unconfigured error
- - **ERR_UNAUTHORIZED** = **4** --- Unauthorized error
- - **ERR_PARAMETER_RANGE_ERROR** = **5** --- Parameter range error
- - **ERR_OUT_OF_MEMORY** = **6** --- Out of memory (OOM) error
- - **ERR_FILE_NOT_FOUND** = **7** --- File: Not found error
- - **ERR_FILE_BAD_DRIVE** = **8** --- File: Bad drive error
- - **ERR_FILE_BAD_PATH** = **9** --- File: Bad path error
- - **ERR_FILE_NO_PERMISSION** = **10** --- File: No permission error
- - **ERR_FILE_ALREADY_IN_USE** = **11** --- File: Already in use error
- - **ERR_FILE_CANT_OPEN** = **12** --- File: Can't open error
- - **ERR_FILE_CANT_WRITE** = **13** --- File: Can't write error
- - **ERR_FILE_CANT_READ** = **14** --- File: Can't read error
- - **ERR_FILE_UNRECOGNIZED** = **15** --- File: Unrecognized error
- - **ERR_FILE_CORRUPT** = **16** --- File: Corrupt error
- - **ERR_FILE_MISSING_DEPENDENCIES** = **17** --- File: Missing dependencies error
- - **ERR_FILE_EOF** = **18** --- File: End of file (EOF) error
- - **ERR_CANT_OPEN** = **19** --- Can't open error
- - **ERR_CANT_CREATE** = **20** --- Can't create error
- - **ERR_PARSE_ERROR** = **43** --- Parse error
- - **ERR_QUERY_FAILED** = **21** --- Query failed error
- - **ERR_ALREADY_IN_USE** = **22** --- Already in use error
- - **ERR_LOCKED** = **23** --- Locked error
- - **ERR_TIMEOUT** = **24** --- Timeout error
- - **ERR_CANT_ACQUIRE_RESOURCE** = **28** --- Can't acquire resource error
- - **ERR_INVALID_DATA** = **30** --- Invalid data error
- - **ERR_INVALID_PARAMETER** = **31** --- Invalid parameter error
- - **ERR_ALREADY_EXISTS** = **32** --- Already exists error
- - **ERR_DOES_NOT_EXIST** = **33** --- Does not exist error
- - **ERR_DATABASE_CANT_READ** = **34** --- Database: Read error
- - **ERR_DATABASE_CANT_WRITE** = **35** --- Database: Write error
- - **ERR_COMPILATION_FAILED** = **36** --- Compilation failed error
- - **ERR_METHOD_NOT_FOUND** = **37** --- Method not found error
- - **ERR_LINK_FAILED** = **38** --- Linking failed error
- - **ERR_SCRIPT_FAILED** = **39** --- Script failed error
- - **ERR_CYCLIC_LINK** = **40** --- Cycling link (import cycle) error
- - **ERR_BUSY** = **44** --- Busy error
- - **ERR_HELP** = **46** --- Help error
- - **ERR_BUG** = **47** --- Bug error
- .. _enum_@GlobalScope_PropertyHint:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_NONE:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_RANGE:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_EXP_RANGE:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_ENUM:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_EXP_EASING:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_LENGTH:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_KEY_ACCEL:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_FLAGS:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_RENDER:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_PHYSICS:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_RENDER:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_PHYSICS:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_FILE:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_DIR:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_GLOBAL_FILE:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_GLOBAL_DIR:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_RESOURCE_TYPE:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_MULTILINE_TEXT:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_PLACEHOLDER_TEXT:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_COLOR_NO_ALPHA:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_IMAGE_COMPRESS_LOSSY:
- .. _class_@GlobalScope_constant_PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS:
- enum **PropertyHint**:
- - **PROPERTY_HINT_NONE** = **0** --- No hint for edited property.
- - **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.
- - **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.
- - **PROPERTY_HINT_ENUM** = **3** --- Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
- - **PROPERTY_HINT_EXP_EASING** = **4**
- - **PROPERTY_HINT_LENGTH** = **5**
- - **PROPERTY_HINT_KEY_ACCEL** = **7**
- - **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.
- - **PROPERTY_HINT_LAYERS_2D_RENDER** = **9**
- - **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10**
- - **PROPERTY_HINT_LAYERS_3D_RENDER** = **11**
- - **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12**
- - **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".
- - **PROPERTY_HINT_DIR** = **14** --- String property is a directory (so pop up a file dialog when edited).
- - **PROPERTY_HINT_GLOBAL_FILE** = **15**
- - **PROPERTY_HINT_GLOBAL_DIR** = **16**
- - **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- String property is a resource, so open the resource popup menu when edited.
- - **PROPERTY_HINT_MULTILINE_TEXT** = **18**
- - **PROPERTY_HINT_PLACEHOLDER_TEXT** = **19**
- - **PROPERTY_HINT_COLOR_NO_ALPHA** = **20**
- - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that the image is compressed using lossy compression.
- - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that the image is compressed using lossless compression.
- .. _enum_@GlobalScope_PropertyUsageFlags:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_STORAGE:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_NETWORK:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR_HELPER:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_CHECKABLE:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_CHECKED:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_INTERNATIONALIZED:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_GROUP:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_CATEGORY:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_NO_INSTANCE_STATE:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_RESTART_IF_CHANGED:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_SCRIPT_VARIABLE:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_DEFAULT:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_DEFAULT_INTL:
- .. _class_@GlobalScope_constant_PROPERTY_USAGE_NOEDITOR:
- enum **PropertyUsageFlags**:
- - **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default).
- - **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default).
- - **PROPERTY_USAGE_NETWORK** = **4**
- - **PROPERTY_USAGE_EDITOR_HELPER** = **8**
- - **PROPERTY_USAGE_CHECKABLE** = **16**
- - **PROPERTY_USAGE_CHECKED** = **32**
- - **PROPERTY_USAGE_INTERNATIONALIZED** = **64**
- - **PROPERTY_USAGE_GROUP** = **128**
- - **PROPERTY_USAGE_CATEGORY** = **256**
- - **PROPERTY_USAGE_NO_INSTANCE_STATE** = **2048**
- - **PROPERTY_USAGE_RESTART_IF_CHANGED** = **4096**
- - **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192**
- - **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor).
- - **PROPERTY_USAGE_DEFAULT_INTL** = **71**
- - **PROPERTY_USAGE_NOEDITOR** = **5**
- .. _enum_@GlobalScope_MethodFlags:
- .. _class_@GlobalScope_constant_METHOD_FLAG_NORMAL:
- .. _class_@GlobalScope_constant_METHOD_FLAG_EDITOR:
- .. _class_@GlobalScope_constant_METHOD_FLAG_NOSCRIPT:
- .. _class_@GlobalScope_constant_METHOD_FLAG_CONST:
- .. _class_@GlobalScope_constant_METHOD_FLAG_REVERSE:
- .. _class_@GlobalScope_constant_METHOD_FLAG_VIRTUAL:
- .. _class_@GlobalScope_constant_METHOD_FLAG_FROM_SCRIPT:
- .. _class_@GlobalScope_constant_METHOD_FLAGS_DEFAULT:
- enum **MethodFlags**:
- - **METHOD_FLAG_NORMAL** = **1** --- Flag for normal method
- - **METHOD_FLAG_EDITOR** = **2** --- Flag for editor method
- - **METHOD_FLAG_NOSCRIPT** = **4**
- - **METHOD_FLAG_CONST** = **8** --- Flag for constant method
- - **METHOD_FLAG_REVERSE** = **16**
- - **METHOD_FLAG_VIRTUAL** = **32** --- Flag for virtual method
- - **METHOD_FLAG_FROM_SCRIPT** = **64** --- Flag for method from script
- - **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags
- .. _enum_@GlobalScope_Variant.Type:
- .. _class_@GlobalScope_constant_TYPE_NIL:
- .. _class_@GlobalScope_constant_TYPE_BOOL:
- .. _class_@GlobalScope_constant_TYPE_INT:
- .. _class_@GlobalScope_constant_TYPE_REAL:
- .. _class_@GlobalScope_constant_TYPE_STRING:
- .. _class_@GlobalScope_constant_TYPE_VECTOR2:
- .. _class_@GlobalScope_constant_TYPE_RECT2:
- .. _class_@GlobalScope_constant_TYPE_VECTOR3:
- .. _class_@GlobalScope_constant_TYPE_TRANSFORM2D:
- .. _class_@GlobalScope_constant_TYPE_PLANE:
- .. _class_@GlobalScope_constant_TYPE_QUAT:
- .. _class_@GlobalScope_constant_TYPE_AABB:
- .. _class_@GlobalScope_constant_TYPE_BASIS:
- .. _class_@GlobalScope_constant_TYPE_TRANSFORM:
- .. _class_@GlobalScope_constant_TYPE_COLOR:
- .. _class_@GlobalScope_constant_TYPE_NODE_PATH:
- .. _class_@GlobalScope_constant_TYPE_RID:
- .. _class_@GlobalScope_constant_TYPE_OBJECT:
- .. _class_@GlobalScope_constant_TYPE_DICTIONARY:
- .. _class_@GlobalScope_constant_TYPE_ARRAY:
- .. _class_@GlobalScope_constant_TYPE_RAW_ARRAY:
- .. _class_@GlobalScope_constant_TYPE_INT_ARRAY:
- .. _class_@GlobalScope_constant_TYPE_REAL_ARRAY:
- .. _class_@GlobalScope_constant_TYPE_STRING_ARRAY:
- .. _class_@GlobalScope_constant_TYPE_VECTOR2_ARRAY:
- .. _class_@GlobalScope_constant_TYPE_VECTOR3_ARRAY:
- .. _class_@GlobalScope_constant_TYPE_COLOR_ARRAY:
- .. _class_@GlobalScope_constant_TYPE_MAX:
- enum **Variant.Type**:
- - **TYPE_NIL** = **0** --- Variable is of type nil (only applied for null).
- - **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool<class_bool>`.
- - **TYPE_INT** = **2** --- Variable is of type :ref:`int<class_int>`.
- - **TYPE_REAL** = **3** --- Variable is of type :ref:`float<class_float>`/real.
- - **TYPE_STRING** = **4** --- Variable is of type :ref:`String<class_String>`.
- - **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2<class_Vector2>`.
- - **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2<class_Rect2>`.
- - **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3<class_Vector3>`.
- - **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D<class_Transform2D>`.
- - **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane<class_Plane>`.
- - **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat<class_Quat>`.
- - **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB<class_AABB>`.
- - **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis<class_Basis>`.
- - **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform<class_Transform>`.
- - **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color<class_Color>`.
- - **TYPE_NODE_PATH** = **15** --- Variable is of type :ref:`NodePath<class_NodePath>`.
- - **TYPE_RID** = **16** --- Variable is of type :ref:`RID<class_RID>`.
- - **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object<class_Object>`.
- - **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary<class_Dictionary>`.
- - **TYPE_ARRAY** = **19** --- Variable is of type :ref:`Array<class_Array>`.
- - **TYPE_RAW_ARRAY** = **20** --- Variable is of type :ref:`PoolByteArray<class_PoolByteArray>`.
- - **TYPE_INT_ARRAY** = **21** --- Variable is of type :ref:`PoolIntArray<class_PoolIntArray>`.
- - **TYPE_REAL_ARRAY** = **22** --- Variable is of type :ref:`PoolRealArray<class_PoolRealArray>`.
- - **TYPE_STRING_ARRAY** = **23** --- Variable is of type :ref:`PoolStringArray<class_PoolStringArray>`.
- - **TYPE_VECTOR2_ARRAY** = **24** --- Variable is of type :ref:`PoolVector2Array<class_PoolVector2Array>`.
- - **TYPE_VECTOR3_ARRAY** = **25** --- Variable is of type :ref:`PoolVector3Array<class_PoolVector3Array>`.
- - **TYPE_COLOR_ARRAY** = **26** --- Variable is of type :ref:`PoolColorArray<class_PoolColorArray>`.
- - **TYPE_MAX** = **27** --- Marker for end of type constants.
- .. _enum_@GlobalScope_Variant.Operator:
- .. _class_@GlobalScope_constant_OP_EQUAL:
- .. _class_@GlobalScope_constant_OP_NOT_EQUAL:
- .. _class_@GlobalScope_constant_OP_LESS:
- .. _class_@GlobalScope_constant_OP_LESS_EQUAL:
- .. _class_@GlobalScope_constant_OP_GREATER:
- .. _class_@GlobalScope_constant_OP_GREATER_EQUAL:
- .. _class_@GlobalScope_constant_OP_ADD:
- .. _class_@GlobalScope_constant_OP_SUBTRACT:
- .. _class_@GlobalScope_constant_OP_MULTIPLY:
- .. _class_@GlobalScope_constant_OP_DIVIDE:
- .. _class_@GlobalScope_constant_OP_NEGATE:
- .. _class_@GlobalScope_constant_OP_POSITIVE:
- .. _class_@GlobalScope_constant_OP_MODULE:
- .. _class_@GlobalScope_constant_OP_STRING_CONCAT:
- .. _class_@GlobalScope_constant_OP_SHIFT_LEFT:
- .. _class_@GlobalScope_constant_OP_SHIFT_RIGHT:
- .. _class_@GlobalScope_constant_OP_BIT_AND:
- .. _class_@GlobalScope_constant_OP_BIT_OR:
- .. _class_@GlobalScope_constant_OP_BIT_XOR:
- .. _class_@GlobalScope_constant_OP_BIT_NEGATE:
- .. _class_@GlobalScope_constant_OP_AND:
- .. _class_@GlobalScope_constant_OP_OR:
- .. _class_@GlobalScope_constant_OP_XOR:
- .. _class_@GlobalScope_constant_OP_NOT:
- .. _class_@GlobalScope_constant_OP_IN:
- .. _class_@GlobalScope_constant_OP_MAX:
- enum **Variant.Operator**:
- - **OP_EQUAL** = **0**
- - **OP_NOT_EQUAL** = **1**
- - **OP_LESS** = **2**
- - **OP_LESS_EQUAL** = **3**
- - **OP_GREATER** = **4**
- - **OP_GREATER_EQUAL** = **5**
- - **OP_ADD** = **6**
- - **OP_SUBTRACT** = **7**
- - **OP_MULTIPLY** = **8**
- - **OP_DIVIDE** = **9**
- - **OP_NEGATE** = **10**
- - **OP_POSITIVE** = **11**
- - **OP_MODULE** = **12**
- - **OP_STRING_CONCAT** = **13**
- - **OP_SHIFT_LEFT** = **14**
- - **OP_SHIFT_RIGHT** = **15**
- - **OP_BIT_AND** = **16**
- - **OP_BIT_OR** = **17**
- - **OP_BIT_XOR** = **18**
- - **OP_BIT_NEGATE** = **19**
- - **OP_AND** = **20**
- - **OP_OR** = **21**
- - **OP_XOR** = **22**
- - **OP_NOT** = **23**
- - **OP_IN** = **24**
- - **OP_MAX** = **25**
- Constants
- ---------
- .. _class_@GlobalScope_constant_SPKEY:
- - **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable.
- Description
- -----------
- 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.
- Singletons are also documented here, since they can be accessed from anywhere.
- Property Descriptions
- ---------------------
- .. _class_@GlobalScope_property_ARVRServer:
- - :ref:`ARVRServer<class_ARVRServer>` **ARVRServer**
- :ref:`ARVRServer<class_ARVRServer>` singleton
- .. _class_@GlobalScope_property_AudioServer:
- - :ref:`AudioServer<class_AudioServer>` **AudioServer**
- :ref:`AudioServer<class_AudioServer>` singleton
- .. _class_@GlobalScope_property_ClassDB:
- - :ref:`ClassDB<class_ClassDB>` **ClassDB**
- :ref:`ClassDB<class_ClassDB>` singleton
- .. _class_@GlobalScope_property_Engine:
- - :ref:`Engine<class_Engine>` **Engine**
- :ref:`Engine<class_Engine>` singleton
- .. _class_@GlobalScope_property_Geometry:
- - :ref:`Geometry<class_Geometry>` **Geometry**
- :ref:`Geometry<class_Geometry>` singleton
- .. _class_@GlobalScope_property_IP:
- - :ref:`IP<class_IP>` **IP**
- :ref:`IP<class_IP>` singleton
- .. _class_@GlobalScope_property_Input:
- - :ref:`Input<class_Input>` **Input**
- :ref:`Input<class_Input>` singleton
- .. _class_@GlobalScope_property_InputMap:
- - :ref:`InputMap<class_InputMap>` **InputMap**
- :ref:`InputMap<class_InputMap>` singleton
- .. _class_@GlobalScope_property_JSON:
- - :ref:`JSON<class_JSON>` **JSON**
- :ref:`JSON<class_JSON>` singleton
- .. _class_@GlobalScope_property_JavaScript:
- - :ref:`JavaScript<class_JavaScript>` **JavaScript**
- :ref:`JavaScript<class_JavaScript>` singleton
- .. _class_@GlobalScope_property_Marshalls:
- - :ref:`Reference<class_Reference>` **Marshalls**
- :ref:`Marshalls<class_Marshalls>` singleton
- .. _class_@GlobalScope_property_NavigationMeshGenerator:
- - :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>` **NavigationMeshGenerator**
- .. _class_@GlobalScope_property_OS:
- - :ref:`OS<class_OS>` **OS**
- :ref:`OS<class_OS>` singleton
- .. _class_@GlobalScope_property_Performance:
- - :ref:`Performance<class_Performance>` **Performance**
- :ref:`Performance<class_Performance>` singleton
- .. _class_@GlobalScope_property_Physics2DServer:
- - :ref:`Physics2DServer<class_Physics2DServer>` **Physics2DServer**
- :ref:`Physics2DServer<class_Physics2DServer>` singleton
- .. _class_@GlobalScope_property_PhysicsServer:
- - :ref:`PhysicsServer<class_PhysicsServer>` **PhysicsServer**
- :ref:`PhysicsServer<class_PhysicsServer>` singleton
- .. _class_@GlobalScope_property_ProjectSettings:
- - :ref:`ProjectSettings<class_ProjectSettings>` **ProjectSettings**
- :ref:`ProjectSettings<class_ProjectSettings>` singleton
- .. _class_@GlobalScope_property_ResourceLoader:
- - :ref:`ResourceLoader<class_ResourceLoader>` **ResourceLoader**
- :ref:`ResourceLoader<class_ResourceLoader>` singleton
- .. _class_@GlobalScope_property_ResourceSaver:
- - :ref:`ResourceSaver<class_ResourceSaver>` **ResourceSaver**
- :ref:`ResourceSaver<class_ResourceSaver>` singleton
- .. _class_@GlobalScope_property_TranslationServer:
- - :ref:`TranslationServer<class_TranslationServer>` **TranslationServer**
- :ref:`TranslationServer<class_TranslationServer>` singleton
- .. _class_@GlobalScope_property_VisualScriptEditor:
- - :ref:`VisualScriptEditor<class_VisualScriptEditor>` **VisualScriptEditor**
- :ref:`VisualScriptEditor<class_VisualScriptEditor>` singleton
- .. _class_@GlobalScope_property_VisualServer:
- - :ref:`VisualServer<class_VisualServer>` **VisualServer**
- :ref:`VisualServer<class_VisualServer>` singleton
|