Global scope constants and variables.
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.
- [ARVRServer] singleton
- [AudioServer] singleton
- [ClassDB] singleton
- [Engine] singleton
- [Geometry] singleton
- [IP] singleton
- [Input] singleton
- [InputMap] singleton
- [JSON] singleton
- [JavaScript] singleton
- [Marshalls] singleton
- [OS] singleton
- [Performance] singleton
- [Physics2DServer] singleton
- [PhysicsServer] singleton
- [ProjectSettings] singleton
- [ResourceLoader] singleton
- [ResourceSaver] singleton
- [TranslationServer] singleton
- [VisualScriptEditor] singleton
- [VisualServer] singleton
Left margin, used usually for [Control] or [StyleBox] derived classes.
Top margin, used usually for [Control] or [StyleBox] derived classes.
Right margin, used usually for [Control] or [StyleBox] derived classes.
Bottom margin, used usually for [Control] or [StyleBox] derived classes.
General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
Horizontal left alignment, usually for text-derived classes.
Horizontal center alignment, usually for text-derived classes.
Horizontal right alignment, usually for text-derived classes.
Vertical top alignment, usually for text-derived classes.
Vertical center alignment, usually for text-derived classes.
Vertical bottom alignment, usually for text-derived classes.
Scancodes with this bit applied are non printable.
Escape Key
Tab Key
Shift-Tab Key
Backspace Key
Return Key (On Main Keyboard)
Enter Key (On Numpad)
Insert Key
Delete Key
Pause Key
Printscreen Key
System Request Key
Clear Key
Home Key
End Key
Left Arrow Key
Up Arrow Key
Right Arrow Key
Down Arrow Key
Pageup Key
Pagedown Key
Shift Key
Control Key
Meta Key
Alt Key
Capslock Key
Numlock Key
Scrolllock Key
F1 Key
F2 Key
F3 Key
F4 Key
F5 Key
F6 Key
F7 Key
F8 Key
F9 Key
F10 Key
F11 Key
F12 Key
F13 Key
F14 Key
F15 Key
F16 Key
Multiply Key on Numpad
Divide Key on Numpad
Subtract Key on Numpad
Period Key on Numpad
Add Key on Numpad
Number 0 on Numpad
Number 1 on Numpad
Number 2 on Numpad
Number 3 on Numpad
Number 4 on Numpad
Number 5 on Numpad
Number 6 on Numpad
Number 7 on Numpad
Number 8 on Numpad
Number 9 on Numpad
Left Super Key (Windows Key)
Right Super Key (Windows Key)
Context menu key
Left Hyper Key
Right Hyper Key
Help key
Left Direction Key
Right Direction Key
Back key
Forward key
Stop key
Refresh key
Volume down key
Mute volume key
Volume up key
Bass Boost Key
Bass Up Key
Bass Down Key
Treble Up Key
Treble Down Key
Media play key
Media stop key
Previous song key
Next song key
Media record key
Home page key
Favorites key
Search key
Standby Key
Open URL / Launch Browser Key
Launch Mail Key
Launch Media Key
Launch Shortcut 0 Key
Launch Shortcut 1 Key
Launch Shortcut 2 Key
Launch Shortcut 3 Key
Launch Shortcut 4 Key
Launch Shortcut 5 Key
Launch Shortcut 6 Key
Launch Shortcut 7 Key
Launch Shortcut 8 Key
Launch Shortcut 9 Key
Launch Shortcut A Key
Launch Shortcut B Key
Launch Shortcut C Key
Launch Shortcut D Key
Launch Shortcut E Key
Launch Shortcut F Key
Unknown Key
Space Key
! key
" key
# key
$ key
% key
& key
' key
( key
) key
* key
+ key
, key
- key
. key
/ key
Number 0
Number 1
Number 2
Number 3
Number 4
Number 5
Number 6
Number 7
Number 8
Number 9
: key
; key
Lower than key
= key
Greater than key
? key
@ key
A Key
B Key
C Key
D Key
E Key
F Key
G Key
H Key
I Key
J Key
K Key
L Key
M Key
N Key
O Key
P Key
Q Key
R Key
S Key
T Key
U Key
V Key
W Key
X Key
Y Key
Z Key
[ key
\ key
] key
^ key
_ key
` key.
{ key
| key
} key
~ key
¢ key
¤ key.
¥ key.
¦ key
§ key
¨ key
© key
ª key.
« key
¬ key.
Soft hyphen key.
® key
¯ key.
° key
± key
² key
³ key
´ key
µ key
¶ key.
· key
¸ key.
¹ key
º key.
» key
¼ key
½ key
¾ key
¿ key
À key.
Á key.
Â key.
Ã key.
Ä key.
Å key.
Æ key.
Ç key.
È key.
É key.
Ê key.
Ë key.
Ì key.
Í key.
Î key.
Ï key.
Ð key.
Ñ key.
Ò key.
Ó key.
Ô key.
Õ key.
Ö key.
× key
Ø key.
Ù key.
Ú key.
Û key.
Ü key.
Ý key.
Þ key.
ß key
÷ key
ÿ key
Key Code Mask
Modifier Key Mask
Shift Key Mask
Alt Key Mask
Meta Key Mask
CTRL Key Mask
CMD Key Mask
Keypad Key Mask
Group Switch Key Mask
Left Mouse Button
Right Mouse Button
Middle Mouse Button
Extra Mouse Button 1
Extra Mouse Button 2
Mouse wheel up
Mouse wheel down
Mouse wheel left button
Mouse wheel right button
Left Mouse Button Mask
Right Mouse Button Mask
Middle Mouse Button Mask
Extra Mouse Button 1 Mask
Extra Mouse Button 2 Mask
Joypad Button 0
Joypad Button 1
Joypad Button 2
Joypad Button 3
Joypad Button 4
Joypad Button 5
Joypad Button 6
Joypad Button 7
Joypad Button 8
Joypad Button 9
Joypad Button 10
Joypad Button 11
Joypad Button 12
Joypad Button 13
Joypad Button 14
Joypad Button 15
Represents the maximum number of joystick buttons supported.
DUALSHOCK circle button
DUALSHOCK X button
DUALSHOCK square button
DUALSHOCK triangle button
XBOX controller B button
XBOX controller A button
XBOX controller X button
XBOX controller Y button
Nintendo controller A button.
Nintendo controller B button.
Nintendo controller X button.
Nintendo controller Y button.
Joypad Button Select
Joypad Button Start
Joypad DPad Up
Joypad DPad Down
Joypad DPad Left
Joypad DPad Right
Joypad Left Shoulder Button
Joypad Left Trigger
Joypad Left Stick Click
Joypad Right Shoulder Button
Joypad Right Trigger
Joypad Right Stick Click
Joypad Left Stick Horizontal Axis
Joypad Left Stick Vertical Axis
Joypad Right Stick Horizontal Axis
Joypad Right Stick Vertical Axis
Generic gamepad axis 4.
Generic gamepad axis 5.
Joypad Left Trigger Analog Axis
Joypad Right Trigger Analog Axis
Generic gamepad axis 8.
Generic gamepad axis 9.
Represents the maximum number of joystick axes supported.
Joypad Left Stick Horizontal Axis
Joypad Left Stick Vertical Axis
Joypad Right Stick Horizontal Axis
Joypad Right Stick Vertical Axis
Joypad Left Analog Trigger
Joypad Right Analog Trigger
MIDI note OFF message.
MIDI note ON message.
MIDI aftertouch message.
MIDI control change message.
MIDI program change message.
MIDI channel pressure message.
MIDI pitch bend message.
Methods that return [enum Error] return [constant OK] when no error occurred. Note that many functions don't return an error code but will print error messages to stdout. Since [constant OK] has value 0, and all other failure codes are positive integers, it can also be used in boolean checks, e.g.: [codeblock] var err = method_that_returns_error() if (err != OK): print("Failure!) # Or, equivalent: if (err): print("Still failing!) [/codeblock]
Generic error.
Unavailable error.
Unconfigured error.
Unauthorized error.
Parameter range error.
Out of memory (OOM) error.
File: Not found error.
File: Bad drive error.
File: Bad path error.
File: No permission error.
File: Already in use error.
File: Can't open error.
File: Can't write error.
File: Can't read error.
File: Unrecognized error.
File: Corrupt error.
File: Missing dependencies error.
File: End of file (EOF) error.
Can't open error.
Can't create error.
Query failed error.
Already in use error.
Locked error.
Timeout error.
Can't connect error.
Can't resolve error.
Connection error.
Can't acquire resource error.
Can't fork process error.
Invalid data error.
Invalid parameter error.
Already exists error.
Does not exist error.
Database: Read error.
Database: Write error.
Compilation failed error.
Method not found error.
Linking failed error.
Script failed error.
Cycling link (import cycle) error.
Invalid declaration error.
Duplicate symbol error.
Parse error.
Busy error.
Skip error.
Help error.
Bug error.
Printer on fire error. (This is an easter egg, no engine methods return this error code.)
No hint for edited property.
Hints that an integer or float property should be within a range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"or_greater"[/code] and/or [code]"or_lesser"[/code] to allow manual input going respectively above the max or below the min values. Example: [code]"-360,360,1,or_greater,or_lesser"[/code].
Hints that an integer or float property should be within an exponential range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"or_greater"[/code] and/or [code]"or_lesser"[/code] to allow manual input going respectively above the max or below the min values. Example: [code]"0.01,100,0.01,or_greater"[/code].
Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string such as [code]"Hello,Something,Else"[/code].
Hints that a float property should be edited via an exponential easing function. The hint string can include [code]"attenuation"[/code] to flip the curve horizontally and/or [code]"inout"[/code] to also include in/out easing.
Deprecated hint, unused.
Deprecated hint, unused.
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 [code]"Bit0,Bit1,Bit2,,Bit4"[/code].
Hints that an integer property is a bitmask using the optionally named 2D render layers.
Hints that an integer property is a bitmask using the optionally named 2D physics layers.
Hints that an integer property is a bitmask using the optionally named 3D render layers.
Hints that an integer property is a bitmask using the optionally named 3D physics layers.
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 [code]"*.png,*.jpg"[/code].
Hints that a string property is a path to a directory. Editing it will show a file dialog for picking the path.
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 [code]"*.png,*.jpg"[/code].
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.
Hints that a property is an instance of a [Resource]-derived type, optionally specified via the hint string (e.g. [code]"Texture"[/code]). Editing it will show a popup menu of valid resource types to instantiate.
Hints that a string property is text with line breaks. Editing it will show a text input field where line breaks can be typed.
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.
Hints that a color property should be edited without changing its alpha component, i.e. only R, G and B channels are edited.
Hints that an image is compressed using lossy compression.
Hints that an image is compressed using lossless compression.
The property is serialized and saved in the scene file (default).
The property is shown in the editor inspector (default).
Deprecated usage flag, unused.
Deprecated usage flag, unused.
The property can be checked in the editor inspector.
The property is checked in the editor inspector.
The property is a translatable string.
Used to group properties together in the editor.
Used to categorize properties together in the editor.
The property does not save its state in [PackedScene].
Editing the property prompts the user for restarting the editor.
The property is a script variable which should be serialized and saved in the scene file.
Default usage (storage, editor and network).
Default usage for translatable strings (storage, editor, network and internationalized).
Default usage but without showing the property in the editor (storage, network).
Flag for normal method
Flag for editor method
Deprecated method flag, unused.
Flag for constant method
Deprecated method flag, unused.
Flag for virtual method
Deprecated method flag, unused.
Default method flags
Variable is of type [Nil] (only applied for [code]null[/code]).
Variable is of type [bool].
Variable is of type [int].
Variable is of type [float] (real).
Variable is of type [String].
Variable is of type [Vector2].
Variable is of type [Rect2].
Variable is of type [Vector3].
Variable is of type [Transform2D].
Variable is of type [Plane].
Variable is of type [Quat].
Variable is of type [AABB].
Variable is of type [Basis].
Variable is of type [Transform].
Variable is of type [Color].
Variable is of type [NodePath].
Variable is of type [RID].
Variable is of type [Object].
Variable is of type [Dictionary].
Variable is of type [Array].
Variable is of type [PoolByteArray].
Variable is of type [PoolIntArray].
Variable is of type [PoolRealArray].
Variable is of type [PoolStringArray].
Variable is of type [PoolVector2Array].
Variable is of type [PoolVector3Array].
Variable is of type [PoolColorArray].
Represents the size of the [enum Variant.Type] enum.
Equality operator ([code]==[/code]).
Inequality operator ([code]!=[/code]).
Less than operator ([code]<[/code]).
Less than or equal operator ([code]<=[/code]).
Greater than operator ([code]>[/code]).
Greater than or equal operator ([code]>=[/code]).
Addition operator ([code]+[/code]).
Subtraction operator ([code]-[/code]).
Multiplication operator ([code]*[/code]).
Division operator ([code]/[/code]).
Unary negation operator ([code]-[/code]).
Unary plus operator ([code]+[/code]).
Remainder/modulo operator ([code]%[/code]).
String concatenation operator ([code]+[/code]).
Left shift operator ([code]<<[/code]).
Right shift operator ([code]>>[/code]).
Bitwise AND operator ([code]&[/code]).
Bitwise OR operator ([code]|[/code]).
Bitwise XOR operator ([code]^[/code]).
Bitwise NOT operator ([code]~[/code]).
Logical AND operator ([code]and[/code] or [code]&&[/code]).
Logical OR operator ([code]or[/code] or [code]||[/code]).
Logical XOR operator (not implemented in GDScript).
Logical NOT operator ([code]not[/code] or [code]![/code]).
Logical IN operator ([code]in[/code]).
Represents the size of the [enum Variant.Operator] enum.