godot/doc/classes/@GlobalScope.xml
Leon Krause 63b1a096eb Facilitate exposing platform-exclusive interfaces to all platforms
This makes the interfaces available, without implementation, in other
platforms and the editor, which facilitates documenting platform-exclusive
classes.

Platform-exclusive APIs must be set up in platform/<platform>/api/api.cpp.
Provide noop method-implementations where necessary.

Also setup and document the HTML5 platform's JavaScript singleton.
2017-11-18 03:54:21 +01:00

1390 lines
38 KiB
XML
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.

<?xml version="1.0" encoding="UTF-8" ?>
<class name="@GlobalScope" category="Core" version="3.0-alpha">
<brief_description>
Global scope constants and variables.
</brief_description>
<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.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="ARVRServer" type="ARVRServer" setter="" getter="">
[ARVRServer] singleton
</member>
<member name="AudioServer" type="AudioServer" setter="" getter="">
[AudioServer] singleton
</member>
<member name="ClassDB" type="ClassDB" setter="" getter="">
[ClassDB] singleton
</member>
<member name="Engine" type="Engine" setter="" getter="">
[Engine] singleton
</member>
<member name="Geometry" type="Geometry" setter="" getter="">
[Geometry] singleton
</member>
<member name="GodotSharp" type="GodotSharp" setter="" getter="">
[GodotSharp] singleton
</member>
<member name="IP" type="IP" setter="" getter="">
[IP] singleton
</member>
<member name="Input" type="Input" setter="" getter="">
[Input] singleton
</member>
<member name="InputMap" type="InputMap" setter="" getter="">
[InputMap] singleton
</member>
<member name="JSON" type="JSON" setter="" getter="">
[JSON] singleton
</member>
<member name="JavaScript" type="JavaScript" setter="" getter="">
</member>
<member name="Marshalls" type="Reference" setter="" getter="">
[Marshalls] singleton
</member>
<member name="OS" type="OS" setter="" getter="">
[OS] singleton
</member>
<member name="Performance" type="Performance" setter="" getter="">
[Performance] singleton
</member>
<member name="Physics2DServer" type="Physics2DServer" setter="" getter="">
[Physics2DServer] singleton
</member>
<member name="PhysicsServer" type="PhysicsServer" setter="" getter="">
[PhysicsServer] singleton
</member>
<member name="ProjectSettings" type="ProjectSettings" setter="" getter="">
[ProjectSettings] singleton
</member>
<member name="ResourceLoader" type="ResourceLoader" setter="" getter="">
[ResourceLoader] singleton
</member>
<member name="ResourceSaver" type="ResourceSaver" setter="" getter="">
[ResourceSaver] singleton
</member>
<member name="TranslationServer" type="TranslationServer" setter="" getter="">
[TranslationServer] singleton
</member>
<member name="VisualServer" type="VisualServer" setter="" getter="">
[VisualServer] singleton
</member>
</members>
<constants>
<constant name="MARGIN_LEFT" value="0">
Left margin, used usually for [Control] or [StyleBox] derived classes.
</constant>
<constant name="MARGIN_TOP" value="1">
Top margin, used usually for [Control] or [StyleBox] derived classes.
</constant>
<constant name="MARGIN_RIGHT" value="2">
Right margin, used usually for [Control] or [StyleBox] derived classes.
</constant>
<constant name="MARGIN_BOTTOM" value="3">
Bottom margin, used usually for [Control] or [StyleBox] derived classes.
</constant>
<constant name="VERTICAL" value="1">
General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
</constant>
<constant name="HORIZONTAL" value="0">
General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
</constant>
<constant name="HALIGN_LEFT" value="0">
Horizontal left alignment, usually for text-derived classes.
</constant>
<constant name="HALIGN_CENTER" value="1">
Horizontal center alignment, usually for text-derived classes.
</constant>
<constant name="HALIGN_RIGHT" value="2">
Horizontal right alignment, usually for text-derived classes.
</constant>
<constant name="VALIGN_TOP" value="0">
Vertical top alignment, usually for text-derived classes.
</constant>
<constant name="VALIGN_CENTER" value="1">
Vertical center alignment, usually for text-derived classes.
</constant>
<constant name="VALIGN_BOTTOM" value="2">
Vertical bottom alignment, usually for text-derived classes.
</constant>
<constant name="SPKEY" value="16777216" enum="">
Scancodes with this bit applied are non printable.
</constant>
<constant name="KEY_ESCAPE" value="16777217">
Escape Key
</constant>
<constant name="KEY_TAB" value="16777218">
Tab Key
</constant>
<constant name="KEY_BACKTAB" value="16777219">
Shift-Tab Key
</constant>
<constant name="KEY_BACKSPACE" value="16777220">
Backspace Key
</constant>
<constant name="KEY_ENTER" value="16777221">
Return Key (On Main Keyboard)
</constant>
<constant name="KEY_KP_ENTER" value="16777222">
Enter Key (On Numpad)
</constant>
<constant name="KEY_INSERT" value="16777223">
Insert Key
</constant>
<constant name="KEY_DELETE" value="16777224">
Delete Key
</constant>
<constant name="KEY_PAUSE" value="16777225">
Pause Key
</constant>
<constant name="KEY_PRINT" value="16777226">
Printscreen Key
</constant>
<constant name="KEY_SYSREQ" value="16777227">
System Request Key
</constant>
<constant name="KEY_CLEAR" value="16777228">
Clear Key
</constant>
<constant name="KEY_HOME" value="16777229">
Home Key
</constant>
<constant name="KEY_END" value="16777230">
End Key
</constant>
<constant name="KEY_LEFT" value="16777231">
Left Arrow Key
</constant>
<constant name="KEY_UP" value="16777232">
Up Arrow Key
</constant>
<constant name="KEY_RIGHT" value="16777233">
Right Arrow Key
</constant>
<constant name="KEY_DOWN" value="16777234">
Down Arrow Key
</constant>
<constant name="KEY_PAGEUP" value="16777235">
Pageup Key
</constant>
<constant name="KEY_PAGEDOWN" value="16777236">
Pagedown Key
</constant>
<constant name="KEY_SHIFT" value="16777237">
Shift Key
</constant>
<constant name="KEY_CONTROL" value="16777238">
Control Key
</constant>
<constant name="KEY_META" value="16777239">
Meta Key
</constant>
<constant name="KEY_ALT" value="16777240">
Alt Key
</constant>
<constant name="KEY_CAPSLOCK" value="16777241">
Capslock Key
</constant>
<constant name="KEY_NUMLOCK" value="16777242">
Numlock Key
</constant>
<constant name="KEY_SCROLLLOCK" value="16777243">
Scrolllock Key
</constant>
<constant name="KEY_F1" value="16777244">
F1 Key
</constant>
<constant name="KEY_F2" value="16777245">
F2 Key
</constant>
<constant name="KEY_F3" value="16777246">
F3 Key
</constant>
<constant name="KEY_F4" value="16777247">
F4 Key
</constant>
<constant name="KEY_F5" value="16777248">
F5 Key
</constant>
<constant name="KEY_F6" value="16777249">
F6 Key
</constant>
<constant name="KEY_F7" value="16777250">
F7 Key
</constant>
<constant name="KEY_F8" value="16777251">
F8 Key
</constant>
<constant name="KEY_F9" value="16777252">
F9 Key
</constant>
<constant name="KEY_F10" value="16777253">
F10 Key
</constant>
<constant name="KEY_F11" value="16777254">
F11 Key
</constant>
<constant name="KEY_F12" value="16777255">
F12 Key
</constant>
<constant name="KEY_F13" value="16777256">
F13 Key
</constant>
<constant name="KEY_F14" value="16777257">
F14 Key
</constant>
<constant name="KEY_F15" value="16777258">
F15 Key
</constant>
<constant name="KEY_F16" value="16777259">
F16 Key
</constant>
<constant name="KEY_KP_MULTIPLY" value="16777345">
Multiply Key on Numpad
</constant>
<constant name="KEY_KP_DIVIDE" value="16777346">
Divide Key on Numpad
</constant>
<constant name="KEY_KP_SUBTRACT" value="16777347">
Subtract Key on Numpad
</constant>
<constant name="KEY_KP_PERIOD" value="16777348">
Period Key on Numpad
</constant>
<constant name="KEY_KP_ADD" value="16777349">
Add Key on Numpad
</constant>
<constant name="KEY_KP_0" value="16777350">
Number 0 on Numpad
</constant>
<constant name="KEY_KP_1" value="16777351">
Number 1 on Numpad
</constant>
<constant name="KEY_KP_2" value="16777352">
Number 2 on Numpad
</constant>
<constant name="KEY_KP_3" value="16777353">
Number 3 on Numpad
</constant>
<constant name="KEY_KP_4" value="16777354">
Number 4 on Numpad
</constant>
<constant name="KEY_KP_5" value="16777355">
Number 5 on Numpad
</constant>
<constant name="KEY_KP_6" value="16777356">
Number 6 on Numpad
</constant>
<constant name="KEY_KP_7" value="16777357">
Number 7 on Numpad
</constant>
<constant name="KEY_KP_8" value="16777358">
Number 8 on Numpad
</constant>
<constant name="KEY_KP_9" value="16777359">
Number 9 on Numpad
</constant>
<constant name="KEY_SUPER_L" value="16777260">
Left Super Key (Windows Key)
</constant>
<constant name="KEY_SUPER_R" value="16777261">
Right Super Key (Windows Key)
</constant>
<constant name="KEY_MENU" value="16777262">
Context menu key
</constant>
<constant name="KEY_HYPER_L" value="16777263">
Left Hyper Key
</constant>
<constant name="KEY_HYPER_R" value="16777264">
Right Hyper Key
</constant>
<constant name="KEY_HELP" value="16777265">
Help key
</constant>
<constant name="KEY_DIRECTION_L" value="16777266">
Left Direction Key
</constant>
<constant name="KEY_DIRECTION_R" value="16777267">
Right Direction Key
</constant>
<constant name="KEY_BACK" value="16777280">
Back key
</constant>
<constant name="KEY_FORWARD" value="16777281">
Forward key
</constant>
<constant name="KEY_STOP" value="16777282">
Stop key
</constant>
<constant name="KEY_REFRESH" value="16777283">
Refresh key
</constant>
<constant name="KEY_VOLUMEDOWN" value="16777284">
Volume down key
</constant>
<constant name="KEY_VOLUMEMUTE" value="16777285">
Mute volume key
</constant>
<constant name="KEY_VOLUMEUP" value="16777286">
Volume up key
</constant>
<constant name="KEY_BASSBOOST" value="16777287">
Bass Boost Key
</constant>
<constant name="KEY_BASSUP" value="16777288">
Bass Up Key
</constant>
<constant name="KEY_BASSDOWN" value="16777289">
Bass Down Key
</constant>
<constant name="KEY_TREBLEUP" value="16777290">
Treble Up Key
</constant>
<constant name="KEY_TREBLEDOWN" value="16777291">
Treble Down Key
</constant>
<constant name="KEY_MEDIAPLAY" value="16777292">
Media play key
</constant>
<constant name="KEY_MEDIASTOP" value="16777293">
Media stop key
</constant>
<constant name="KEY_MEDIAPREVIOUS" value="16777294">
Previous song key
</constant>
<constant name="KEY_MEDIANEXT" value="16777295">
Next song key
</constant>
<constant name="KEY_MEDIARECORD" value="16777296">
Media record key
</constant>
<constant name="KEY_HOMEPAGE" value="16777297">
Home page key
</constant>
<constant name="KEY_FAVORITES" value="16777298">
Favorites key
</constant>
<constant name="KEY_SEARCH" value="16777299">
Search key
</constant>
<constant name="KEY_STANDBY" value="16777300">
Standby Key
</constant>
<constant name="KEY_OPENURL" value="16777301">
Open URL / Launch Browser Key
</constant>
<constant name="KEY_LAUNCHMAIL" value="16777302">
Launch Mail Key
</constant>
<constant name="KEY_LAUNCHMEDIA" value="16777303">
Launch Media Key
</constant>
<constant name="KEY_LAUNCH0" value="16777304">
Launch Shortcut 0 Key
</constant>
<constant name="KEY_LAUNCH1" value="16777305">
Launch Shortcut 1 Key
</constant>
<constant name="KEY_LAUNCH2" value="16777306">
Launch Shortcut 2 Key
</constant>
<constant name="KEY_LAUNCH3" value="16777307">
Launch Shortcut 3 Key
</constant>
<constant name="KEY_LAUNCH4" value="16777308">
Launch Shortcut 4 Key
</constant>
<constant name="KEY_LAUNCH5" value="16777309">
Launch Shortcut 5 Key
</constant>
<constant name="KEY_LAUNCH6" value="16777310">
Launch Shortcut 6 Key
</constant>
<constant name="KEY_LAUNCH7" value="16777311">
Launch Shortcut 7 Key
</constant>
<constant name="KEY_LAUNCH8" value="16777312">
Launch Shortcut 8 Key
</constant>
<constant name="KEY_LAUNCH9" value="16777313">
Launch Shortcut 9 Key
</constant>
<constant name="KEY_LAUNCHA" value="16777314">
Launch Shortcut A Key
</constant>
<constant name="KEY_LAUNCHB" value="16777315">
Launch Shortcut B Key
</constant>
<constant name="KEY_LAUNCHC" value="16777316">
Launch Shortcut C Key
</constant>
<constant name="KEY_LAUNCHD" value="16777317">
Launch Shortcut D Key
</constant>
<constant name="KEY_LAUNCHE" value="16777318">
Launch Shortcut E Key
</constant>
<constant name="KEY_LAUNCHF" value="16777319">
Launch Shortcut F Key
</constant>
<constant name="KEY_UNKNOWN" value="33554431">
Unknown Key
</constant>
<constant name="KEY_SPACE" value="32">
Space Key
</constant>
<constant name="KEY_EXCLAM" value="33">
! key
</constant>
<constant name="KEY_QUOTEDBL" value="34">
" key
</constant>
<constant name="KEY_NUMBERSIGN" value="35">
# key
</constant>
<constant name="KEY_DOLLAR" value="36">
$ key
</constant>
<constant name="KEY_PERCENT" value="37">
% key
</constant>
<constant name="KEY_AMPERSAND" value="38">
&amp; key
</constant>
<constant name="KEY_APOSTROPHE" value="39">
' key
</constant>
<constant name="KEY_PARENLEFT" value="40">
( key
</constant>
<constant name="KEY_PARENRIGHT" value="41">
) key
</constant>
<constant name="KEY_ASTERISK" value="42">
* key
</constant>
<constant name="KEY_PLUS" value="43">
+ key
</constant>
<constant name="KEY_COMMA" value="44">
, key
</constant>
<constant name="KEY_MINUS" value="45">
- key
</constant>
<constant name="KEY_PERIOD" value="46">
. key
</constant>
<constant name="KEY_SLASH" value="47">
/ key
</constant>
<constant name="KEY_0" value="48">
Number 0
</constant>
<constant name="KEY_1" value="49">
Number 1
</constant>
<constant name="KEY_2" value="50">
Number 2
</constant>
<constant name="KEY_3" value="51">
Number 3
</constant>
<constant name="KEY_4" value="52">
Number 4
</constant>
<constant name="KEY_5" value="53">
Number 5
</constant>
<constant name="KEY_6" value="54">
Number 6
</constant>
<constant name="KEY_7" value="55">
Number 7
</constant>
<constant name="KEY_8" value="56">
Number 8
</constant>
<constant name="KEY_9" value="57">
Number 9
</constant>
<constant name="KEY_COLON" value="58">
: key
</constant>
<constant name="KEY_SEMICOLON" value="59">
; key
</constant>
<constant name="KEY_LESS" value="60">
Lower than key
</constant>
<constant name="KEY_EQUAL" value="61">
= key
</constant>
<constant name="KEY_GREATER" value="62">
Greater than key
</constant>
<constant name="KEY_QUESTION" value="63">
? key
</constant>
<constant name="KEY_AT" value="64">
@ key
</constant>
<constant name="KEY_A" value="65">
A Key
</constant>
<constant name="KEY_B" value="66">
B Key
</constant>
<constant name="KEY_C" value="67">
C Key
</constant>
<constant name="KEY_D" value="68">
D Key
</constant>
<constant name="KEY_E" value="69">
E Key
</constant>
<constant name="KEY_F" value="70">
F Key
</constant>
<constant name="KEY_G" value="71">
G Key
</constant>
<constant name="KEY_H" value="72">
H Key
</constant>
<constant name="KEY_I" value="73">
I Key
</constant>
<constant name="KEY_J" value="74">
J Key
</constant>
<constant name="KEY_K" value="75">
K Key
</constant>
<constant name="KEY_L" value="76">
L Key
</constant>
<constant name="KEY_M" value="77">
M Key
</constant>
<constant name="KEY_N" value="78">
N Key
</constant>
<constant name="KEY_O" value="79">
O Key
</constant>
<constant name="KEY_P" value="80">
P Key
</constant>
<constant name="KEY_Q" value="81">
Q Key
</constant>
<constant name="KEY_R" value="82">
R Key
</constant>
<constant name="KEY_S" value="83">
S Key
</constant>
<constant name="KEY_T" value="84">
T Key
</constant>
<constant name="KEY_U" value="85">
U Key
</constant>
<constant name="KEY_V" value="86">
V Key
</constant>
<constant name="KEY_W" value="87">
W Key
</constant>
<constant name="KEY_X" value="88">
X Key
</constant>
<constant name="KEY_Y" value="89">
Y Key
</constant>
<constant name="KEY_Z" value="90">
Z Key
</constant>
<constant name="KEY_BRACKETLEFT" value="91">
[ key
</constant>
<constant name="KEY_BACKSLASH" value="92">
\ key
</constant>
<constant name="KEY_BRACKETRIGHT" value="93">
] key
</constant>
<constant name="KEY_ASCIICIRCUM" value="94">
^ key
</constant>
<constant name="KEY_UNDERSCORE" value="95">
_ key
</constant>
<constant name="KEY_QUOTELEFT" value="96">
Left Quote Key
</constant>
<constant name="KEY_BRACELEFT" value="123">
{ key
</constant>
<constant name="KEY_BAR" value="124">
| key
</constant>
<constant name="KEY_BRACERIGHT" value="125">
} key
</constant>
<constant name="KEY_ASCIITILDE" value="126">
~ key
</constant>
<constant name="KEY_NOBREAKSPACE" value="160">
</constant>
<constant name="KEY_EXCLAMDOWN" value="161">
</constant>
<constant name="KEY_CENT" value="162">
¢ key
</constant>
<constant name="KEY_STERLING" value="163">
</constant>
<constant name="KEY_CURRENCY" value="164">
</constant>
<constant name="KEY_YEN" value="165">
Yen Key
</constant>
<constant name="KEY_BROKENBAR" value="166">
¦ key
</constant>
<constant name="KEY_SECTION" value="167">
§ key
</constant>
<constant name="KEY_DIAERESIS" value="168">
¨ key
</constant>
<constant name="KEY_COPYRIGHT" value="169">
© key
</constant>
<constant name="KEY_ORDFEMININE" value="170">
</constant>
<constant name="KEY_GUILLEMOTLEFT" value="171">
« key
</constant>
<constant name="KEY_NOTSIGN" value="172">
» key
</constant>
<constant name="KEY_HYPHEN" value="173">
key
</constant>
<constant name="KEY_REGISTERED" value="174">
® key
</constant>
<constant name="KEY_MACRON" value="175">
Macron Key
</constant>
<constant name="KEY_DEGREE" value="176">
° key
</constant>
<constant name="KEY_PLUSMINUS" value="177">
± key
</constant>
<constant name="KEY_TWOSUPERIOR" value="178">
² key
</constant>
<constant name="KEY_THREESUPERIOR" value="179">
³ key
</constant>
<constant name="KEY_ACUTE" value="180">
´ key
</constant>
<constant name="KEY_MU" value="181">
µ key
</constant>
<constant name="KEY_PARAGRAPH" value="182">
Paragraph Key
</constant>
<constant name="KEY_PERIODCENTERED" value="183">
· key
</constant>
<constant name="KEY_CEDILLA" value="184">
¬ key
</constant>
<constant name="KEY_ONESUPERIOR" value="185">
¹ key
</constant>
<constant name="KEY_MASCULINE" value="186">
♂ key
</constant>
<constant name="KEY_GUILLEMOTRIGHT" value="187">
» key
</constant>
<constant name="KEY_ONEQUARTER" value="188">
¼ key
</constant>
<constant name="KEY_ONEHALF" value="189">
½ key
</constant>
<constant name="KEY_THREEQUARTERS" value="190">
¾ key
</constant>
<constant name="KEY_QUESTIONDOWN" value="191">
¿ key
</constant>
<constant name="KEY_AGRAVE" value="192">
à key
</constant>
<constant name="KEY_AACUTE" value="193">
á key
</constant>
<constant name="KEY_ACIRCUMFLEX" value="194">
â key
</constant>
<constant name="KEY_ATILDE" value="195">
ã key
</constant>
<constant name="KEY_ADIAERESIS" value="196">
ä key
</constant>
<constant name="KEY_ARING" value="197">
å key
</constant>
<constant name="KEY_AE" value="198">
æ key
</constant>
<constant name="KEY_CCEDILLA" value="199">
ç key
</constant>
<constant name="KEY_EGRAVE" value="200">
è key
</constant>
<constant name="KEY_EACUTE" value="201">
é key
</constant>
<constant name="KEY_ECIRCUMFLEX" value="202">
ê key
</constant>
<constant name="KEY_EDIAERESIS" value="203">
ë key
</constant>
<constant name="KEY_IGRAVE" value="204">
ì key
</constant>
<constant name="KEY_IACUTE" value="205">
í key
</constant>
<constant name="KEY_ICIRCUMFLEX" value="206">
î key
</constant>
<constant name="KEY_IDIAERESIS" value="207">
ë key
</constant>
<constant name="KEY_ETH" value="208">
ð key
</constant>
<constant name="KEY_NTILDE" value="209">
ñ key
</constant>
<constant name="KEY_OGRAVE" value="210">
ò key
</constant>
<constant name="KEY_OACUTE" value="211">
ó key
</constant>
<constant name="KEY_OCIRCUMFLEX" value="212">
ô key
</constant>
<constant name="KEY_OTILDE" value="213">
õ key
</constant>
<constant name="KEY_ODIAERESIS" value="214">
ö key
</constant>
<constant name="KEY_MULTIPLY" value="215">
× key
</constant>
<constant name="KEY_OOBLIQUE" value="216">
ø key
</constant>
<constant name="KEY_UGRAVE" value="217">
ù key
</constant>
<constant name="KEY_UACUTE" value="218">
ú key
</constant>
<constant name="KEY_UCIRCUMFLEX" value="219">
û key
</constant>
<constant name="KEY_UDIAERESIS" value="220">
ü key
</constant>
<constant name="KEY_YACUTE" value="221">
ý key
</constant>
<constant name="KEY_THORN" value="222">
þ key
</constant>
<constant name="KEY_SSHARP" value="223">
ß key
</constant>
<constant name="KEY_DIVISION" value="247">
÷ key
</constant>
<constant name="KEY_YDIAERESIS" value="255">
ÿ key
</constant>
<constant name="KEY_CODE_MASK" value="33554431">
Key Code Mask
</constant>
<constant name="KEY_MODIFIER_MASK" value="-16777216">
Modifier Key Mask
</constant>
<constant name="KEY_MASK_SHIFT" value="33554432">
Shift Key Mask
</constant>
<constant name="KEY_MASK_ALT" value="67108864">
Alt Key Mask
</constant>
<constant name="KEY_MASK_META" value="134217728">
Meta Key Mask
</constant>
<constant name="KEY_MASK_CTRL" value="268435456">
CTRL Key Mask
</constant>
<constant name="KEY_MASK_CMD" value="268435456">
CMD Key Mask
</constant>
<constant name="KEY_MASK_KPAD" value="536870912">
Keypad Key Mask
</constant>
<constant name="KEY_MASK_GROUP_SWITCH" value="1073741824">
Group Switch Key Mask
</constant>
<constant name="BUTTON_LEFT" value="1">
Left Mouse Button
</constant>
<constant name="BUTTON_RIGHT" value="2">
Right Mouse Button
</constant>
<constant name="BUTTON_MIDDLE" value="3">
Middle Mouse Button
</constant>
<constant name="BUTTON_WHEEL_UP" value="4">
Mouse wheel up
</constant>
<constant name="BUTTON_WHEEL_DOWN" value="5">
Mouse wheel down
</constant>
<constant name="BUTTON_WHEEL_LEFT" value="6">
Mouse wheel left button
</constant>
<constant name="BUTTON_WHEEL_RIGHT" value="7">
Mouse wheel right button
</constant>
<constant name="BUTTON_MASK_LEFT" value="1">
Left Mouse Button Mask
</constant>
<constant name="BUTTON_MASK_RIGHT" value="2">
Right Mouse Button Mask
</constant>
<constant name="BUTTON_MASK_MIDDLE" value="4">
Middle Mouse Button Mask
</constant>
<constant name="JOY_BUTTON_0" value="0">
Joypad Button 0
</constant>
<constant name="JOY_BUTTON_1" value="1">
Joypad Button 1
</constant>
<constant name="JOY_BUTTON_2" value="2">
Joypad Button 2
</constant>
<constant name="JOY_BUTTON_3" value="3">
Joypad Button 3
</constant>
<constant name="JOY_BUTTON_4" value="4">
Joypad Button 4
</constant>
<constant name="JOY_BUTTON_5" value="5">
Joypad Button 5
</constant>
<constant name="JOY_BUTTON_6" value="6">
Joypad Button 6
</constant>
<constant name="JOY_BUTTON_7" value="7">
Joypad Button 7
</constant>
<constant name="JOY_BUTTON_8" value="8">
Joypad Button 8
</constant>
<constant name="JOY_BUTTON_9" value="9">
Joypad Button 9
</constant>
<constant name="JOY_BUTTON_10" value="10">
Joypad Button 10
</constant>
<constant name="JOY_BUTTON_11" value="11">
Joypad Button 11
</constant>
<constant name="JOY_BUTTON_12" value="12">
Joypad Button 12
</constant>
<constant name="JOY_BUTTON_13" value="13">
Joypad Button 13
</constant>
<constant name="JOY_BUTTON_14" value="14">
Joypad Button 14
</constant>
<constant name="JOY_BUTTON_15" value="15">
Joypad Button 15
</constant>
<constant name="JOY_BUTTON_MAX" value="16">
Joypad Button 16
</constant>
<constant name="JOY_SONY_CIRCLE" value="1">
DUALSHOCK circle button
</constant>
<constant name="JOY_SONY_X" value="0">
DUALSHOCK X button
</constant>
<constant name="JOY_SONY_SQUARE" value="2">
DUALSHOCK square button
</constant>
<constant name="JOY_SONY_TRIANGLE" value="3">
DUALSHOCK triangle button
</constant>
<constant name="JOY_XBOX_B" value="1">
XBOX controller B button
</constant>
<constant name="JOY_XBOX_A" value="0">
XBOX controller A button
</constant>
<constant name="JOY_XBOX_X" value="2">
XBOX controller X button
</constant>
<constant name="JOY_XBOX_Y" value="3">
XBOX controller Y button
</constant>
<constant name="JOY_DS_A" value="1">
DualShock controller A button
</constant>
<constant name="JOY_DS_B" value="0">
DualShock controller B button
</constant>
<constant name="JOY_DS_X" value="3">
DualShock controller X button
</constant>
<constant name="JOY_DS_Y" value="2">
DualShock controller Y button
</constant>
<constant name="JOY_SELECT" value="10">
Joypad Button Select
</constant>
<constant name="JOY_START" value="11">
Joypad Button Start
</constant>
<constant name="JOY_DPAD_UP" value="12">
Joypad DPad Up
</constant>
<constant name="JOY_DPAD_DOWN" value="13">
Joypad DPad Down
</constant>
<constant name="JOY_DPAD_LEFT" value="14">
Joypad DPad Left
</constant>
<constant name="JOY_DPAD_RIGHT" value="15">
Joypad DPad Right
</constant>
<constant name="JOY_L" value="4">
Joypad Left Shoulder Button
</constant>
<constant name="JOY_L2" value="6">
Joypad Left Trigger
</constant>
<constant name="JOY_L3" value="8">
Joypad Left Stick Click
</constant>
<constant name="JOY_R" value="5">
Joypad Right Shoulder Button
</constant>
<constant name="JOY_R2" value="7">
Joypad Right Trigger
</constant>
<constant name="JOY_R3" value="9">
Joypad Right Stick Click
</constant>
<constant name="JOY_AXIS_0" value="0">
Joypad Left Stick Horizontal Axis
</constant>
<constant name="JOY_AXIS_1" value="1">
Joypad Left Stick Vertical Axis
</constant>
<constant name="JOY_AXIS_2" value="2">
Joypad Right Stick Horizontal Axis
</constant>
<constant name="JOY_AXIS_3" value="3">
Joypad Right Stick Vertical Axis
</constant>
<constant name="JOY_AXIS_4" value="4">
</constant>
<constant name="JOY_AXIS_5" value="5">
</constant>
<constant name="JOY_AXIS_6" value="6">
Joypad Left Trigger Analog Axis
</constant>
<constant name="JOY_AXIS_7" value="7">
Joypad Right Trigger Analog Axis
</constant>
<constant name="JOY_AXIS_8" value="8">
</constant>
<constant name="JOY_AXIS_9" value="9">
</constant>
<constant name="JOY_AXIS_MAX" value="10">
</constant>
<constant name="JOY_ANALOG_LX" value="0">
Joypad Left Stick Horizontal Axis
</constant>
<constant name="JOY_ANALOG_LY" value="1">
Joypad Left Stick Vertical Axis
</constant>
<constant name="JOY_ANALOG_RX" value="2">
Joypad Right Stick Horizontal Axis
</constant>
<constant name="JOY_ANALOG_RY" value="3">
Joypad Right Stick Vertical Axis
</constant>
<constant name="JOY_ANALOG_L2" value="6">
Joypad Left Analog Trigger
</constant>
<constant name="JOY_ANALOG_R2" value="7">
Joypad Right Analog Trigger
</constant>
<constant name="OK" value="0">
Functions that return Error return OK when no error occured. Most functions don't return errors and/or just print errors to STDOUT.
</constant>
<constant name="FAILED" value="1">
Generic error.
</constant>
<constant name="ERR_UNAVAILABLE" value="2">
Unavailable error
</constant>
<constant name="ERR_UNCONFIGURED" value="3">
Unconfigured error
</constant>
<constant name="ERR_UNAUTHORIZED" value="4">
Unauthorized error
</constant>
<constant name="ERR_PARAMETER_RANGE_ERROR" value="5">
Parameter range error
</constant>
<constant name="ERR_OUT_OF_MEMORY" value="6">
Out of memory (OOM) error
</constant>
<constant name="ERR_FILE_NOT_FOUND" value="7">
File: Not found error
</constant>
<constant name="ERR_FILE_BAD_DRIVE" value="8">
File: Bad drive error
</constant>
<constant name="ERR_FILE_BAD_PATH" value="9">
File: Bad path error
</constant>
<constant name="ERR_FILE_NO_PERMISSION" value="10">
File: No permission error
</constant>
<constant name="ERR_FILE_ALREADY_IN_USE" value="11">
File: Already in use error
</constant>
<constant name="ERR_FILE_CANT_OPEN" value="12">
File: Can't open error
</constant>
<constant name="ERR_FILE_CANT_WRITE" value="13">
File: Can't write error
</constant>
<constant name="ERR_FILE_CANT_READ" value="14">
File: Can't read error
</constant>
<constant name="ERR_FILE_UNRECOGNIZED" value="15">
File: Unrecognized error
</constant>
<constant name="ERR_FILE_CORRUPT" value="16">
File: Corrupt error
</constant>
<constant name="ERR_FILE_MISSING_DEPENDENCIES" value="17">
File: Missing dependencies error
</constant>
<constant name="ERR_FILE_EOF" value="18">
File: End of file (EOF) error
</constant>
<constant name="ERR_CANT_OPEN" value="19">
Can't open error
</constant>
<constant name="ERR_CANT_CREATE" value="20">
Can't create error
</constant>
<constant name="ERR_PARSE_ERROR" value="43">
Parse error
</constant>
<constant name="ERR_QUERY_FAILED" value="21">
Query failed error
</constant>
<constant name="ERR_ALREADY_IN_USE" value="22">
Already in use error
</constant>
<constant name="ERR_LOCKED" value="23">
Locked error
</constant>
<constant name="ERR_TIMEOUT" value="24">
Timeout error
</constant>
<constant name="ERR_CANT_ACQUIRE_RESOURCE" value="28">
Can't acquire resource error
</constant>
<constant name="ERR_INVALID_DATA" value="30">
Invalid data error
</constant>
<constant name="ERR_INVALID_PARAMETER" value="31">
Invalid parameter error
</constant>
<constant name="ERR_ALREADY_EXISTS" value="32">
Already exists error
</constant>
<constant name="ERR_DOES_NOT_EXIST" value="33">
Does not exist error
</constant>
<constant name="ERR_DATABASE_CANT_READ" value="34">
Database: Read error
</constant>
<constant name="ERR_DATABASE_CANT_WRITE" value="35">
Database: Write error
</constant>
<constant name="ERR_COMPILATION_FAILED" value="36">
Compilation failed error
</constant>
<constant name="ERR_METHOD_NOT_FOUND" value="37">
Method not found error
</constant>
<constant name="ERR_LINK_FAILED" value="38">
Linking failed error
</constant>
<constant name="ERR_SCRIPT_FAILED" value="39">
Script failed error
</constant>
<constant name="ERR_CYCLIC_LINK" value="40">
Cycling link (import cycle) error
</constant>
<constant name="ERR_BUSY" value="44">
Busy error
</constant>
<constant name="ERR_HELP" value="46">
Help error
</constant>
<constant name="ERR_BUG" value="47">
Bug error
</constant>
<constant name="ERR_WTF" value="49">
WTF error (something probably went really wrong)
</constant>
<constant name="PROPERTY_HINT_NONE" value="0">
No hint for edited property.
</constant>
<constant name="PROPERTY_HINT_RANGE" value="1">
Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
</constant>
<constant name="PROPERTY_HINT_EXP_RANGE" value="2">
Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
</constant>
<constant name="PROPERTY_HINT_ENUM" value="3">
Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
</constant>
<constant name="PROPERTY_HINT_EXP_EASING" value="4">
</constant>
<constant name="PROPERTY_HINT_LENGTH" value="5">
</constant>
<constant name="PROPERTY_HINT_KEY_ACCEL" value="7">
</constant>
<constant name="PROPERTY_HINT_FLAGS" value="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.
</constant>
<constant name="PROPERTY_HINT_LAYERS_2D_RENDER" value="9">
</constant>
<constant name="PROPERTY_HINT_LAYERS_2D_PHYSICS" value="10">
</constant>
<constant name="PROPERTY_HINT_LAYERS_3D_RENDER" value="11">
</constant>
<constant name="PROPERTY_HINT_LAYERS_3D_PHYSICS" value="12">
</constant>
<constant name="PROPERTY_HINT_FILE" value="13">
String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc".
</constant>
<constant name="PROPERTY_HINT_DIR" value="14">
String property is a directory (so pop up a file dialog when edited).
</constant>
<constant name="PROPERTY_HINT_GLOBAL_FILE" value="15">
</constant>
<constant name="PROPERTY_HINT_GLOBAL_DIR" value="16">
</constant>
<constant name="PROPERTY_HINT_RESOURCE_TYPE" value="17">
String property is a resource, so open the resource popup menu when edited.
</constant>
<constant name="PROPERTY_HINT_MULTILINE_TEXT" value="18">
</constant>
<constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="19">
</constant>
<constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="20">
Hints that the image is compressed using lossy compression.
</constant>
<constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="21">
Hints that the image is compressed using lossless compression.
</constant>
<constant name="PROPERTY_USAGE_STORAGE" value="1">
Property will be used as storage (default).
</constant>
<constant name="PROPERTY_USAGE_EDITOR" value="2">
Property will be visible in editor (default).
</constant>
<constant name="PROPERTY_USAGE_NETWORK" value="4">
</constant>
<constant name="PROPERTY_USAGE_EDITOR_HELPER" value="8">
</constant>
<constant name="PROPERTY_USAGE_CHECKABLE" value="16">
</constant>
<constant name="PROPERTY_USAGE_CHECKED" value="32">
</constant>
<constant name="PROPERTY_USAGE_INTERNATIONALIZED" value="64">
</constant>
<constant name="PROPERTY_USAGE_GROUP" value="128">
</constant>
<constant name="PROPERTY_USAGE_CATEGORY" value="256">
</constant>
<constant name="PROPERTY_USAGE_STORE_IF_NONZERO" value="512">
</constant>
<constant name="PROPERTY_USAGE_STORE_IF_NONONE" value="1024">
</constant>
<constant name="PROPERTY_USAGE_NO_INSTANCE_STATE" value="2048">
</constant>
<constant name="PROPERTY_USAGE_RESTART_IF_CHANGED" value="4096">
</constant>
<constant name="PROPERTY_USAGE_SCRIPT_VARIABLE" value="8192">
</constant>
<constant name="PROPERTY_USAGE_DEFAULT" value="7">
Default usage (storage and editor).
</constant>
<constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71">
</constant>
<constant name="PROPERTY_USAGE_NOEDITOR" value="5">
</constant>
<constant name="METHOD_FLAG_NORMAL" value="1">
Flag for normal method
</constant>
<constant name="METHOD_FLAG_EDITOR" value="2">
Flag for editor method
</constant>
<constant name="METHOD_FLAG_NOSCRIPT" value="4">
</constant>
<constant name="METHOD_FLAG_CONST" value="8">
Flag for constant method
</constant>
<constant name="METHOD_FLAG_REVERSE" value="16">
</constant>
<constant name="METHOD_FLAG_VIRTUAL" value="32">
Flag for virtual method
</constant>
<constant name="METHOD_FLAG_FROM_SCRIPT" value="64">
Flag for method from script
</constant>
<constant name="METHOD_FLAGS_DEFAULT" value="1">
Default method flags
</constant>
<constant name="TYPE_NIL" value="0">
Variable is of type nil (only applied for null).
</constant>
<constant name="TYPE_BOOL" value="1">
Variable is of type [bool].
</constant>
<constant name="TYPE_INT" value="2">
Variable is of type [int].
</constant>
<constant name="TYPE_REAL" value="3">
Variable is of type [float]/real.
</constant>
<constant name="TYPE_STRING" value="4">
Variable is of type [String].
</constant>
<constant name="TYPE_VECTOR2" value="5">
Variable is of type [Vector2].
</constant>
<constant name="TYPE_RECT2" value="6">
Variable is of type [Rect2].
</constant>
<constant name="TYPE_VECTOR3" value="7">
Variable is of type [Vector3].
</constant>
<constant name="TYPE_TRANSFORM2D" value="8">
Variable is of type [Transform2D].
</constant>
<constant name="TYPE_PLANE" value="9">
Variable is of type [Plane].
</constant>
<constant name="TYPE_QUAT" value="10">
Variable is of type [Quat].
</constant>
<constant name="TYPE_RECT3" value="11">
Variable is of type [Rect3].
</constant>
<constant name="TYPE_BASIS" value="12">
Variable is of type [Basis].
</constant>
<constant name="TYPE_TRANSFORM" value="13">
Variable is of type [Transform].
</constant>
<constant name="TYPE_COLOR" value="14">
Variable is of type [Color].
</constant>
<constant name="TYPE_NODE_PATH" value="15">
Variable is of type [NodePath].
</constant>
<constant name="TYPE_RID" value="16">
Variable is of type [RID].
</constant>
<constant name="TYPE_OBJECT" value="17">
Variable is of type [Object].
</constant>
<constant name="TYPE_DICTIONARY" value="18">
Variable is of type [Dictionary].
</constant>
<constant name="TYPE_ARRAY" value="19">
Variable is of type [Array].
</constant>
<constant name="TYPE_RAW_ARRAY" value="20">
Variable is of type [PoolByteArray].
</constant>
<constant name="TYPE_INT_ARRAY" value="21">
Variable is of type [PoolIntArray].
</constant>
<constant name="TYPE_REAL_ARRAY" value="22">
Variable is of type [PoolRealArray].
</constant>
<constant name="TYPE_STRING_ARRAY" value="23">
Variable is of type [PoolStringArray].
</constant>
<constant name="TYPE_VECTOR2_ARRAY" value="24">
Variable is of type [PoolVector2Array].
</constant>
<constant name="TYPE_VECTOR3_ARRAY" value="25">
Variable is of type [PoolVector3Array].
</constant>
<constant name="TYPE_COLOR_ARRAY" value="26">
Variable is of type [PoolColorArray].
</constant>
<constant name="TYPE_MAX" value="27">
Marker for end of type constants.
</constant>
</constants>
</class>