Relintai/pandemonium_engine_docs
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine_docs.git synced 2025-01-21 15:07:22 +01:00
Code Issues Packages Projects Releases Wiki Activity
43da063dd2
pandemonium_engine_docs/classes/class_@globalscope.rst

2475 lines
72 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. Generated automatically by doc/tools/make_rst.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
============
Global scope constants and variables.
Description
-----------
Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, scancodes, property hints, etc.
Singletons are also documented here, since they can be accessed from anywhere.
Properties
----------
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`ARVRServer<class_ARVRServer>` | :ref:`ARVRServer<class_@GlobalScope_property_ARVRServer>` |
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`AudioServer<class_AudioServer>` | :ref:`AudioServer<class_@GlobalScope_property_AudioServer>` |
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`CameraServer<class_CameraServer>` | :ref:`CameraServer<class_@GlobalScope_property_CameraServer>` |
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :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:`JavaClassWrapper<class_JavaClassWrapper>` | :ref:`JavaClassWrapper<class_@GlobalScope_property_JavaClassWrapper>` |
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`JavaScript<class_JavaScript>` | :ref:`JavaScript<class_@GlobalScope_property_JavaScript>` |
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Marshalls<class_Marshalls>` | :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, usually used for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>`-derived classes.
- **MARGIN_TOP** = **1** --- Top margin, usually used for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>`-derived classes.
- **MARGIN_RIGHT** = **2** --- Right margin, usually used for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>`-derived classes.
- **MARGIN_BOTTOM** = **3** --- Bottom margin, usually used 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** --- Top-left corner.
- **CORNER_TOP_RIGHT** = **1** --- Top-right corner.
- **CORNER_BOTTOM_RIGHT** = **2** --- Bottom-right corner.
- **CORNER_BOTTOM_LEFT** = **3** --- Bottom-left corner.
----
.. _enum_@GlobalScope_Orientation:
.. _class_@GlobalScope_constant_VERTICAL:
.. _class_@GlobalScope_constant_HORIZONTAL:
enum **Orientation**:
- **VERTICAL** = **1** --- General vertical alignment, usually used for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc.
- **HORIZONTAL** = **0** --- General horizontal alignment, usually used 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 the main keyboard).
- **KEY_KP_ENTER** = **16777222** --- Enter key on the numeric keypad.
- **KEY_INSERT** = **16777223** --- Insert key.
- **KEY_DELETE** = **16777224** --- Delete key.
- **KEY_PAUSE** = **16777225** --- Pause key.
- **KEY_PRINT** = **16777226** --- Print Screen 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** --- Page Up key.
- **KEY_PAGEDOWN** = **16777236** --- Page Down key.
- **KEY_SHIFT** = **16777237** --- Shift key.
- **KEY_CONTROL** = **16777238** --- Control key.
- **KEY_META** = **16777239** --- Meta key.
- **KEY_ALT** = **16777240** --- Alt key.
- **KEY_CAPSLOCK** = **16777241** --- Caps Lock key.
- **KEY_NUMLOCK** = **16777242** --- Num Lock key.
- **KEY_SCROLLLOCK** = **16777243** --- Scroll Lock 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 the numeric keypad.
- **KEY_KP_DIVIDE** = **16777346** --- Divide (/) key on the numeric keypad.
- **KEY_KP_SUBTRACT** = **16777347** --- Subtract (-) key on the numeric keypad.
- **KEY_KP_PERIOD** = **16777348** --- Period (.) key on the numeric keypad.
- **KEY_KP_ADD** = **16777349** --- Add (+) key on the numeric keypad.
- **KEY_KP_0** = **16777350** --- Number 0 on the numeric keypad.
- **KEY_KP_1** = **16777351** --- Number 1 on the numeric keypad.
- **KEY_KP_2** = **16777352** --- Number 2 on the numeric keypad.
- **KEY_KP_3** = **16777353** --- Number 3 on the numeric keypad.
- **KEY_KP_4** = **16777354** --- Number 4 on the numeric keypad.
- **KEY_KP_5** = **16777355** --- Number 5 on the numeric keypad.
- **KEY_KP_6** = **16777356** --- Number 6 on the numeric keypad.
- **KEY_KP_7** = **16777357** --- Number 7 on the numeric keypad.
- **KEY_KP_8** = **16777358** --- Number 8 on the numeric keypad.
- **KEY_KP_9** = **16777359** --- Number 9 on the numeric keypad.
- **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** --- Media back key. Not to be confused with the Back button on an Android device.
- **KEY_FORWARD** = **16777281** --- Media forward key.
- **KEY_STOP** = **16777282** --- Media stop key.
- **KEY_REFRESH** = **16777283** --- Media 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** --- < key.
- **KEY_EQUAL** = **61** --- = key.
- **KEY_GREATER** = **62** --- > 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** --- ` key.
- **KEY_BRACELEFT** = **123** --- { key.
- **KEY_BAR** = **124** --- | key.
- **KEY_BRACERIGHT** = **125** --- } key.
- **KEY_ASCIITILDE** = **126** --- ~ key.
- **KEY_NOBREAKSPACE** = **160** --- Non-breakable space key.
- **KEY_EXCLAMDOWN** = **161** --- ¡ key.
- **KEY_CENT** = **162** --- ¢ key.
- **KEY_STERLING** = **163** --- £ key.
- **KEY_CURRENCY** = **164** --- ¤ key.
- **KEY_YEN** = **165** --- ¥ key.
- **KEY_BROKENBAR** = **166** --- ¦ key.
- **KEY_SECTION** = **167** --- § key.
- **KEY_DIAERESIS** = **168** --- ¨ key.
- **KEY_COPYRIGHT** = **169** --- © key.
- **KEY_ORDFEMININE** = **170** --- ª key.
- **KEY_GUILLEMOTLEFT** = **171** --- « key.
- **KEY_NOTSIGN** = **172** --- ¬ key.
- **KEY_HYPHEN** = **173** --- Soft hyphen key.
- **KEY_REGISTERED** = **174** --- ® key.
- **KEY_MACRON** = **175** --- ¯ 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** --- ¶ 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** = **platform-dependent** --- Command key mask. On macOS, this is equivalent to :ref:`KEY_MASK_META<class_@GlobalScope_constant_KEY_MASK_META>`. On other platforms, this is equivalent to :ref:`KEY_MASK_CTRL<class_@GlobalScope_constant_KEY_MASK_CTRL>`. This mask should be preferred to :ref:`KEY_MASK_META<class_@GlobalScope_constant_KEY_MASK_META>` or :ref:`KEY_MASK_CTRL<class_@GlobalScope_constant_KEY_MASK_CTRL>` for system shortcuts as it handles all platforms correctly.
- **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 (only present on some mice).
- **BUTTON_XBUTTON2** = **9** --- Extra mouse button 2 (only present on some mice).
- **BUTTON_WHEEL_UP** = **4** --- Mouse wheel up.
- **BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down.
- **BUTTON_WHEEL_LEFT** = **6** --- Mouse wheel left button (only present on some mice).
- **BUTTON_WHEEL_RIGHT** = **7** --- Mouse wheel right button (only present on some mice).
- **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_INVALID_OPTION:
.. _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_16:
.. _class_@GlobalScope_constant_JOY_BUTTON_17:
.. _class_@GlobalScope_constant_JOY_BUTTON_18:
.. _class_@GlobalScope_constant_JOY_BUTTON_19:
.. _class_@GlobalScope_constant_JOY_BUTTON_20:
.. _class_@GlobalScope_constant_JOY_BUTTON_21:
.. _class_@GlobalScope_constant_JOY_BUTTON_22:
.. _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_VR_GRIP:
.. _class_@GlobalScope_constant_JOY_VR_PAD:
.. _class_@GlobalScope_constant_JOY_VR_TRIGGER:
.. _class_@GlobalScope_constant_JOY_OCULUS_AX:
.. _class_@GlobalScope_constant_JOY_OCULUS_BY:
.. _class_@GlobalScope_constant_JOY_OCULUS_MENU:
.. _class_@GlobalScope_constant_JOY_OPENVR_MENU:
.. _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_GUIDE:
.. _class_@GlobalScope_constant_JOY_MISC1:
.. _class_@GlobalScope_constant_JOY_PADDLE1:
.. _class_@GlobalScope_constant_JOY_PADDLE2:
.. _class_@GlobalScope_constant_JOY_PADDLE3:
.. _class_@GlobalScope_constant_JOY_PADDLE4:
.. _class_@GlobalScope_constant_JOY_TOUCHPAD:
.. _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:
.. _class_@GlobalScope_constant_JOY_VR_ANALOG_TRIGGER:
.. _class_@GlobalScope_constant_JOY_VR_ANALOG_GRIP:
.. _class_@GlobalScope_constant_JOY_OPENVR_TOUCHPADX:
.. _class_@GlobalScope_constant_JOY_OPENVR_TOUCHPADY:
enum **JoystickList**:
- **JOY_INVALID_OPTION** = **-1** --- Invalid button or axis.
- **JOY_BUTTON_0** = **0** --- Gamepad button 0.
- **JOY_BUTTON_1** = **1** --- Gamepad button 1.
- **JOY_BUTTON_2** = **2** --- Gamepad button 2.
- **JOY_BUTTON_3** = **3** --- Gamepad button 3.
- **JOY_BUTTON_4** = **4** --- Gamepad button 4.
- **JOY_BUTTON_5** = **5** --- Gamepad button 5.
- **JOY_BUTTON_6** = **6** --- Gamepad button 6.
- **JOY_BUTTON_7** = **7** --- Gamepad button 7.
- **JOY_BUTTON_8** = **8** --- Gamepad button 8.
- **JOY_BUTTON_9** = **9** --- Gamepad button 9.
- **JOY_BUTTON_10** = **10** --- Gamepad button 10.
- **JOY_BUTTON_11** = **11** --- Gamepad button 11.
- **JOY_BUTTON_12** = **12** --- Gamepad button 12.
- **JOY_BUTTON_13** = **13** --- Gamepad button 13.
- **JOY_BUTTON_14** = **14** --- Gamepad button 14.
- **JOY_BUTTON_15** = **15** --- Gamepad button 15.
- **JOY_BUTTON_16** = **16** --- Gamepad button 16.
- **JOY_BUTTON_17** = **17** --- Gamepad button 17.
- **JOY_BUTTON_18** = **18** --- Gamepad button 18.
- **JOY_BUTTON_19** = **19** --- Gamepad button 19.
- **JOY_BUTTON_20** = **20** --- Gamepad button 20.
- **JOY_BUTTON_21** = **21** --- Gamepad button 21.
- **JOY_BUTTON_22** = **22** --- Gamepad button 22.
- **JOY_BUTTON_MAX** = **128** --- The maximum number of game controller buttons supported by the engine. The actual limit may be lower on specific platforms:
- Android: Up to 36 buttons.
- Linux: Up to 80 buttons.
- Windows and macOS: Up to 128 buttons.
- **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** --- Nintendo controller A button.
- **JOY_DS_B** = **0** --- Nintendo controller B button.
- **JOY_DS_X** = **3** --- Nintendo controller X button.
- **JOY_DS_Y** = **2** --- Nintendo controller Y button.
- **JOY_VR_GRIP** = **2** --- Grip (side) buttons on a VR controller.
- **JOY_VR_PAD** = **14** --- Push down on the touchpad or main joystick on a VR controller.
- **JOY_VR_TRIGGER** = **15** --- Trigger on a VR controller.
- **JOY_OCULUS_AX** = **7** --- A button on the right Oculus Touch controller, X button on the left controller (also when used in OpenVR).
- **JOY_OCULUS_BY** = **1** --- B button on the right Oculus Touch controller, Y button on the left controller (also when used in OpenVR).
- **JOY_OCULUS_MENU** = **3** --- Menu button on either Oculus Touch controller.
- **JOY_OPENVR_MENU** = **1** --- Menu button in OpenVR (Except when Oculus Touch controllers are used).
- **JOY_SELECT** = **10** --- Gamepad button Select.
- **JOY_START** = **11** --- Gamepad button Start.
- **JOY_DPAD_UP** = **12** --- Gamepad DPad up.
- **JOY_DPAD_DOWN** = **13** --- Gamepad DPad down.
- **JOY_DPAD_LEFT** = **14** --- Gamepad DPad left.
- **JOY_DPAD_RIGHT** = **15** --- Gamepad DPad right.
- **JOY_GUIDE** = **16** --- Gamepad SDL guide button.
- **JOY_MISC1** = **17** --- Gamepad SDL miscellaneous button.
- **JOY_PADDLE1** = **18** --- Gamepad SDL paddle 1 button.
- **JOY_PADDLE2** = **19** --- Gamepad SDL paddle 2 button.
- **JOY_PADDLE3** = **20** --- Gamepad SDL paddle 3 button.
- **JOY_PADDLE4** = **21** --- Gamepad SDL paddle 4 button.
- **JOY_TOUCHPAD** = **22** --- Gamepad SDL touchpad button.
- **JOY_L** = **4** --- Gamepad left Shoulder button.
- **JOY_L2** = **6** --- Gamepad left trigger.
- **JOY_L3** = **8** --- Gamepad left stick click.
- **JOY_R** = **5** --- Gamepad right Shoulder button.
- **JOY_R2** = **7** --- Gamepad right trigger.
- **JOY_R3** = **9** --- Gamepad right stick click.
- **JOY_AXIS_0** = **0** --- Gamepad left stick horizontal axis.
- **JOY_AXIS_1** = **1** --- Gamepad left stick vertical axis.
- **JOY_AXIS_2** = **2** --- Gamepad right stick horizontal axis.
- **JOY_AXIS_3** = **3** --- Gamepad right stick vertical axis.
- **JOY_AXIS_4** = **4** --- Generic gamepad axis 4.
- **JOY_AXIS_5** = **5** --- Generic gamepad axis 5.
- **JOY_AXIS_6** = **6** --- Gamepad left trigger analog axis.
- **JOY_AXIS_7** = **7** --- Gamepad right trigger analog axis.
- **JOY_AXIS_8** = **8** --- Generic gamepad axis 8.
- **JOY_AXIS_9** = **9** --- Generic gamepad axis 9.
- **JOY_AXIS_MAX** = **10** --- Represents the maximum number of joystick axes supported.
- **JOY_ANALOG_LX** = **0** --- Gamepad left stick horizontal axis.
- **JOY_ANALOG_LY** = **1** --- Gamepad left stick vertical axis.
- **JOY_ANALOG_RX** = **2** --- Gamepad right stick horizontal axis.
- **JOY_ANALOG_RY** = **3** --- Gamepad right stick vertical axis.
- **JOY_ANALOG_L2** = **6** --- Gamepad left analog trigger.
- **JOY_ANALOG_R2** = **7** --- Gamepad right analog trigger.
- **JOY_VR_ANALOG_TRIGGER** = **2** --- VR Controller analog trigger.
- **JOY_VR_ANALOG_GRIP** = **4** --- VR Controller analog grip (side buttons).
- **JOY_OPENVR_TOUCHPADX** = **0** --- OpenVR touchpad X axis (Joystick axis on Oculus Touch and Windows MR controllers).
- **JOY_OPENVR_TOUCHPADY** = **1** --- OpenVR touchpad Y axis (Joystick axis on Oculus Touch and Windows MR controllers).
----
.. _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 note OFF message.
- **MIDI_MESSAGE_NOTE_ON** = **9** --- MIDI note ON message.
- **MIDI_MESSAGE_AFTERTOUCH** = **10** --- MIDI aftertouch message.
- **MIDI_MESSAGE_CONTROL_CHANGE** = **11** --- MIDI control change message.
- **MIDI_MESSAGE_PROGRAM_CHANGE** = **12** --- MIDI program change message.
- **MIDI_MESSAGE_CHANNEL_PRESSURE** = **13** --- MIDI channel pressure message.
- **MIDI_MESSAGE_PITCH_BEND** = **14** --- MIDI pitch bend message.
----
.. _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_QUERY_FAILED:
.. _class_@GlobalScope_constant_ERR_ALREADY_IN_USE:
.. _class_@GlobalScope_constant_ERR_LOCKED:
.. _class_@GlobalScope_constant_ERR_TIMEOUT:
.. _class_@GlobalScope_constant_ERR_CANT_CONNECT:
.. _class_@GlobalScope_constant_ERR_CANT_RESOLVE:
.. _class_@GlobalScope_constant_ERR_CONNECTION_ERROR:
.. _class_@GlobalScope_constant_ERR_CANT_ACQUIRE_RESOURCE:
.. _class_@GlobalScope_constant_ERR_CANT_FORK:
.. _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_INVALID_DECLARATION:
.. _class_@GlobalScope_constant_ERR_DUPLICATE_SYMBOL:
.. _class_@GlobalScope_constant_ERR_PARSE_ERROR:
.. _class_@GlobalScope_constant_ERR_BUSY:
.. _class_@GlobalScope_constant_ERR_SKIP:
.. _class_@GlobalScope_constant_ERR_HELP:
.. _class_@GlobalScope_constant_ERR_BUG:
.. _class_@GlobalScope_constant_ERR_PRINTER_ON_FIRE:
enum **Error**:
- **OK** = **0** --- Methods that return :ref:`Error<enum_@GlobalScope_Error>` return :ref:`OK<class_@GlobalScope_constant_OK>` when no error occurred. Note that many functions don't return an error code but will print error messages to standard output.
Since :ref:`OK<class_@GlobalScope_constant_OK>` has value 0, and all other failure codes are positive integers, it can also be used in boolean checks, e.g.:
::
var err = method_that_returns_error()
if err != OK:
print("Failure!")
# Or, equivalent:
if err:
print("Still failing!")
- **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_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_CONNECT** = **25** --- Can't connect error.
- **ERR_CANT_RESOLVE** = **26** --- Can't resolve error.
- **ERR_CONNECTION_ERROR** = **27** --- Connection error.
- **ERR_CANT_ACQUIRE_RESOURCE** = **28** --- Can't acquire resource error.
- **ERR_CANT_FORK** = **29** --- Can't fork process 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_INVALID_DECLARATION** = **41** --- Invalid declaration error.
- **ERR_DUPLICATE_SYMBOL** = **42** --- Duplicate symbol error.
- **ERR_PARSE_ERROR** = **43** --- Parse error.
- **ERR_BUSY** = **44** --- Busy error.
- **ERR_SKIP** = **45** --- Skip error.
- **ERR_HELP** = **46** --- Help error.
- **ERR_BUG** = **47** --- Bug error.
- **ERR_PRINTER_ON_FIRE** = **48** --- Printer on fire error. (This is an easter egg, no engine methods return this error code.)
----
.. _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 the edited property.
- **PROPERTY_HINT_RANGE** = **1** --- Hints that an integer or float property should be within a range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"or_greater"`` and/or ``"or_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"-360,360,1,or_greater,or_lesser"``.
- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that a float property should be within an exponential range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"or_greater"`` and/or ``"or_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"0.01,100,0.01,or_greater"``.
- **PROPERTY_HINT_ENUM** = **3** --- Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string such as ``"Hello,Something,Else"``.
- **PROPERTY_HINT_EXP_EASING** = **4** --- Hints that a float property should be edited via an exponential easing function. The hint string can include ``"attenuation"`` to flip the curve horizontally and/or ``"inout"`` to also include in/out easing.
- **PROPERTY_HINT_LENGTH** = **5** --- Deprecated hint, unused.
- **PROPERTY_HINT_KEY_ACCEL** = **7** --- Deprecated hint, unused.
- **PROPERTY_HINT_FLAGS** = **8** --- Hints that an integer property is a bitmask with named bit flags. For example, to allow toggling bits 0, 1, 2 and 4, the hint could be something like ``"Bit0,Bit1,Bit2,,Bit4"``.
- **PROPERTY_HINT_LAYERS_2D_RENDER** = **9** --- Hints that an integer property is a bitmask using the optionally named 2D render layers.
- **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10** --- Hints that an integer property is a bitmask using the optionally named 2D physics layers.
- **PROPERTY_HINT_LAYERS_3D_RENDER** = **11** --- Hints that an integer property is a bitmask using the optionally named 3D render layers.
- **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12** --- Hints that an integer property is a bitmask using the optionally named 3D physics layers.
- **PROPERTY_HINT_FILE** = **13** --- Hints that a string property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``.
- **PROPERTY_HINT_DIR** = **14** --- Hints that a string property is a path to a directory. Editing it will show a file dialog for picking the path.
- **PROPERTY_HINT_GLOBAL_FILE** = **15** --- Hints that a string property is an absolute path to a file outside the project folder. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``.
- **PROPERTY_HINT_GLOBAL_DIR** = **16** --- Hints that a string property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path.
- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- Hints that a property is an instance of a :ref:`Resource<class_Resource>`-derived type, optionally specified via the hint string (e.g. ``"Texture"``). Editing it will show a popup menu of valid resource types to instantiate.
- **PROPERTY_HINT_MULTILINE_TEXT** = **18** --- Hints that a string property is text with line breaks. Editing it will show a text input field where line breaks can be typed.
- **PROPERTY_HINT_PLACEHOLDER_TEXT** = **19** --- Hints that a string property should have a placeholder text visible on its input field, whenever the property is empty. The hint string is the placeholder text to use.
- **PROPERTY_HINT_COLOR_NO_ALPHA** = **20** --- Hints that a color property should be edited without changing its alpha component, i.e. only R, G and B channels are edited.
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that an image is compressed using lossy compression.
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that an 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** --- The property is serialized and saved in the scene file (default).
- **PROPERTY_USAGE_EDITOR** = **2** --- The property is shown in the editor inspector (default).
- **PROPERTY_USAGE_NETWORK** = **4** --- Deprecated usage flag, unused.
- **PROPERTY_USAGE_EDITOR_HELPER** = **8** --- Deprecated usage flag, unused.
- **PROPERTY_USAGE_CHECKABLE** = **16** --- The property can be checked in the editor inspector.
- **PROPERTY_USAGE_CHECKED** = **32** --- The property is checked in the editor inspector.
- **PROPERTY_USAGE_INTERNATIONALIZED** = **64** --- The property is a translatable string.
- **PROPERTY_USAGE_GROUP** = **128** --- Used to group properties together in the editor.
- **PROPERTY_USAGE_CATEGORY** = **256** --- Used to categorize properties together in the editor.
- **PROPERTY_USAGE_NO_INSTANCE_STATE** = **2048** --- The property does not save its state in :ref:`PackedScene<class_PackedScene>`.
- **PROPERTY_USAGE_RESTART_IF_CHANGED** = **4096** --- Editing the property prompts the user for restarting the editor.
- **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192** --- The property is a script variable which should be serialized and saved in the scene file.
- **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage, editor and network).
- **PROPERTY_USAGE_DEFAULT_INTL** = **71** --- Default usage for translatable strings (storage, editor, network and internationalized).
- **PROPERTY_USAGE_NOEDITOR** = **5** --- Default usage but without showing the property in the editor (storage, network).
----
.. _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 a normal method.
- **METHOD_FLAG_EDITOR** = **2** --- Flag for an editor method.
- **METHOD_FLAG_NOSCRIPT** = **4** --- Deprecated method flag, unused.
- **METHOD_FLAG_CONST** = **8** --- Flag for a constant method.
- **METHOD_FLAG_REVERSE** = **16** --- Deprecated method flag, unused.
- **METHOD_FLAG_VIRTUAL** = **32** --- Flag for a virtual method.
- **METHOD_FLAG_FROM_SCRIPT** = **64** --- Deprecated method flag, unused.
- **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 ``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** --- Represents the size of the :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` enum.
----
.. _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** --- Equality operator (``==``).
- **OP_NOT_EQUAL** = **1** --- Inequality operator (``!=``).
- **OP_LESS** = **2** --- Less than operator (``<``).
- **OP_LESS_EQUAL** = **3** --- Less than or equal operator (``<=``).
- **OP_GREATER** = **4** --- Greater than operator (``>``).
- **OP_GREATER_EQUAL** = **5** --- Greater than or equal operator (``>=``).
- **OP_ADD** = **6** --- Addition operator (``+``).
- **OP_SUBTRACT** = **7** --- Subtraction operator (``-``).
- **OP_MULTIPLY** = **8** --- Multiplication operator (``*``).
- **OP_DIVIDE** = **9** --- Division operator (``/``).
- **OP_NEGATE** = **10** --- Unary negation operator (``-``).
- **OP_POSITIVE** = **11** --- Unary plus operator (``+``).
- **OP_MODULE** = **12** --- Remainder/modulo operator (``%``).
- **OP_STRING_CONCAT** = **13** --- String concatenation operator (``+``).
- **OP_SHIFT_LEFT** = **14** --- Left shift operator (``<<``).
- **OP_SHIFT_RIGHT** = **15** --- Right shift operator (``>>``).
- **OP_BIT_AND** = **16** --- Bitwise AND operator (``&``).
- **OP_BIT_OR** = **17** --- Bitwise OR operator (``|``).
- **OP_BIT_XOR** = **18** --- Bitwise XOR operator (``^``).
- **OP_BIT_NEGATE** = **19** --- Bitwise NOT operator (``~``).
- **OP_AND** = **20** --- Logical AND operator (``and`` or ``&&``).
- **OP_OR** = **21** --- Logical OR operator (``or`` or ``||``).
- **OP_XOR** = **22** --- Logical XOR operator (not implemented in GDScript).
- **OP_NOT** = **23** --- Logical NOT operator (``not`` or ``!``).
- **OP_IN** = **24** --- Logical IN operator (``in``).
- **OP_MAX** = **25** --- Represents the size of the :ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` enum.
Constants
---------
.. _class_@GlobalScope_constant_SPKEY:
- **SPKEY** = **16777216** --- Scancodes with this bit applied are non-printable.
Property Descriptions
---------------------
.. _class_@GlobalScope_property_ARVRServer:
- :ref:`ARVRServer<class_ARVRServer>` **ARVRServer**
The :ref:`ARVRServer<class_ARVRServer>` singleton.
----
.. _class_@GlobalScope_property_AudioServer:
- :ref:`AudioServer<class_AudioServer>` **AudioServer**
The :ref:`AudioServer<class_AudioServer>` singleton.
----
.. _class_@GlobalScope_property_CameraServer:
- :ref:`CameraServer<class_CameraServer>` **CameraServer**
The :ref:`CameraServer<class_CameraServer>` singleton.
----
.. _class_@GlobalScope_property_ClassDB:
- :ref:`ClassDB<class_ClassDB>` **ClassDB**
The :ref:`ClassDB<class_ClassDB>` singleton.
----
.. _class_@GlobalScope_property_Engine:
- :ref:`Engine<class_Engine>` **Engine**
The :ref:`Engine<class_Engine>` singleton.
----
.. _class_@GlobalScope_property_Geometry:
- :ref:`Geometry<class_Geometry>` **Geometry**
The :ref:`Geometry<class_Geometry>` singleton.
----
.. _class_@GlobalScope_property_IP:
- :ref:`IP<class_IP>` **IP**
The :ref:`IP<class_IP>` singleton.
----
.. _class_@GlobalScope_property_Input:
- :ref:`Input<class_Input>` **Input**
The :ref:`Input<class_Input>` singleton.
----
.. _class_@GlobalScope_property_InputMap:
- :ref:`InputMap<class_InputMap>` **InputMap**
The :ref:`InputMap<class_InputMap>` singleton.
----
.. _class_@GlobalScope_property_JSON:
- :ref:`JSON<class_JSON>` **JSON**
The :ref:`JSON<class_JSON>` singleton.
----
.. _class_@GlobalScope_property_JavaClassWrapper:
- :ref:`JavaClassWrapper<class_JavaClassWrapper>` **JavaClassWrapper**
The :ref:`JavaClassWrapper<class_JavaClassWrapper>` singleton.
**Note:** Only implemented on Android.
----
.. _class_@GlobalScope_property_JavaScript:
- :ref:`JavaScript<class_JavaScript>` **JavaScript**
The :ref:`JavaScript<class_JavaScript>` singleton.
**Note:** Only implemented on HTML5.
----
.. _class_@GlobalScope_property_Marshalls:
- :ref:`Marshalls<class_Marshalls>` **Marshalls**
The :ref:`Marshalls<class_Marshalls>` singleton.
----
.. _class_@GlobalScope_property_NavigationMeshGenerator:
- :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>` **NavigationMeshGenerator**
The :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>` singleton.
----
.. _class_@GlobalScope_property_OS:
- :ref:`OS<class_OS>` **OS**
The :ref:`OS<class_OS>` singleton.
----
.. _class_@GlobalScope_property_Performance:
- :ref:`Performance<class_Performance>` **Performance**
The :ref:`Performance<class_Performance>` singleton.
----
.. _class_@GlobalScope_property_Physics2DServer:
- :ref:`Physics2DServer<class_Physics2DServer>` **Physics2DServer**
The :ref:`Physics2DServer<class_Physics2DServer>` singleton.
----
.. _class_@GlobalScope_property_PhysicsServer:
- :ref:`PhysicsServer<class_PhysicsServer>` **PhysicsServer**
The :ref:`PhysicsServer<class_PhysicsServer>` singleton.
----
.. _class_@GlobalScope_property_ProjectSettings:
- :ref:`ProjectSettings<class_ProjectSettings>` **ProjectSettings**
The :ref:`ProjectSettings<class_ProjectSettings>` singleton.
----
.. _class_@GlobalScope_property_ResourceLoader:
- :ref:`ResourceLoader<class_ResourceLoader>` **ResourceLoader**
The :ref:`ResourceLoader<class_ResourceLoader>` singleton.
----
.. _class_@GlobalScope_property_ResourceSaver:
- :ref:`ResourceSaver<class_ResourceSaver>` **ResourceSaver**
The :ref:`ResourceSaver<class_ResourceSaver>` singleton.
----
.. _class_@GlobalScope_property_TranslationServer:
- :ref:`TranslationServer<class_TranslationServer>` **TranslationServer**
The :ref:`TranslationServer<class_TranslationServer>` singleton.
----
.. _class_@GlobalScope_property_VisualScriptEditor:
- :ref:`VisualScriptEditor<class_VisualScriptEditor>` **VisualScriptEditor**
The :ref:`VisualScriptEditor<class_VisualScriptEditor>` singleton.
----
.. _class_@GlobalScope_property_VisualServer:
- :ref:`VisualServer<class_VisualServer>` **VisualServer**
The :ref:`VisualServer<class_VisualServer>` singleton.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
Reference in New Issue View Git Blame Copy Permalink