Built-in GDScript functions.
This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects.
Make a color from red, green, blue and alpha. Arguments can range from 0 to 255.
Remove sign (works for integer and float).
Arc-cosine.
Arc-sine.
Assert that the condition is true. If the condition is false, generates an error.
Arc-tangent.
Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range.
Decode a byte array back to a value.
Ceiling (rounds up to nearest integer).
Clamp both values to a range.
Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in [@Global Scope].
Standard cosine function.
Hyperbolic cosine.
Convert from decibels to linear energy (audio).
Return the amount of decimals in the floating point value.
Decreases time by a specified amount.
Convert from degrees to radians.
Convert a previously converted instances to dictionary back into an instance. Useful for deserializing.
Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in.
Exponential logarithm.
Floor (rounds down to nearest integer).
Module (remainder of x/y).
Module (remainder of x/y) that wraps equally in positive and negative.
Return a reference to the specified function.
Hash the variable passed and return an integer.
Convert a script class instance to a dictionary (useful for serializing).
Get an object by its ID.
Linear interpolates between two values by a normalized value.
Convert from linear energy to decibels (audio).
Load a resource from the filesystem, pass a valid path as argument.
Natural logarithm.
Return the maximum of two values.
Return the minimum of two values.
Return the nearest larger power of 2 for an integer.
Power function, x elevate to y.
Preload a resource from the filesystem. The resource is loaded during script parsing.
Print one or more arguments to strings in the best way possible to a console line.
Print a stack track at code location, only works when running with debugger turned on.
Print one or more arguments to strings in the best way possible to standard error line.
Print one or more arguments to strings in the best way possible to console. No newline is added at the end.
Print one or more arguments to the console with a space between each argument.
Print one or more arguments to the console with a tab between each argument.
Convert from radians to degrees.
Random range, any floating point value between 'from' and 'to'
Random from seed, pass a seed and an array with both number and new seed is returned.
Random value (0 to 1 float).
Random 32 bits value (integer). To obtain a value from 0 to N, you can use remainder, like (for random from 0 to 19): randi() % 20.
Reset the seed of the random number generator with a new, different one.
Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment).
Round to nearest integer.
Set seed for the random number generator.
Return sign (-1 or +1).
Standard sine function.
Hyperbolic sine.
Square root.
Snap float value to a given step.
Convert one or more arguments to strings in the best way possible.
Convert a formatted string that was returned by [method var2str] to the original value.
Standard tangent function.
Hyperbolic tangent.
Return the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope].
Encode a variable value to a byte array.
Convert a value to a formatted string that can later be parsed using [method str2var].
Return a weak reference to an object.
Stop the function execution and return the current state. Call [method GDFunctionState.resume] on the state to resume execution. This invalidates the state. Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emmited.
Constant that represents how many times the diameter of a circumference fits around it's perimeter.
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.
- [AudioServer] singleton
- [AudioServer] singleton
- [Geometry] singleton
- [Globals] singleton
- [IP] singleton
- [Input] singleton
- [InputMap] singleton
- [Marshalls] singleton
- [OS] singleton
- [PhysicsServer] singleton
- [Physics2DServer] singleton
- [PathRemap] singleton
- [Performance] singleton
- [Physics2DServer] singleton
- [PhysicsServer] singleton
- [ResourceLoader] singleton
- [ResourceSaver] singleton
- [SpatialSoundServer] singleton
- [SpatialSound2DServer] singleton
- [SpatialSound2DServer] singleton
- [SpatialSoundServer] singleton
- [TranslationServer] singleton
- [TranslationServer] singleton
- [VisualServer] 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
Home Key
End Key
Left Arrow Key
Up Arrow Key
Right Arrow Key
Down Arrow Key
Pageup Key
Pagedown Key
Shift Key
Control 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
Enter Key on Numpad
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
Super Left key (windows key)
Super Left key (windows key)
Context menu key
Help key
Back key
Forward key
Stop key
Refresh key
Volume down key
Mute volume key
Volume up key
Media play key
Media stop key
Previous song key
Next song key
Media record key
Home page key
Favorites key
Search 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
² key
³ key
´ key
µ key
· key
¬ key
½ key
Left Mouse Button
Right Mouse Button
Middle Mouse Button
Mouse wheel up
Mouse wheel down
Mouse wheel left button
Mouse wheel right button
Joystick Button 0
Joystick Button 1
Joystick Button 2
Joystick Button 3
Joystick Button 4
Joystick Button 5
Joystick Button 6
Joystick Button 7
Joystick Button 8
Joystick Button 9
Joystick Button 10
Joystick Button 11
Joystick Button 12
Joystick Button 13
Joystick Button 14
Joystick Button 15
Joystick Button 16
Super Nintendo Entertaiment System controller A button
Super Nintendo Entertaiment System controller B button
Super Nintendo Entertaiment System controller X button
Super Nintendo Entertaiment System controller Y button
DUALSHOCK circle button
DUALSHOCK X button
DUALSHOCK square button
DUALSHOCK triangle button
SEGA controller B button
SEGA controller A button
SEGA controller X button
SEGA controller Y button
XBOX controller B button
XBOX controller A button
XBOX controller X button
XBOX controller Y button
Joystick Button Select
Joystick Button Start
Joystick DPad Up
Joystick DPad Down
Joystick DPad Left
Joystick DPad Right
Joystick Left Shoulder Button
Joystick Left Trigger
Joystick Left Stick Click
Joystick Right Shoulder Button
Joystick Right Trigger
Joystick Right Stick Click
Joystick Left Stick Horizontal Axis
Joystick Left Stick Vertical Axis
Joystick Right Stick Horizontal Axis
Joystick Right Stick Vertical Axis
Joystick Left Trigger Analog Axis
Joystick Right Trigger Analog Axis
Joystick Left Stick Horizontal Axis
Joystick Left Stick Vertical Axis
Joystick Right Stick Horizontal Axis
Joystick Right Stick Vertical Axis
Functions that return Error return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout.
Generic fail return error.
No hint for edited property.
Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
Property hint for a bitmask description that covers all 32 bits. Valid only for integers.
String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc".
String property is a directory (so pop up a file dialog when edited).
String property is a resource, so open the resource popup menu when edited.
Property will be used as storage (default).
Property will be visible in editor (default).
Default usage (storage and editor).
Variable is of type nil (only applied for null).
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 [Matrix32].
Variable is of type [Plane].
Variable is of type [Quat].
Variable is of type [AABB].
Variable is of type [Matrix3].
Variable is of type [Transform].
Variable is of type [Color].
Variable is of type [Image].
Variable is of type [NodePath].
Variable is of type [RID].
Variable is of type [Object].
Variable is of type [InputEvent].
Variable is of type [Dictionary].
Variable is of type [Array].
Axis-Aligned Bounding Box.
AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests.
Optional constructor, accepts position and size.
Return true if this [AABB] completely encloses another one.
Return this [AABB] expanded to include a given point.
Get the area of the [AABB].
Get the position of the 8 endpoints of the [AABB] in space.
Return the normalized longest axis of the [AABB].
Return the index of the longest axis of the [AABB] (according to [Vector3]::AXIS* enum).
Return the scalar length of the longest axis of the [AABB].
Return the normalized shortest axis of the [AABB].
Return the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum).
Return the scalar length of the shortest axis of the [AABB].
Return the support point in a given direction. This is useful for collision detection algorithms.
Return a copy of the [AABB] grown a given amount of units towards all the sides.
Return true if the [AABB] is flat or empty.
Return true if the [AABB] is empty.
Return true if the [AABB] contains a point.
Return the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure.
Return true if the [AABB] overlaps with another.
Return true if the [AABB] is at both sides of a plane.
Return true if the [AABB] intersects the line segment between from and to
Combine this [AABB] with another, a larger one is returned that contains both.
- Ending corner.
- Position (starting corner).
- Size from position to end.
Base dialog for user notification.
This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result.
Add custom button to the dialog and return the created button. The button titled with [i]text[/i] and the [i]action[/i] will be passed to [custom_action] signal when it is pressed.
Add custom cancel button to the dialog and return the created button.
Return true if the dialog will be hidden when accepted (default true).
Return the label used for built-in text.
Return the OK Button.
Return the built-in label text.
Register a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
Set whether the dialog is hidden when accepted (default true).
Set the built-in label text.
Emitted when accepted.
Emitted with a custom button is added.
Sprite node that can use multiple textures for animation.
Sprite node that can use multiple textures for animation.
Return the name of the current animation set to the node.
Return the visible frame index.
Return the color modulation for this sprite.
Return the offset of the sprite in the node origin.
Get the [SpriteFrames] resource, which contains all frames.
Return true when centered. See [method set_centered].
Return true if sprite is flipped horizontally.
Return true if sprite is flipped vertically.
Return true if an animation if currently being played.
Play the animation set in parameter. If no parameter is provided, the current animation is played.
Set the current animation of the node and reinits the frame counter of the animation.
When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is.
If true, sprite is flipped horizontally.
If true, sprite is flipped vertically.
Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource).
Change the color modulation (multiplication) for this sprite.
Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not.
Set the [SpriteFrames] resource, which contains all frames.
Stop the current animation (does not reset the frame counter).
Emitted when frame is changed.
Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted everytime the last frame is drawn, before looping.
Return the name of the current animation set to the node.
Return the visible frame index.
Get the [SpriteFrames] resource, which contains all frames.
Return true if an animation if currently being played.
Play the animation set in parameter. If no parameter is provided, the current animation is played.
Set the current animation of the node and reinits the frame counter of the animation.
Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource).
Set the [SpriteFrames] resource, which contains all frames.
Stop the current animation (does not reset the frame counter).
Emitted when frame is changed.
Contains data used to animate everything in the engine.
An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. Animations are just data containers, and must be added to odes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back.
Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration.
Clear the animation (clear all tracks and reset all).
Return the index of the specified track. If the track is not found, return -1.
Return the total length of the animation (in seconds).
Get the animation step value.
Return the amount of tracks in the animation.
Return whether the animation has the loop flag set.
Return all the key indices of a method track, given a position and delta time.
Return the method name of a method track.
Return the arguments values to be called on a method track for a given key in a given track.
Remove a track by specifying the track index.
Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
Set the animation step value.
Find the key index by time in a given track. Optionally, only find it if the exact time is given.
Return the interpolation type of a given track, from the INTERPOLATION_* enum.
Return the amount of keys in a given track.
Return the time at which the key is located.
Return the transition curve (easing) for a specific key (see built-in math function "ease").
Return the value of a given key in a given track.
Get the path of a track. for more information on the path format, see [method track_set_path]
Get the type of a track.
Insert a generic key in a given track.
Return true if the given track is imported. Else, return false.
Move a track down.
Move a track up.
Remove a key by index in a given track.
Remove a key by position (seconds) in a given track.
Set the given track as imported or not.
Set the interpolation type of a given track, from the INTERPOLATION_* enum.
Set the transition curve (easing) for a specific key (see built-in math function "ease").
Set the value of an existing key.
Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local"
Insert a transform key for a transform track.
Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]).
Return all the key indices of a value track, given a position and delta time.
Value tracks set values in node properties, but only those which can be Interpolated.
Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated.
Method tracks call functions with given arguments per key.
No interpolation (nearest value).
Linear interpolation.
Cubic interpolation.
Container and player of [Animation] resources.
An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels.
Add an animation resource to the player, which will be later referenced by the "name" argument.
Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip.
The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again.
If animations are queued to play, clear them.
Find an animation name by resource.
Get an [Animation] resource by requesting a name.
Get the list of names of the animations stored in the player.
Return the mode in which the animation player processes. See [method set_animation_process_mode].
Return the name of the animation that will be automatically played when the scene is loaded.
Get the blend time between two animations, referenced by their names.
Return the name of the animation being played.
Get the length (in seconds) of the currently being played animation.
Get the position (in seconds) of the currently being played animation.
Return the default blend time between animations.
Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided).
Return path to root node (see [method set_root]).
Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling).
Request whether an [Animation] name exist within the player.
Return true if the player is active.
Return whether an animation is playing.
Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards.
Play a given animation by the animation name in reverse.
Queue an animation for playback once the current one is done.
Remove an animation from the player (by supplying the same name used to add it).
Rename an existing animation.
Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time.
Set the player as active (playing). If false, it will do nothing.
Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*.
Set the name of the animation that will be automatically played when the scene is loaded.
Specify a blend time (in seconds) between two animations, referenced by their names.
Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
Set the default blend time between animations.
AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed.
Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling).
Stop the currently playing animation.
Stop playback of animations (deprecated).
If the currently being played animation changes, this signal will notify of such change.
Notifies when an animation starts playing.
Notifies when an animation finished playing.
Process animation on fixed process. This is specially useful when animating kinematic bodies.
Process animation on idle process.
Animation Player that uses a node graph for the blending.
Animation Player that uses a node graph for the blending. This kind of player is very useful when animating character or other skeleton based rigs, because it can combine several animations to form a desired pose.
Add a node of a given type in the graph with given id.
Set the animation for an animation node.
Check if a node exists (by name).
Return the input count for a given node. Different types of nodes have different amount of inputs.
Return the input source for a given node input.
Get the node type, will return from NODE_* enum.
Rename a node in the graph.
General purpose area detection and influence for 3D physics.
General purpose area detection for 3D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass.
Return the angular damp rate.
Return the physics layers this area can scan for collisions.
Return an individual bit on the collision mask.
Return the gravity intensity.
Return the falloff factor for point gravity.
Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
Return the physics layer this area is in.
Return an individual bit on the layer mask.
Return the linear damp rate.
Return a list of the areas that are totally or partially inside this area.
Return a list of the bodies ([PhysicsBody]) that are totally or partially inside this area.
Return the processing order of this area.
Return the space override mode.
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
Return whether this area can be detected by other, monitoring, areas.
Return whether this area detects bodies/areas entering/exiting it.
Return whether the area passed is totally or partially inside this area.
Return whether the body passed is totally or partially inside this area.
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
Set the physics layers this area can scan for collisions.
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
Set whether this area can detect bodies/areas entering/exiting it.
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity).
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector].
Set the gravity vector. This vector does not have to be normalized. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
Set the physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
Set the space override mode. This mode controls how an area affects gravity and damp. AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area.
This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area.
This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area.
This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering.
This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area.
This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit.
General purpose area detection and influence for 2D physics.
General purpose area detection for 2D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass.
Return the angular damp rate.
Return the physics layers this area can scan for collisions.
Return an individual bit on the collision mask.
Return the gravity intensity.
Return the falloff factor for point gravity.
Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
Return the physics layer this area is in.
Return an individual bit on the layer mask.
Return the linear damp rate.
Return a list of the areas that are totally or partially inside this area.
Return a list of the bodies ([PhysicsBody2D]) that are totally or partially inside this area.
Return the processing order of this area.
Return the space override mode.
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
Return whether this area can be detected by other, monitoring, areas.
Return whether this area detects bodies/areas entering/exiting it.
Return whether the area passed is totally or partially inside this area.
Return whether the body passed is totally or partially inside this area.
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
Set the physics layers this area can scan for collisions.
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
Set whether this area can detect bodies/areas entering/exiting it.
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity).
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector].
Set the gravity vector. This vector does not have to be normalized. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
Set the physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
Set the space override mode. This mode controls how an area affects gravity and damp. AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area.
This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area.
This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area.
This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering.
This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area.
This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit.
Generic array datatype.
Generic array, contains several elements of any type, accessible by numerical index starting at 0. Negative indices can be used to count from the right, like in Python. Arrays are always passed by reference.
Construct an array from a [RawArray].
Construct an array from a [RawArray].
Construct an array from a [RawArray].
Construct an array from a [RawArray].
Construct an array from a [RawArray].
Construct an array from a [RawArray].
Construct an array from a [RawArray].
Append an element at the end of the array (alias of [method push_back]).
Clear the array (resize to 0).
Return the amount of times an element is in the array.
Return true if the array is empty (size==0).
Remove the first occurrence of a value from the array.
Returns the first element of the array if the array is not empty (size>0).
Returns the last element of the array if the array is not empty (size>0).
Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.
Searches the array in reverse order for a value and returns its index or -1 if not found.
Return true if the array contains given value. [code][ "inside", 7 ].has("inside") == true, [ "inside", 7 ].has("outside") == false, [ "inside", 7 ].has(7) == true, [ "inside", 7 ].has("7") == false[/code]
Return a hashed integer value representing the array contents.
Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
Reverse the order of the elements in the array (so first element will now be the last).
Get whether this is a shared array instance.
Remove the last element of the array.
Remove the first element of the array.
Append an element at the end of the array.
Add an element at the beginning of the array.
Remove an element from the array by index.
Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null.
Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
Return the amount of elements in the array.
Sort the array using natural order.
Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise.
Server interface for low level audio access.
AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface.
Free a [RID] resource.
Return the global scale for event-based stream playback.
Return the global scale for all voices.
Return the global scale for stream playback.
Create an audio sample, return a [RID] referencing it. The sample will be created with a given format (from the SAMPLE_FORMAT_* enum), a total length (in samples, not bytes), in either stereo or mono. Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes.
Return the sample data as an array of bytes. The length will be the expected length in bytes.
Return the description of an audio sample. Mainly used for organization.
Return the format of the audio sample, in the form of the SAMPLE_FORMAT_* enum.
Return the length in samples (not bytes) of the audio sample. Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes.
Return the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format].
Return the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format].
Return the loop format for a sample, as a value from the SAMPLE_LOOP_* enum.
Return the mix rate of the given sample.
Return whether the sample is stereo (2 channels).
Set the sample data for a given sample as an array of bytes. The length must be equal to the sample length expected in bytes or an error will be produced. The byte length can be calculated as follows: Get the sample length ([method sample_get_length]). If the sample format is SAMPLE_FORMAT_PCM16, multiply it by 2. If the sample format is SAMPLE_FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. If the sample is stereo ([method sample_is_stereo]), multiply it by 2.
Set the description of an audio sample. Mainly used for organization.
Set the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format].
Set the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format].
Set the loop format for a sample from the SAMPLE_LOOP_* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms.
Change the default mix rate of a given sample.
Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced. For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by [method sample_get_length]. Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data.
Set global scale for event-based stream ([EventStream]) playback. Default is 1.0.
Set global scale for all voices (not including streams). Default is 1.0.
Set global scale for stream playback. Default is 1.0.
Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See [method sample_create].
Return the current chorus send for a given voice (0 to 1).
Return the current filter cutoff (in hz) for a given voice.
Return the current filter resonance for a given voice.
Return the current selected filter type for a given voice, from the FILTER_* enum.
Return the current mix rate for a given voice.
Return the current pan for a given voice (-1 to +1 range).
Return the current pan depth for a given voice (-1 to +1 range).
Return the current pan height for a given voice (-1 to +1 range).
Return the current reverb send for a given voice (0 to 1).
Return the current reverb type for a given voice from the REVERB_* enum.
Return the current volume for a given voice.
Return whether the current voice is positional. See [method voice_set_positional].
Start playback of a given voice using a given sample. If the voice was already playing it will be restarted.
Set chorus send post processing for the voice (from 0 to 1).
Set a resonant filter post processing for the voice. Filter type is a value from the FILTER_* enum.
Set a different playback mix rate for the given voice.
Change the pan of a currently playing voice and, optionally, the depth and height for a positional/3D sound. Panning values are expressed within the -1 to +1 range.
Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding.
Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB_* enum.
Change the volume of a currently playing voice. Volume is expressed as linear gain where 0.0 is mute and 1.0 is default.
Stop a given voice.
Sample format is 8 bits, signed.
Sample format is 16 bits, little-endian, signed.
Sample format is IMA-ADPCM compressed.
Sample does not loop.
Sample loops in forward mode.
Sample loops in a bidirectional way.
Filter is disabled.
Filter is a resonant lowpass.
Filter is a resonant bandpass.
Filter is a resonant highpass.
Filter is a notch (band reject).
Filter is a bandlimit (resonance used as highpass).
Small reverb room (closet, bathroom, etc).
Medium reverb room (living room)
Large reverb room (warehouse).
Large reverb room with long decay.
Software implementation of [AudioServer].
This is a software audio server. It does not use any kind of hardware acceleration. This class does not expose any new method.
Base class for audio streams.
Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a [Sample].
MusePack audio stream driver.
MusePack audio stream driver.
OGG Vorbis audio stream driver.
OGG Vorbis audio stream driver.
Opus Codec audio stream driver.
Opus Codec audio stream driver.
Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction.
Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction.
Return the copy mode currently applied to the BackBufferCopy (refer to constants section).
Return the area covered by the BackBufferCopy.
Set the copy mode of the BackBufferCopy (refer to constants section).
Defines the area covered by the BackBufferCopy.
Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers.
Sets the copy mode to a region.
Sets the copy mode to the entire screen.
Provides a base class for different kinds of buttons.
BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesn't display anything). Other types of buttons inherit from it.
Called when button is pressed.
Called when button is toggled (only if toggle_mode is active).
Return the state of the click_on_press property (see [method set_click_on_press]).
Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum.
Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]).
Return whether the button is in disabled state (see [method set_disabled]).
Return true if mouse entered the button before it exit.
If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down.
Return the toggle_mode property (see [method set_toggle_mode]).
Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button).
Set the button into disabled state. When a button is disabled, it can't be clicked or toggled.
Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]).
Set the button to pressed state (only if toggle_mode is active).
Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked.
Emitted when the button starts being held down.
Emitted when the button stops being held down.
This signal is emitted every time the button is toggled or pressed (i.e. activated, so on [code]button_down[/code] if "Click on press" is active and on [code]button_up[/code] otherwise).
Emitted when the button was released. This is only emitted by non-toggle buttons and if "Click on press" is active.
This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the [i]pressed[/i] argument.
The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
The state of buttons are pressed.
The state of buttons are hovered.
The state of buttons are disabled.
Add a character to the font, where [i]character[/i] is the unicode value, [i]texture[/i] is the texture index, [i]rect[/i] is the region in the texture (in pixels!), [i]align[/i] is the (optional) alignment for the character and [i]advance[/i] is the (optional) advance.
Add a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
Add a texture to the [BitmapFont].
Clear all the font data.
Return the size of a character, optionally taking kerning into account if the next character is provided.
Return a kerning pair as a difference.
Set the font ascent (number of pixels above the baseline).
Set the total font height (ascent plus descent) in pixels.
A node that will attach to a bone.
This node must be the child of a [Skeleton] node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone.
Base class for Box containers.
Base class for Box containers. It arranges children controls vertically or horizontally, and rearranges them automatically when their minimum size changes.
Add a control to the box as a spacer. If [i]begin[/i] is true the spacer control will be inserted in front of other children.
Return the alignment of children in the container.
Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END).
Align children with beginning of the container.
Align children with center of the container.
Align children with end of the container.
Box shape resource.
Box shape resource, which can be set into a [PhysicsBody] or area.
Return the half extents of the shape.
Set the half extents for the shape.
Standard themed Button.
Button is the standard themed button. It can contain text and an icon, and will display them according to the current [Theme].
Return the button icon.
Return the state of the [i]clip_text[/i] property (see [method set_clip_text])
Return the button text.
Return the text alignment policy.
Return the state of the [i]flat[/i] property (see [method set_flat]).
Set the icon that will be displayed next to the text inside the button area.
Set the [i]clip_text[/i] property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text.
Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed.
Set the button text, which will be displayed inside the button area.
Set the text alignment policy, using one of the ALIGN_* constants.
Align the text to the left.
Center the text.
Align the text to the right.
Array of Buttons.
Array of Buttons. A ButtonArray is useful to have an array of buttons laid out vertically or horizontally. Only one button can be selected, and is referenced by its index in the array (first button is 0, second button is 1, etc.). This is useful [i]e.g.[/i] for joypad-friendly interfaces and option menus.
Append a new button to the array, with the specified text.
Append a new button to the array, with the specified icon and text.
Remove all buttons from the array.
Remove the specified button in the array.
Return the amount of buttons in the array.
Return the icon of the specified button.
Return the text of the specified button.
Return the index of the currently hovered button in the array.
Return the index of the currently selected button in the array.
Set the icon of the specified button.
Define the text of the specified button.
Select a button in the array based on the given index.
A button has been selected, its index is given as the argument.
Align buttons at the beginning.
Align buttons in the middle.
Align buttons at the end.
Spread the buttons, but keep them small.
Spread the buttons, but expand them.
Group of Buttons.
Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed.
Return the list of all the buttons in the group.
Return the focused button.
Return the pressed button.
Return the index of the pressed button (by tree order).
Set the button to be pressed.
Camera node, displays from a point of view.
Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [Viewport] node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides [i]3D[/i] display capabilities to a [Viewport], and, without one, a scene registered in that [Viewport] (or higher viewports) can't be displayed.
Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform.
Return whether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree).
Make this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
Return a normal vector in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
Return a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
Set the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
Set the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units.
Return how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle.
Perspective Projection (object's size on the screen becomes smaller when far away).
Orthogonal Projection (objects remain the same size on the screen no matter how far away they are).
Camera node for 2D scenes.
Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [CanvasItem] based nodes. This node is intended to be a simple helper get get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from [Node2D] and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in [Viewport].
Align the camera to the tracked node
Force the camera to update scroll immediately.
Return the camera position.
Return the margins needed to drag the camera (see [method set_drag_margin]).
Return the scrolling limit in pixels.
Return the scroll offset.
Return true of this is the current camera (see [method make_current]).
Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.
Set the camera's position immediately to its current smoothing destination. This has no effect if smoothing is disabled.
Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges.
Set the scrolling limit in pixels.
Smooth camera when reaching camera limits. This requires camera smoothing being enabled to have a noticeable effect.
Set the scroll offset. Useful for looking around or camera shake animations.
Base class of anything 2D.
Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [Control], for anything GUI related, and by [Node2D] for anything 2D engine related. Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrides function, though. Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though). Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode. Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed.
Called (if exists) to draw the canvas item.
Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
Draw a colored circle.
Draw a colored polygon of any amount of points, convex or concave.
Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
Draw a polygon of any amount of points, convex or concave.
Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
Draw a colored rectangle.
Set a custom transform for drawing. Anything drawn afterwards will be transformed by this.
Draw a string using a custom font.
Draw a styled rectangle.
Draw a texture at a given position.
Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
Used for editing, returns an opaque value representing the transform state.
Used for editing, handle rotation.
Set the transform state of this CanvasItem. For [Node2D], this is an [Array] with (in order) a [Vector2] for position, a float for rotation and another [Vector2] for scale. For [Control] this is a [Rect2] with the position and size.
Return the current blending mode from enum BLEND_MODE_*.
Return the [RID] of the [World2D] canvas where this item is in.
Return the canvas item RID used by [VisualServer] for this item.
Get the transform matrix of this item's canvas.
Get the global position of the mouse.
Get the global transform matrix of this item.
Get the global transform matrix of this item in relation to the canvas.
Get a [Rect2] with the boundaries of this item and its children.
Return a rect containing the editable boundaries of the item.
Get this item's light mask number.
Get the mouse position relative to this item's position.
Get the material of this item.
Return the canvas item opacity. This affects the canvas item and all the children.
Return the canvas item self-opacity.
Get the transform matrix of this item.
Get whether this item uses its parent's material.
Get the viewport's boundaries as a [Rect2].
Get this item's transform in relation to the viewport.
Get the [World2D] where this item is in.
Hide the CanvasItem currently visible.
Return whether the item is drawn behind its parent.
Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden ([method hide] called) the function will return false.
Return if set as toplevel. See [method set_as_toplevel].
Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden.
Takes a global input event and convert to this item's coordinate system.
Set as top level. This means that it will not inherit transform from parent canvas items.
Set the blending mode from enum BLEND_MODE_*.
Set whether the canvas item is drawn behind its parent.
Set whether this item should be hidden or not. Note that no matter what is set here this item won't be shown if its parent or grandparents nodes are also hidden. A hidden CanvasItem make all children hidden too.
Set the ligtht mask number of this item.
Set the material of this item.
Set canvas item opacity. This will affect the canvas item and all the children.
Set canvas item self-opacity. This does not affect the opacity of children items.
Set whether or not this item should use its parent's material.
Show the CanvasItem currently hidden.
Queue the CanvasItem for update. [code]NOTIFICATION_DRAW[/code] will be called on idle time to request redraw.
Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing.
Emitted when becoming hidden.
Emitted when the item rect has changed.
Emitted when the visibility (hidden/visible) changes.
Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
Additive blending mode.
Subtractive blending mode.
Multiplicative blending mode.
Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
CanvasItem is requested to draw.
Canvas item visibility has changed.
Canvas item has entered the canvas.
Canvas item has exited the canvas.
Canvas item transform has changed. Only received if requested.
Canvas Item layer.
Canvas Item layer. [CanvasItem] nodes that are direct or indirect children of a [CanvasLayer] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [CanvasLayer] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below).
Return the layer index, determines the draw order, a lower value will be below a higher one.
Return the base offset for this layer (helper).
Return the base rotation for this layer (helper).
Get rotation of the layer in degree.
Return the base scale for this layer (helper).
Return the base transform for this layer.
Return the [World2D] used by this layer.
Set the layer index, determines the draw order, a lower value will be below a higher one.
Set the base offset for this layer (helper).
Set the base rotation for this layer (helper).
Set rotation of the layer in degree.
Set the base scale for this layer (helper).
Set the base transform for this layer.
Tint the entire canvas
CanvasModulate tints the canvas elements using its asigned color
Gets the canvas tint color
Sets the canvas tint color
Capsule shape resource.
Capsule shape resource, which can be set into a [PhysicsBody] or area.
Return the capsule height.
Return the capsule radius.
Set the capsule height.
Set the capsule radius.
Capsule 2D shape resource for physics.
Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modeling biped characters.
Return the height of the [CapsuleShape2D].
Return the radius of the [CapsuleShape2D].
Set the height of the [CapsuleShape2D].
Set the radius of the [CapsuleShape2D].
Keeps children controls centered.
CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center.
Should put children to the top left corner instead of center of the container.
This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container).
Binary choice user interface widget
A checkbox allows the user to make a binary choice (choosing only one of two posible options), for example Answer 'yes' or 'no'.
Checkable button.
CheckButton is a toggle button displayed as a check field.
Circular Shape for 2D Physics.
Circular Shape for 2D Physics. This shape is useful for modeling balls or small characters and it's collision detection with everything else is very fast.
Return the radius of the circle shape.
Set the radius of the circle shape.
Base node for 2D collisionables.
CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing [CollisionShape2D] and/or [CollisionPolygon2D] nodes as children. Such nodes are for reference and not present outside the editor, so code should use the regular shape API.
This method can be used to override normal input processing. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened.
Add a [Shape2D] to the collision body, with a given custom transform.
Remove all shapes.
Return the RID of this object.
Return the shape in the given index.
Return the amount of shapes in the collision body. Because a [CollisionPolygon2D] can generate more than one [Shape2D], the amount returned does not have to match the sum of [CollisionShape2D] and [CollisionPolygon2D].
Return the shape transform in the given index.
Return whether this object is pickable.
Return whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
Remove the shape in the given index.
Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events.
Change a shape in the collision body.
Set whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
Change the shape transform in the collision body.
This signal triggers when an input event fires over a shape. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened.
This event fires only once when the mouse pointer enters any shape of this object.
This event fires only once when the mouse pointer exits all shapes of this object.
Editor-only class for easy editing of collision polygons.
Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. This class is for editing custom shape polygons.
Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]).
Return the index of the first shape generated by the editor. When [code]build_mode[/code] is set to generate convex polygons, the shape shown in the editor may be decomposed into many convex polygons. In that case, a range of indexes is needed to directly access the [Shape2D]. When [code]build_mode[/code] is set to generate concave polygons, there is only one [Shape2D] generated, so the start index and the end index are the same.
Return the index of the last shape generated by the editor.
Return the list of points that define the polygon.
Return whether this polygon is a trigger.
Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]).
Set the array of points forming the polygon. When editing the point list via the editor, depending on [method get_build_mode], it has to be a list of points (for [code]build_mode==0[/code]), or a list of lines (for [code]build_mode==1[/code]). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point.
Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
Editor-only class for easy editing of shapes.
Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code.
Return the index of this shape inside its container [CollisionObject2D]. This can be used to directly access the underlying [Shape2D].
Return this shape's [Shape2D].
Return whether this shape is a trigger.
Set this shape's [Shape2D]. This will not appear as a node, but can be directly edited as a property.
Set whether this shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. will not block movement of colliding objects).
Color in RGBA format.
A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate() ) may accept values > 1.
Construct the color from an RGBA profile.
Construct the color from an RGBA profile.
Construct the color from an RGBA profile.
Construct the color from an RGBA profile.
Return a new color blended with anothor one.
Return the most contrasting color with this one.
Convert the color to gray.
Return the inverted color (1-r, 1-g, 1-b, 1-a).
Return the linear interpolation with another color.
Convert the color to a 32 its integer (each byte represents a RGBA).
Convert color to ARGB32, more compatible with DirectX.
Return the HTML hexadecimal color string.
- Alpha (0 to 1)
- Alpha (0 to 255)
- Blue (0 to 1)
- Blue (0 to 255)
- Green (0 to 1)
- Green (0 to 255)
- Hue (0 to 1)
- Red (0 to 1)
- Red (0 to 255)
- Saturation (0 to 1)
- Value (0 to 1)
Array of Colors
Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory.
Create from a generic array.
Append an element at the end of the array (alias of [method push_back]).
Append an [ColorArray] at the end of this array.
Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
Reverse the order of the elements in the array (so first element will now be the last).
Append a value to the array.
Remove an element from the array by index.
Set the size of the [ColorArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
Change the [Color] at the given index.
Return the array size.
Color picker control.
This is a simple color picker [Control]. It's useful for selecting a color from an RGB/RGBA colorspace.
Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
Return the current (edited) color.
Returns whether the color has transparency or not.
Returns whether this color picker is in raw mode or not, raw mode will allow the color R, G, B component values to go beyond 1, you have to consider that the max value for color components is 1, going beyond that value will not have effect in the color, but can be used for special operations that require it (like tinting without darkening or rendering sprites in HDR).
Select the current color.
Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color.
Set whether this color picker is using raw mode or not, see [method is_raw_mode].
Emitted when the color is changed.
Button that pops out a [ColorPicker]
Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility
Gets the current color
See [method ColorPicker.is_edit_alpha]
Sets the current color
See [method ColorPicker.set_edit_alpha]
Emitted when the color is changed.
Color interpolator node
Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset offset 0 and the other (white) at the ramp higher offset 1.
Adds the specified color to the end of the ramp, with the specified offset
Returns the color of the ramp color at index [i]point[/i]
Returns the colors in the ramp
Returns the offset of the ramp color at index [i]point[/i]
Returns the offsets for the colors in this ramp
Returns the number of colors in the ramp
Returns the interpolated color specified by [i]offset[/i]
Removes the color at the index [i]offset[/i]
Sets the color of the ramp color at index [i]point[/i]
Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements.
Sets the offset for the ramp color at index [i]point[/i]
Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements, all new colors will be black by default.
Concave polygon shape.
Concave polygon shape resource, which can be set into a [PhysicsBody] or area. This shape is created by feeding a list of triangles.
Return the faces (an array of triangles).
Set the faces (an array of triangles).
Concave polygon 2D shape resource for physics.
Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for [RigidBody2D] nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions. The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
Return the array of segments.
Set the array of segments.
Helper class to handle INI-style files.
This helper class can be used to store [Variant] values on the filesystem using an INI-style formatting. The stored values as referenced by a section and a key. The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly with accessing the filesystem. The following example shows how to parse a INI-style file from the system, read its contents and store new values in it: [codeblock] var config = ConfigFile.new() var err = config.load("user://settings.cfg") if err == OK: # if not, something went wrong with the file loading # Look for the display/width pair, and default to 1024 if missing var screen_width = get_value("display", "width", 1024) # Store a variable if and only it hasn't been defined yet if not config.has_section_key("audio", "mute"): config.set_value("audio", "mute", false) # Save the changes by overwriting the previous file config.save("user://settings.cfg") [/codeblock]
Return an array of all defined key identifiers in the specified section.
Return an array of all defined section identifiers.
Return the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional [i]default[/i] argument (and thus [code]NULL[/code] if not specified).
Check if the specified section exists.
Check if the specified section-key pair exists.
Load the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object from which the method was called. The return value is one of the OK, FAILED or ERR_* constants listed in [@Global Scope] (if the load was successful, it returns OK).
Save the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. The return value is one of the OK, FAILED or ERR_* constants listed in [@Global Scope] (if the save was successful, it returns OK).
Assign a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a [code]NULL[/code] value deletes the specified key if it exists (and deletes the section if it ends up empty once the key has been removed).
Dialog for confirmation of actions.
Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel button (in host OS order).
Return the cancel button.
Base node for containers.
Base node for containers. A [Container] contains other controls and automatically arranges them in a certain way. A Control can inherit this to create custom container classes.
Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
Emitted when sorting the children is needed.
Notification for when sorting the children, it must be obeyed immediately.
Control is the base node for all the GUI components.
Control is the base class Node for all the GUI components. Every GUI component inherits from it, directly or indirectly. In this way, sections of the scene tree made of contiguous control nodes, become user interfaces. Controls are relative to the parent position and size by using anchors and margins. This ensures that they can adapt easily in most situation to changing dialog and screen sizes. When more flexibility is desired, [Container] derived nodes can be used. Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range. Input device events ([InputEvent]) are first sent to the root controls via the [method Node._input], which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [method MainLoop._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [method Node._unhandled_input]), the control can accept it by calling [method accept_event]. Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with [method set_focus_mode]. Focus is lost when another control gains it, or the current focus owner is hidden. It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling [method set_ignore_mouse] enables this function. Finally, controls are skinned according to a [Theme]. Setting a [Theme] on a control will propagate all the skinning down the tree. Optionally, skinning can be overridden per each control by calling the add_*_override functions, or from the editor.
Called when an input event reaches the control.
Handles the event, no other control will receive it and it will not be sent to nodes waiting on [method Node._unhandled_input] or [method Node._unhandled_key_input].
Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared.
Override a single font (font) in the theme of this Control. If font is empty, override is cleared.
Override a single icon ([Texture]) in the theme of this Control. If texture is empty, override is cleared.
Override a single stylebox ([Stylebox]) in the theme of this Control. If stylebox is empty, override is cleared.
Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
Return the cursor shape at a certain position in the control.
Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]).
Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
Return which control is owning the keyboard focus, or null if no one.
Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_pos], [method get_size]).
Hint for containers, return horizontal positioning flags.
Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode.
Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_pos], [method get_size]).
Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by [method get_minimum_size][/b]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]).
Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
Return a [Theme] override, if one exists (see [method set_theme]).
Return the tooltip, which will appear when the cursor is resting over this control.
Hint for containers, return vertical positioning flags.
Steal the focus from another control and become the focused control (see [method set_focus_mode]).
Return whether the Control is the current focused control (see [method set_focus_mode]).
Return if the control is ignoring mouse events (even touchpad events send mouse events).
Give up the focus, no other control will be able to receive keyboard input.
Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previous anchor mode to the new one, so margin offsets ([method set_margin]) must be done after setting anchors, or at the same time ([method set_anchor_and_margin]) Additionally, [code]keep_margin[/code] controls whether margins should be left the same, or changed to keep the same position and size on-screen.
Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM), and also set its offset. This is a helper (see [method set_anchor] and [method set_margin]).
Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [method set_anchor], [method set_margin]).
Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]).
Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals.
Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]).
Hint for containers, set horizontal positioning flags.
Ignore mouse events on this control (even touchpad events send mouse events).
Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode.
Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [method set_margin]).
Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]).
Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
Override whole the [Theme] for this Control and all its children controls.
Set a tooltip, which will appear when the cursor is resting over this control.
Hint for containers, set vertical positioning flags.
Display a Control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus.
Emitted when keyboard focus is gained.
Emitted when the keyboard focus is lost.
Emitted when an input event is received. Connecting in realtime is recommended for accepting the events.
Emitted when the minimum size of the control changed.
Emitted when the mouse enters the control area.
Emitted when the mouse left the control area.
Emitted when the control changed size.
Emitted when the size flags changed.
X is relative to MARGIN_LEFT, Y is relative to MARGIN_TOP.
X is relative to -MARGIN_RIGHT, Y is relative to -MARGIN_BOTTOM.
X and Y are a ratio (0 to 1) relative to the parent size 0 is left/top, 1 is right/bottom.
Control can't acquire focus.
Control can acquire focus only if clicked.
Control can acquire focus if clicked, or by pressing TAB/Directionals in the keyboard from another Control.
Control changed size (get_size() reports the new size).
Mouse pointer entered the area of the Control.
Mouse pointer exited the area of the Control.
Control gained focus.
Control lost focus.
Theme changed. Redrawing is desired.
Modal control was closed.
Convex Polygon Shape.
Convex polygon shape resource, which can be set into a [PhysicsBody] or area.
Convex Polygon Shape for 2D physics.
Convex Polygon Shape for 2D physics. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check). The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
Return a list of points in either clockwise or counter clockwise order, forming a convex polygon.
Currently, this method does nothing.
Set a list of points in either clockwise or counter clockwise order, forming a convex polygon.
Describes a Bezier curve in 2D space.
This class describes a Bezier curve in 2D space. It is mainly used to give a shape to a [Path2D], but can be manually sampled for other purposes. It keeps a cache of precalculated points along the curve, to speed further calculations up.
Adds a point to a curve, at position "pos", with control points "in" and "out". If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= [method get_point_count]), the point will be appended at the end of the point list.
Returns the distance between two adjacent cached points.
Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough.
Returns the cache of points as a [Vector2Array].
Returns the number of points describing the curve.
Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0).
Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t".
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console.
Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console.
Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. "max_stages" controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.
Describes a Bezier curve in 3D space.
This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a [Path], but can be manually sampled for other purposes. It keeps a cache of precalculated points along the curve, to speed further calculations up.
Adds a point to a curve, at position "pos", with control points "in" and "out". If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= [method get_point_count]), the point will be appended at the end of the point list.
Returns the distance between two adjacent cached points.
Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough.
Returns the cache of points as a [Vector3Array].
Returns the cache of tilts as a [RealArray].
Returns the number of points describing the curve.
Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
Returns the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console, and returns 0.
Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0, 0).
Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t".
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console.
Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console.
Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console. The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the PathFollow calculates.
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. "max_stages" controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.
Damped spring constraint for 2D physics.
Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length.
Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
Return the maximum length of the spring joint.
Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
Set the maximum length of the spring joint.
Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
Dictionary type.
Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference.
Clear the dictionary, removing all key/value pairs.
Return true if the dictionary is empty.
Erase a dictionary key/value pair by key.
Return true if the dictionary has a given key.
Return true if the dictionary has all of the keys in the given array.
Return a hashed integer value representing the dictionary contents.
Return the list of keys in the [Dictionary].
Parse json text to the dictionary. Return OK when successed or the error code when failed.
Return the size of the dictionary (in pairs).
Return the dictionary as json text.
Return the list of values in the [Dictionary].
Directional Light, such as the Sun or the Moon.
A DirectionalLight is a type of [Light] node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction.
Type used to handle the filesystem.
Directory type. It is used to manage directories and their content (not restricted to the project folder). Here is an example on how to iterate through the files of a directory: [codeblock] func dir_contents(path): var dir = Directory.new() if dir.open(path) == OK: dir.list_dir_begin() var file_name = dir.get_next() while (file_name != ""): if dir.current_is_dir(): print("Found directory: " + file_name) else: print("Found file: " + file_name) file_name = dir.get_next() else: print("An error occurred when trying to access the path.") [/codeblock]
Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]). The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*).
Copy the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. Returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*).
Return whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories).
Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path.
Return whether the target file exists. The argument can be relative to the current directory, or an absolute path.
Return the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]).
On Windows, return the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On other platforms, or if the requested drive does not existed, the method returns an empty String.
On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0.
Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code]). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case).
On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1.
Initialise the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end]. Return true if the stream could not be initialised.
Close the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] or not does not matter).
Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]). The method returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*).
Create a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. Return one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*).
Open an existing directory of the filesystem. The [i]path[/i] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]). The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*).
Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. Return one of the error code constants defined in [@Global Scope] (OK or FAILED).
Rename (move) the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. Return one of the error code constants defined in [@Global Scope] (OK or FAILED).
Editor plugin to control the export process.
This plugin is added into EditorImportExport and allows to modify the behavior of the export process for individual files.
This function is called for each file exported and depending from the return value one of many things might happen. 1) If returned value is null, the file is exported as is. 2) If the returned value is a RawAray (array of bytes), the content of that array becomes the new file being exported. 3) If the file must also change it's name when exported, then a [Dictionary] must be returned with two fields: 'name' with the new filename and 'data' with a [RawArray] containing the raw contents of the file. Even if the name is changed, the run-time will redirect the old file to the new file automatically when accessed.
Resource filesystem, as the editor sees it.
This object holds information of all resources in the filesystem, their types, etc.
Get the type of the file, given the full path.
Get the root directory object.
Return the scan progress for 0 to 1 if the FS is being scanned.
Return true of the filesystem is being scanned.
Scan the filesystem for changes.
Check if the source of any imported resource changed.
Update a file information. Call this if an external program (not Godot) modified the file.
Emitted if the filesystem changed.
Emitted if the source of any imported file changed.
A diretory for the resource filesystem.
Import plugin for editor
Import plugins make it easy to handle importing of external assets into a project. They way they work is not that obvious though, so please make sure to read the documentation, tutorials and examples.
Generally, files that are imported stay the same when exported. The only exception is in some cases when the file must be re-imported for different platforms (ie. texture compression). If you want to customize the export process, it's recommended to use [method EditorExportPlugin.custom_export] instead.
Get the name of the import plugin, which will be used to identify content imported by this plugin. Try to use lowercase and underscores if possible.
Visible name for this plugin, which will be shown on the import menu.
Perform an import of an external resources into the project. This function is both called on import (from the dialog) or re-import (manual or automatic when external source files changed). An import process generally works like this: 1) Check the metadata for source files and options. Metadata is either generated in the import dialog or taken from an existing resource upon reimport. 2) Perform the import process into a new resource. Some times the resource being re-imported may be already loaded and in use, so checking for this by using [method ResourceLoader.has] is recommended. Otherwise create a new resource. 3) Set the metadata from the argument into the existing or new resource being created using [method Resource.set_import_metadata]. 4) Save the resource into 'path' (function argument)
This function is called when either the user chooses to import a resource of this type (Import menu), or when the user chooses to re-import the resource (from filesystem). In the later case, the path for the existing file is supplied in the argument. If the path is supplied, it is recommended to read the import metadata with [method ResourceLoader.load_import_metadata] and fill in the fields with the values contained there. The dialog can be shown in any way (just use a ConfirmationDialog and pop it up). Upon confirmation, fill up a ResourceImportMetadata and call the [method EditorImportPlugin.import] function with this information.
Used by the editor to extend it's functionality.
Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins.
Add a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. If your plugin is being removed, also make sure to remove your control by calling [method remove_control_from_bottom_panel].
Add a custom control to a container (see CONTAINER_* enum). There are many locations where custom controls can be added in the editor UI. Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). If your plugin is being removed, also make sure to remove your custom controls too.
Add the control to a specific dock slot (see DOCK_* enum for options). If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. If your plugin is being removed, also make sure to remove your control by calling [method remove_control_from_docks].
Add a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. When given node or resource is selected, the base type will be instanced (ie, "Spatial", "Control", "Resource"), then the script will be loaded and set to this object. You can use the [method EditorPlugin.handles] to check if your custom object is being edited by checking the script or using 'extends' keyword. During run-time, this will be a simple object with a script so this function does not need to be called then.
Add an export plugin. Plugins of this kind can change files being exported. On exit don't forget to call [method remove_export_plugin].
Add an import plugin. These plugins manage importing external content (from outside the project) into formats the engine can understand. On exit, don't forget to remove the plugin by calling [method remove_import_plugin]
This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency. This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object.
Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene.
This is used for plugins that create gizmos used by the spatial editor. Just check that the node passed in the "for_spatial" argument matches your plugin.
This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object.
If your plugin is active (because handles() returned true to the object), any input interaction with the 2D canvas editor will be first forwarded here. The canvas transform (containing zoom and offset to transform to edited world coordinates) is provided, but the input supplied is in untransformed coordinates to the canvas editor. Return true if you want to eat this event and not pass it to the canvas editor.
This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call [method update_canvas].
This is a low level function for plugins that edit a given objet type derived from Spatial to capture the input of the viewport. The function is only being called if your object is being edited. By using the [InputEvent] and the [Camera] arguments it's pretty easy to do raycasts into space using Camera functions. Return true if you want to capture the input, otherwise false.
Get a base control where it's safe to place dialogs. Many plugins open dialogs and they need a control as a base to make sure they use the editor icons and theme.
This is for editors that edit script based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25
Get the general settings for the editor (the same window that appears in the Settings menu).
Get the main editor control. Use this as a parent for main screens.
Tells the editor to handle the edit of the given resource. Ex: If you pass a Script as a argument, the editor will open the scriptEditor.
Get the name of the editor plugin. For main scren plugins this is what will appear in the selector (which by default is 2D, 3D, Script).
Get the filesystem cache for all resources in the project.
Get tool for generating resource previews.
Get the object that handles the selection of nodes in the Scene Tree editor.
Get the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns).
Get the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it.
Get the GUI layout of the plugin. This is used to save the project's editor layout when the [method EditorPlugin.queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock).
Implement this function if your plugin edits a specific type of object (Resource or Node). If you return true, then you will get the functions [method EditorPlugin.edit] and [method EditorPlugin.make_visible] called when the editor requests them.
Return true if this is a main screen editor plugin (it goes in the main screen selector together with 2D, 3D, Script).
Inspect an object in the inspector.
This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. Remember that you have to manage the visibility of all your editor controls manually.
Queue save the project's editor layout.
Remove the control from the bottom panel. Don't forget to call this if you added one, so the editor can remove it cleanly.
Remove the control from the dock. Don't forget to call this if you added one, so the editor can save the layout and remove it cleanly.
Remove a custom type added by [method EditorPlugin.add_custom_type]
Remove the export plugin, don't forget to call this on exit.
Remove the import plugin, don't forget to call this on exit.
This method is called after the editor save the project or when the it's closed. It asks the plugin to save edited external scenes/resources.
Restore the state saved by [method EditorPlugin.get_state].
Restore the plugin GUI layout saved by [method EditorPlugin.get_window_layout].
Updates the control used to draw the edited scene over the 2D canvas. This is used together with [method forward_canvas_input_event].
Helper to generate previews of reources or files.
This object is used to generate previews for resources of files.
Create an own, custom preview generator.
Check if the resource changed, if so it will be invalidated and the corresponding signal emitted.
Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texure (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.
Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texure (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.
Remove a custom preview generator.
If a preview was invalidated (changed) this signal will emit (using the path of the preview)
Custom generator of previews.
Custom code to generate previews. Please check "file_dialog/thumbnail_size" in EditorSettings to find out the right size to do previews at.
Generate a preview from a given resource. This must be always implemented. Returning an empty texture is an OK way to fail and let another generator take care. Care must be taken because this function is always called from a thread (not the main thread).
Generate a preview directly from a path, implementing this is optional, as default code will load and call generate() Returning an empty texture is an OK way to fail and let another generator take care. Care must be taken because this function is always called from a thread (not the main thread).
Return if your generator supports this resource type.
Base script for post-processing scenes being imported.
These scripts can modify scenes after being imported by the 3D Scene import option of the Import menu.
This function is called upon import with the imported scene. Just do any changes desired to the scene and return it. If null is returned, import will fail and throw an error to the user.
Simple script to perform changes in the currently edited scene.
This script can be run from the Scene -> Run Script menu option.
Manages the SceneTree selection in the editor.
This object manages the SceneTree selection in the editor.
Add a node to the selection.
Clear the selection.
Get the list of selectes nodes.
Get the list of selected nodes, optimized for transform operations (ie, moving them, rotating, etc). This list avoids situations where a node is selected and also chid/grandchild.
Remove a node from the selection.
Emitted when the selection changes.
Object that holds the project-independent editor settings.
Object that holds the project-independent editor settings. These settings are generally visible in the Editor Settings menu. Accessing the settings is done by using the regular [Object] API, such as: [codeblock] settings.set(prop,value) settings.get(prop) list_of_settings = settings.get_property_list() [/codeblock]
Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@Global Scope]), and optionally hint:[int](see PROPERTY_HINT_* in [@Global Scope]), hint_string:[String]. Example:[codeblock] editor_settings.set("category/property_name", 0)

var property_info = { "name": "category/property_name", "type": TYPE_INT, "hint": PROPERTY_HINT_ENUM, "hint_string": "one,two,three" }

editor_settings.add_property_info(property_info)[/codeblock]
Erase a given setting (pass full property path).
Get the list of favorite directories for this project.
Get the specific project settings path. Projects all have an unique sub-directory inside the settings path where project specific settings are saved.
Get the list of recently visited folders in the file dialog for this project.
Get the global settings path for the engine. Inside this path you can find some standard paths such as: settings/tmp - used for temporary storage of files settings/templates - where export templates are located
Set the list of favorite directories for this project.
Set the list of recently visited folders in the file dialog for this project.
Custom gizmo for editing Spatial objects.
Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by [method EditorPlugin.create_spatial_gizmo].
Add collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw].
Add a list of handles (points) which can be used to deform the object being edited. There are virtual functions which will be called upon editing of these handles. Call this function during [method redraw].
Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during [method redraw].
Add a mesh to the gizmo, this is used for visualization. Call this function during [method redraw].
Add an unscaled billboard for visualization. Call this function during [method redraw].
Commit a handle being edited (handles must have been prevously added by [method add_handles]). If the cancel parameter is true, an option to restore the edited value to the original is provided.
Get the name of an edited handle (handles must have been previously added by [method add_handles]). Handles can be named for reference to the user when editing.
Get actual value of a handle. This value can be anything and used for eventually undoing the motion when calling [method commit_handle]
This function is called when the Spatial this gizmo refers to changes (the [method Spatial.update_gizmo] is called).
This function is used when the user drags a gizmo handle (previously added with [method add_handles]) in screen coordinates. The [Camera] is also provided so screen coordinates can be converted to raycasts.
Call this function once and upon creation of the gizmo, otherwise no other function will work. The argument is the node being edited by the gizmo.
Class for event stream playback.
Class for event stream playback. Event streams are music expressed as a series of events (note on, note off, instrument change...), as opposed to audio streams, which are just audio data. Examples of event-based streams are MIDI files, or MOD music. Currently, only MOD, S3M, IT, and XM music is supported.
Return the time at which the last note of a given channel in the stream plays.
Return the volume scale for an individual channel of the stream.
Return the song length. May be in seconds, but depends on the stream type.
Return the number of times the playback has looped.
Return the pitch scale factor for this player.
Return the playback position. May be in seconds, but depends on the stream type.
Return the currently assigned stream.
Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>".
Return the tempo multiplier.
Return the playback volume for this player.
Return the playback volume for this player, in decibels.
Return whether this player will start playing as soon as it enters the scene tree.
Return whether this player will be restart the playback at the end.
Return whether the playback is currently paused.
Return whether this player is playing.
Play the currently assigned stream.
Set the playback position. May be in seconds, but depends on the stream type.
Set whether this player will start playing as soon as it enters the scene tree.
Set the volume scale for an individual channel of the stream, with the same value range as [method set_volume]. The channel number depends on the stream format. For example, MIDIs range from 0 to 15, and MODs from 0 to 63. Many stream formats are multichannel, so this allows to affect only a part of the music.
Set whether the stream will be restarted at the end.
Pause stream playback.
Set the pitch multiplier for all sounds coming from this stream. A value of 2.0 shifts all pitches one octave up, and a value of 0.5 shifts pitches one octave down.
Set the [EventStream] this player will play.
Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch.
Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference. The effect of these special values ultimately depends on the low-level implementation of the file format being played.
Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see [method set_volume]) still apply.
Stop playing.
Base class for all event-based stream drivers.
Base class for all event-based stream drivers. Event streams are music expressed as a series of events (note on, note off, instrument change...), as opposed to audio streams, which are just audio data. Examples of event-based streams are MIDI files, of MOD music. This class exposes no methods.
Driver for MOD playback.
This driver plays MOD music. MOD music, as all event-based streams, is a music format defined by note events occurring at defined moments, instead of a stream of audio samples. Currently, this driver supports the MOD, S3M, IT, and XM formats. This class exposes no methods. This class can return its playback position in seconds, but does not allow to set it, failing with only a console warning. This class can not return its song length, returning 1.0 when queried. This class does not limit its volume settings, allowing for overflow/distortion and wave inversion.
Type to handle file reading and writing operations.
File type. This is used to permanently store data into the user device's file system and to read from it. This can be used to store game save data or player configuration files, for example. Here's a sample on how to write and read from a file: [codeblock] func save(content): var file = File.new() file.open("user://save_game.dat", file.WRITE) file.store_string(content) file.close()

func load(): var file = File.new() file.open("user://save_game.dat", file.READ) var content = file.get_as_text() file.close() return content [/codeblock]
Close the currently opened file.
Return whether the file cursor reached the end of the file.
Get whether or not the file in the specified path exists.
Get the next 16 bits from the file as an integer.
Get the next 32 bits from the file as an integer.
Get the next 64 bits from the file as an integer.
Get the next 8 bits from the file as an integer.
Get the whole file as a [String].
Get next len bytes of the file as a [RawArray].
Get the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma).
Get the next 64 bits from the file as a floating point number.
Get whether endian swap is enabled for this file.
Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope].
Get the next 32 bits from the file as a floating point number.
Return the size of the file in bytes.
Get the next line of the file as a [String].
Return a md5 String representing the file at the given path or an empty [String] on failure.
Get a [String] saved in Pascal format from the file.
Return the file cursor position.
Get the next bits from the file as a floating point number.
Return a sha256 String representing the file at the given path or an empty [String] on failure.
Get the next Variant value from the file.
Return whether the file is currently opened.
Open the file for writing or reading, depending on the flags.
Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file).
Change the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file.
Set whether to swap the endianess of the file. Enable this if you're dealing with files written in big endian machines. Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file.
Store an integer as 16 bits in the file.
Store an integer as 32 bits in the file.
Store an integer as 64 bits in the file.
Store an integer as 8 bits in the file.
Store the given array of bytes in the file.
Store a floating point number as 64 bits in the file.
Store a floating point number as 32 bits in the file.
Store the given [String] as a line in the file.
Store the given [String] as a line in the file in Pascal format (i.e. also store the length of the string).
Store a floating point number in the file.
Store the given [String] in the file.
Store any Variant value in the file.
Open the file for reading.
Open the file for writing. Create it if the file not exists and truncate if it exists.
Open the file for reading and writing, without truncating the file.
Open the file for reading and writing. Create it if the file not exists and truncate if it exists.
Dialog for selecting files or directories in the filesystem.
FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks.
Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images");
Clear all the added filters in the dialog.
Return the file access permission of the dialog.
Get the current working directory of the file dialog.
Get the current selected file of the file dialog (empty if none).
Get the current selected path (directory and file) of the file dialog (empty if none).
Get the file dialog mode from the MODE_* enum.
Return the vertical box container of the dialog, custom controls can be added to it.
Invalidate and update the current dialog content list.
Return true if the diaog allows show hidden files.
Set the file access permission of the dialog(Must be one of [ACCESS_RESOURCES], [ACCESS_USERDATA] or [ACCESS_FILESYSTEM]).
Set the current working directory of the file dialog.
Set the current selected file name of the file dialog.
Set the current selected file path of the file dialog.
Set the file dialog mode from the MODE_* enum.
Set the dialog should show hidden files.
Event emitted when the user selects a directory.
Event emitted when the user selects a file (double clicks it or presses the OK button).
Event emitted when the user selects multiple files.
The dialog allows the selection of one, and only one file.
The dialog allows the selection of multiple files.
The dialog functions as a folder selector, disallowing the selection of any file.
The dialog allows the selection of a file or a directory.
The dialog will warn when a file exists.
The dialog allows the selection of file and directory.
The dialog allows ascess files under [Resource] path(res://) .
The dialog allows ascess files in whole file system.
Simple Material with a fixed parameter set.
FixedSpatialMaterial is a simple type of material [Resource], which contains a fixed amount of parameters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to [ShaderMaterial] for most simple use cases.
Return a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum.
Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object.
Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]).
Returns the special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM.
Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum.
Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object.
Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]).
Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM.
Diffuse Lighting (light scattered from surface).
Detail Layer for diffuse lighting.
Specular Lighting (light reflected from the surface).
Emission Lighting (light emitted from the surface).
Specular Exponent (size of the specular dot).
Glow (Visible emitted scattered light).
Normal Map (irregularity map).
Maximum amount of parameters.
Read texture coordinates from the UV array.
Read texture coordinates from the UV array and transform them by uv_xform.
Read texture coordinates from the UV2 array.
Internationalized font and text drawing support.
Font contains an unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc.
Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis.
Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.
Return the font ascent (number of pixels above the baseline).
Return the font descent (number of pixels below the baseline).
Return the total font height (ascent plus descent) in pixels.
Return the size of a string, taking kerning and advance into account.
After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it.
Reference to a function in an object.
In GDScript, functions are not [i]first-class objects[/i]. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments. However, by creating a [FuncRef] using the [method @GDScript.funcref] function, a reference to a function in a given object can be created, passed around and called.
Set the name of the function to call on the object, without parentheses or any parameters.
Set the object on which to call the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary].
State of a function call after yielding.
Calling [method @GDScript.yield] within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling [method resume] on this state object.
Check whether the function call may be resumed. This is not the case if the function state was already resumed.
Resume execution of the yielded function call. If handed an argument, return the argument from the [method @GDScript.yield] call in the yielded function call. You can pass e.g. an [Array] to hand multiple arguments. This function returns what the resumed function call returns, possibly another function state if yielded again.
Base node for geometry based visual instances.
Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials.
Return the material override for the whole geometry.
Set the material override for the whole geometry.
Contains global variables accessible from everywhere.
Contains global variables accessible from everywhere. Use the normal [Object] API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in engine.cfg are also loaded into globals, making this object very useful for reading custom game configuration options.
Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@Global Scope]), and optionally hint:[int](see PROPERTY_HINT_* in [@Global Scope]), hint_string:[String]. Example: [codeblock] Globals.set("category/property_name", 0)

var property_info = { "name": "category/property_name", "type": TYPE_INT, "hint": PROPERTY_HINT_ENUM, "hint_string": "one,two,three" }

Globals.add_property_info(property_info) [/codeblock]
Clear the whole configuration (not recommended, may break things).
Return the order of a configuration value (influences when saved to the config file).
Convert a localized path (res://) to a full native OS path.
Return true if a configuration value is present.
If returns true, this value can be saved to the configuration file. This is useful for editors.
Convert a path to a localized path (res:// path).
Set the order of a configuration value (influences when saved to the config file).
If set to true, this value can be saved to the configuration file. This is useful for editors.
GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them.
GraphEdit manages the showing of GraphNodes it contains, as well as connections an disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. It is greatly advised to enable low processor usage mode (see [method OS.set_low_processor_usage_mode]) when using GraphEdits.
Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created.
Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists.
Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" }
Return the scroll offset.
Return the current zoom value.
Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode.
Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise.
Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void.
Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728].
Signal sent at the beginning of a GraphNode movement.
Signal sent at the end of a GraphNode movement.
Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created.
Signal sent when a GraphNode is attempted to be removed from the GraphEdit.
Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed.
Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit.
Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent.
A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types.
A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections.
Disable all input and output slots of the GraphNode.
Disable input and output slot whose index is 'idx'.
Return the color of the input connection 'idx'.
Return the number of enabled input slots (connections) to the GraphNode.
Return the position of the input connection 'idx'.
Return the type of the input connection 'idx'.
Return the color of the output connection 'idx'.
Return the number of enabled output slots (connections) of the GraphNode.
Return the position of the output connection 'idx'.
Return the type of the output connection 'idx'.
Return the offset of the GraphNode.
Return the color set to 'idx' left (input) slot.
Return the color set to 'idx' right (output) slot.
Return the (integer) type of left (input) 'idx' slot.
Return the (integer) type of right (output) 'idx' slot.
Return the title of the GraphNode.
Returns true if the close button is shown. False otherwise.
Return true if left (input) slot 'idx' is enabled. False otherwise.
Return true if right (output) slot 'idx' is enabled. False otherwise.
Set the offset of the GraphNode.
Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work.
Set the title of the GraphNode.
Signal sent on closing the GraphNode.
Signal sent when the GraphNode is dragged.
Signal sent when the GraphNode is moved.
Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
Grid container used to arrange elements in a grid like layout
Grid container will arrange its children in a grid like structure, the grid columns are specified using the [method set_columns] method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container.
Returns the number of columns in this container
Sets the numbers of columns in the container, then reorder its children to accommodate the new layout
Groove constraint for 2D physics.
Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another.
Set the final offset of the groove on body A.
Return the length of the groove.
Set the initial offset of the groove on body A.
Set the length of the groove.
Horizontal box container.
Horizontal box container. See [BoxContainer].
Horizontal button array.
Horizontal button array. See [ButtonArray].
Horizontal scroll bar.
Horizontal scroll bar. See [ScrollBar]. This one goes from left (min) to right (max).
Horizontal separator.
Horizontal separator. See [Separator]. It is used to separate objects vertically, though (but it looks horizontal!).
Horizontal slider.
Horizontal slider. See [Slider]. This one goes from left (min) to right (max).
Horizontal split container.
Horizontal split container. See [SplitContainer]. This goes from left to right.
Hyper-text transfer protocol client.
Hyper-text transfer protocol client. Supports SSL and SSL server certificate verification. Can be reused to connect to different hosts and make many requests.
Cloces the current connection, allows for reusal of [HTTPClient].
Connect to a host. This needs to be done before any requests are sent. The host should not have http:// prepended but will strip the protocol identifier if provided. verify_host will check the SSL identity of the host if set to true.
Return current connection.
Return the response's body length.
Return the HTTP status code of the response.
Return the response headers.
Returns all response headers as dictionary where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. Structure: ("key":"value1; value2") Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns a STATUS_* enum constant. Need to call [method poll] in order to get status updates.
Return whether this [HTTPClient] has a response available.
Return whether blocking mode is enabled.
Return whether this [HTTPClient] has a response that is chunked.
This needs to be called in order to have any request processed. Check results with [method get_status]
Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: [codeblock] var fields = {"username": "user", "password": "pass"} String queryString = httpClient.query_string_from_dict(fields) returns:= "username=user&password=pass" [/codeblock]
Reads one chunk from the response.
Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". Headers are HTTP request headers. To create a POST request with query strings to push to the server, do: [codeblock] var fields = {"username" : "user", "password" : "pass"} var queryString = httpClient.query_string_from_dict(fields) var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())] var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString) [/codeblock]
Sends a raw request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". Headers are HTTP request headers. Sends body raw, as a byte array, does not encode it in any way.
Stub function
Stub function
If set to true, execution will block until all data is read from the response.
Set connection to use, for this client.
Sets the size of the buffer used and maximum bytes to read per iteration. see [method read_response_body_chunk]
A Node with the ability to send HTTP requests.
A Node with the ability to send HTTP requests. Uses a [HTTPClient] internally, supports HTTPS. Can be used to make HTTP requests or download files via HTTP.
Cancel the current request.
Return the response body length.
Return current body size limit.
Return the file this request will download into.
Return the amount of bytes this HTTPRequest downloaded.
Return the current status of the underlying [HTTPClient].
Return the maximum amount of redirects that will be followed.
Whether this request is using threads.
Set the response body size limit.
Set the file to download into. Outputs the response body into the file.
Set the maximum amount of redirects the request will follow.
Make this HTTPRequest use threads.
This signal is emitted upon request completion.
Request successful.
Request failed while connecting.
Request failed while resolving.
Request failed due to connection(read/write) error.
Request failed on SSL handshake.
Request does not have a response(yet).
Request exceded it's maximum size limit, see [method set_body_size_limit].
Request failed. (unused)
HTTPRequest couldn't open the download file.
HTTPRequest couldn't write to the download file.
Request reached it's maximum redirect limit, see [method set_max_redirects].
IP Protocol support functions.
IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see [StreamPeerTCP] and [TCP_Server]). IP provides hostname resolution support, both blocking and threaded.
Erase a queue ID, removing it from the queue if needed. This should be used after a queue is completed to free it and enable more queries to happen.
Return a resolved item address, or an empty string if an error happened or resolution didn't happen yet (see [method get_resolve_item_status]).
Return the status of hostname queued for resolving, given it's queue ID. Returned status can be any of the RESOLVER_STATUS_* enumeration.
Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type".
Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error.
Image datatype.
Built in native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it.
Create an empty image of a specific size and format.
Copy a "src_rect" [Rect2] from "src" [Image] to this [Image] on coordinates "dest".
Transfer data from "src" to this [Image] using a "brush" as a mask/brush on coordinates "pos".
Return a new [Image] from this [Image] that is created by brushhing see [method brush_transfer].
Return a new compressed [Image] from this [Image] using one of [Image].COMPRESS_*.
Return a new [Image] from this [Image] with a different format.
Return a new decompressed [Image].
Return whether this [Image] is empty(no data).
Return the raw data of the [Image].
Return the format of the [Image], one of [Image].FORMAT_*.
Return the height of the [Image].
Return the color of the pixel in the [Image] on coordinates "x,y" on mipmap level "mipmap_level".
Return a new [Image] that is a copy of "area" in this [Image].
Return the area of this [Image] that is used/visibly colored/opaque.
Return the width of the [Image].
Load an [Image].
Put a pixel of "color" on coordinates "x,y" on mipmap level "mipmap_level".
Return a new [Image] from this [Image] that is resized to size "x,y" using [Image].INTERPOLATE_*.
Save this [Image] as a png.
A [Texture] based on an [Image].
A [Texture] based on an [Image]. Can be created from an [Image].
Create a new [ImageTexture] with "width" and "height". "format" one of [Image].FORMAT_*. "flags" one or more of [Texture].FLAG_*.
Create a new [ImageTexture] from an [Image] with "flags" from [Texture].FLAG_*.
Return the [Image] of this [ImageTexture].
Return the format of the [ImageTexture], one of [Image].FORMAT_*.
Return the storage quality for [ImageTexture].STORAGE_COMPRESS_LOSSY.
Return the storage type. One of [ImageTexture].STORAGE_*.
Load an [ImageTexure].
Set the [Image] of this [ImageTexture].
Set the storage quality in case of [ImageTexture].STORAGE_COMPRESS_LOSSY.
Set the storage type. One of [ImageTexture].STORAGE_*.
[Image] data is stored raw and unaltered.
[Image] data is compressed with a lossy algorithm. You can set the storage quality with [method set_lossy_storage_quality].
[Image] data is compressed with a lossless algorithm.
Node to draw simple geometry from code, ala OpenGL 1.x
Simple helper to draw an uvsphere, with given latitudes, longitude and radius.
Add a vertex with the currently set color/uv/etc.
Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references. For the type of primitive, use the [Mesh].PRIMITIVE_* enumerations.
Clear everything that was drawn using begin/end.
Call this when done adding a batch of geometry, otherwise it can't be displayed.
Set the color that the next vertex will use to be drawn.
Set the normal that the next vertex will use to be drawn.
Set the tangent (and binormal facing) that the next vertex will use to be drawn.
Set the UV that the next vertex will use to be drawn.
Set the second layer of UV that the next vertex will use to be drawn.
A Singleton that deals with inputs.
A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joysticks, and input actions.
This will simulate pressing the specificed action.
If the specified action is already pressed, this will release it.
Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
If the device has an accelerometer, this will return the movement.
Returns an [Array] containing the device IDs of all currently connected joysticks.
If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis.
Returns the current value of the joystick axis at given index (see JOY_* constants in [@Global Scope])
Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise.
Returns the name of the joystick at the specified device index
Returns the duration of the current vibration effect in seconds.
Returns the strength of the joystick vibration: x is the strength of the weak motor, and y is the strength of the strong motor.
If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes.
Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together.
Return the mouse mode. See the constants for more information.
Returns the mouse speed for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion.
Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap].
Returns if the joystick button at the given index is currently pressed. (see JOY_* constants in [@Global Scope])
Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them.
Returns true or false depending on whether the key is pressed or not. You can pass KEY_*, which are pre-defined constants listed in [@Global Scope].
Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON_*, which are pre-defined constants listed in [@Global Scope].
Removes all mappings from the internal db that match the given uid.
Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified.
Set the mouse mode. See the constants for more information.
Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). Note that not every hardware is compatible with long effect durations, it is recommended to restart an effect if in need to play it for more than a few seconds.
Stops the vibration of the joystick.
Sets the mouse position to the specified vector.
Emitted when a joystick device has been connected or disconnected
Makes the mouse cursor visible if it is hidden.
Makes the mouse cursor hidden if it is visible.
Captures the mouse. The mouse will be hidden and unable to leave the game window. But it will still register movement and mouse button presses.
Default implementation of the [Input] class.
Default implementation of the [Input] class, used internally by the editor and games for default input management.
Built-in input event data.
Built-in input event data. InputEvent is a built-in engine datatype, given that it's passed around and used so much. Depending on its type, the members contained can be different, so read the documentation well! Input events can also represent actions (editable from the project settings).
Return if this input event matches a pre-defined action, no matter the type.
Return whether the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
Return whether the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
Return if this input event is an echo event (only for events of type KEY, it will return false for other types).
Return if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
Change the input event to an action event of the given name, regardless of its initial type, with the pressed status passed as argument.
- Event identifier, positive integer increased at each new event.
- Device identifier.
- Type of event (one of the [InputEvent] constants).
Empty input event.
Key event.
Mouse motion event.
Mouse button event.
Joystick motion event.
Joystick button event.
Screen touch event.
Screen drag event.
Pre-defined action event (see [InputMap]).
Built-in input event type for actions.
Input event type for actions that extends the global [InputEvent] type.
Return if this input event matches a pre-defined action, i.e. always true for InputEventAction.
Return whether the given action is being pressed.
Return whether the given action is released (i.e. not pressed).
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
Return if this input event is pressed.
Change the input event to an action event of the given name with the pressed status passed as argument.
- Event identifier, positive integer increased at each new event.
- Device identifier.
- Type of event (one of the [InputEvent] constants).
Empty input event.
Key event.
Mouse motion event.
Mouse button event.
Joystick motion event.
Joystick button event.
Screen touch event.
Screen drag event.
Pre-defined action event (see [InputMap]).
Built-in input event type for joystick button events.
Input event type for joystick button events that extends the global [InputEvent] type.
Return if this input event matches a pre-defined action.
Return whether the given action is being pressed.
Return whether the given action is released (i.e. not pressed).
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
Return if this input event is pressed.
Change the input event to an action event of the given name with the pressed status passed as argument.
- Event identifier, positive integer increased at each new event.
- Joystick button identifier, one of the JOY_BUTTON_* constants in [@Global Scope].
- Device identifier.
- Pressed state of the joystick button.
- Intensity of the button pressure, ranges from 0 to 1.0.
- Type of event (one of the [InputEvent] constants).
Empty input event.
Key event.
Mouse motion event.
Mouse button event.
Joystick motion event.
Joystick button event.
Screen touch event.
Screen drag event.
Pre-defined action event (see [InputMap]).
Built-in input event type for joystick motion/axis events.
Input event type for joystick motion/axis events that extends the global [InputEvent] type.
Return whether the given action is being pressed.
Return whether the given action is released (i.e. not pressed).
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
Return if this input event is pressed.
Change the input event to an action event of the given name with the pressed status passed as argument.
- Event identifier, positive integer increased at each new event.
- Joystick axis identifier, one of the JOY_AXIS_* constants in [@Global Scope].
- Device identifier.
- Type of event (one of the [InputEvent] constants).
- Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position.
Empty input event.
Key event.
Mouse motion event.
Mouse button event.
Joystick motion event.
Joystick button event.
Screen touch event.
Screen drag event.
Pre-defined action event (see [InputMap]).
Built-in input event type for keyboard events.
Input event type for keyboard events that extends the global [InputEvent] type.
Return if this input event matches a pre-defined action.
Return whether the given action is being pressed.
Return whether the given action is released (i.e. not pressed).
Return if this input event is an echo event.
Return if this input event is pressed.
Change the input event to an action event of the given name with the pressed status passed as argument.
- Event identifier, positive integer increased at each new event.
- State of the Alt modifier.
- State of the Ctrl modifier.
- Device identifier.
- Echo state of the key, i.e. whether it's a repeat event or not.
- State of the Meta modifier.
- Pressed state of the key.
- Scancode of the key, one of the KEY_* constants in [@Global Scope].
- State of the Shift modifier.
- Type of event (one of the [InputEvent] constants).
- Unicode identifier of the key (when relevant).
Empty input event.
Key event.
Mouse motion event.
Mouse button event.
Joystick motion event.
Joystick button event.
Screen touch event.
Screen drag event.
Pre-defined action event (see [InputMap]).
Built-in input event type for mouse button events.
Input event type for mouse button events that extends the global [InputEvent] type.
Return if this input event matches a pre-defined action.
Return whether the given action is being pressed.
Return whether the given action is released (i.e. not pressed).
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
Return if this input event is pressed.
Change the input event to an action event of the given name with the pressed status passed as argument.
- Event identifier, positive integer increased at each new event.
- State of the Alt modifier.
- Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope].
- Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
- State of the Control modifier.
- Device identifier.
- Whether the event is a double-click.
- Global position of the mouse click.
- Global X coordinate of the mouse click.
- Global Y coordinate of the mouse click.
- State of the Meta modifier.
- Local position of the mouse click.
- Pressed state of the mouse button.
- State of the Shift modifier.
- Type of event (one of the [InputEvent] constants).
- Local X coordinate of the mouse click.
- Local Y coordinate of the mouse click.
Empty input event.
Key event.
Mouse motion event.
Mouse button event.
Joystick motion event.
Joystick button event.
Screen touch event.
Screen drag event.
Pre-defined action event (see [InputMap]).
Built-in input event type for mouse motion events.
Input event type for mouse motion events that extends the global [InputEvent] type.
Return if this input event matches a pre-defined action.
Return whether the given action is being pressed. Not relevant for MOUSE_MOTION events, always false.
Return whether the given action is released (i.e. not pressed). Not relevant for MOUSE_MOTION events, can be true or false depending on whether [method is_action] is true.
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
Return if this input event is pressed. Not relevant for MOUSE_MOTION events, always false.
Change the input event to an action event of the given name with the (irrelevant for this type) pressed status passed as argument.
- Event identifier, positive integer increased at each new event.
- State of the Alt modifier.
- Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
- State of the Ctrl modifier.
- Device identifier.
- Global position of the mouse pointer.
- Global X coordinate of the mouse pointer.
- Global Y coordinate of the mouse pointer.
- State of the Meta modifier.
- Local position of the mouse pointer.
- Position of the mouse pointer relative to the previous mouse position.
- X coordinate of the mouse pointer relative to the previous mouse position.
- Y coordinate of the mouse pointer relative to the previous mouse position.
- State of the Shift modifier.
- Speed of the mouse pointer.
- Speed of the mouse pointer on the X axis.
- Speed of the mouse pointer on the Y axis.
- Type of event (one of the [InputEvent] constants).
- Local X coordinate of the mouse pointer.
- Local Y coordinate of the mouse pointer.
Empty input event.
Key event.
Mouse motion event.
Mouse button event.
Joystick motion event.
Joystick button event.
Screen touch event.
Screen drag event.
Pre-defined action event (see [InputMap]).
Built-in input event type for screen drag events.
Input event type for screen drag events that extends the global [InputEvent] type.
Return if this input event matches a pre-defined action.
Return whether the given action is being pressed. Not relevant for SCREEN_DRAG events, always false.
Return whether the given action is released (i.e. not pressed). Not relevant for SCREEN_DRAG events, can be true or false depending on whether [method is_action] is true.
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
Return if this input event is pressed. Not relevant for SCREEN_DRAG events, always false.
Change the input event to an action event of the given name with the (irrelevant for this type) pressed status passed as argument.
- Event identifier, positive integer increased at each new event.
- Device identifier.
- Drag event index in the case of a multi-drag event.
- Position of the drag event.
- Position of the drag event relative to its start position.
- X coordinate of the drag event relative to its start position.
- Y coordinate of the drag event relative to its start position.
- Speed of the drag event.
- Speed of the drag event on the X axis.
- Speed of the drag event on the Y axis.
- Type of event (one of the [InputEvent] constants).
- X coordinate of the drag event.
- Y coordinate of the drag event.
Empty input event.
Key event.
Mouse motion event.
Mouse button event.
Joystick motion event.
Joystick button event.
Screen touch event.
Screen drag event.
Pre-defined action event (see [InputMap]).
Built-in input event type for touchscreen drag events.
Input event type for touchscreen drag events that extends the global [InputEvent] type.
Return if this input event matches a pre-defined action.
Return whether the given action is being pressed.
Return whether the given action is released (i.e. not pressed).
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
Return if this input event is pressed.
Change the input event to an action event of the given name with the pressed status passed as argument.
- Event identifier, positive integer increased at each new event.
- Device identifier.
- Touch event index in the case of a multi-touch event.
- Position of the touch event.
- Pressed state of the touch event.
- Type of event (one of the [InputEvent] constants).
- X coordinate of the touch event.
- Y coordinate of the touch event.
Empty input event.
Key event.
Mouse motion event.
Mouse button event.
Joystick motion event.
Joystick button event.
Screen touch event.
Screen drag event.
Pre-defined action event (see [InputMap]).
Singleton that manages actions.
Singleton that manages actions. InputMap has a list of the actions used in InputEvent, which can be modified.
Add an [InputEvent] to an action. This [InputEvent] will trigger the action.
Remove an [InputEvent] from an action.
Whether an action has an [InputEvent] associated with it.
Add an (empty) action to the [InputMap]. An [InputEvent] can then be added to this action with [method action_add_event].
Remove an action from the [InputMap].
Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior.
Return the action corresponding to the identifier.
Return the identifier of the given action.
Return an array of InputEvents associated with a given action.
Return an array of all actions in the [InputMap].
Whether this InputMap has a registered action with the given name.
Clear the [InputMap] and load it anew from [Globals].
Placeholder for the root [Node] of a [PackedScene].
Turning on the option [b]Load As Placeholder[/b] for an instanced scene in the editor causes it to be replaced by an InstacePlaceholder when running the game. This makes it possible to delay actually loading the scene until calling [method replace_by_instance]. This is useful to avoid loading large scenes all at once by loading parts of it selectively. The InstancePlaceholder does not have a transform. This causes any child nodes to be positioned relatively to the Viewport from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again.
Retrieve the path to the [PackedScene] resource file that is loaded by default when calling [method replace_by_instance].
Replace this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided.
Integer Array.
Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory.
Create from a generic array.
Append an element at the end of the array (alias of [method push_back]).
Append an [IntArray] at the end of this array.
Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
Reverse the order of the elements in the array (so first element will now be the last).
Append a value to the array.
Remove an element from the array by index.
Set the size of the [IntArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
Change the int at the given index.
Return the array size.
Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns.
This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, or both text and icon. Tooltips are supported and may be different for every item in the list. Selectable items in the list may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key).
Adds an item to the item list with no text, only an icon.
Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. If selectable is true the list item will be selectable.
Remove all items from the list.
Ensure selection is visible, adjusting the scroll position as necessary.
Return whether or not items may be selected via right mouse clicking.
If column size has been fixed to a value, return that value.
Given a position within the control return the item (if any) at that point.
Return count of items currently in the item list.
Return the text for specified item index.
Return tooltip hint for specified item index.
Return total number of columns in use by the list.
Return total number of lines currently in use by the list.
Returns the list of selected indexes.
Returns the current vertical scroll bar for the List.
Returns whether or not the item at the specified index is disabled
Returns whether or not the item at the specified index is selectable.
Returns whether the tooptip is enabled for specified item index.
Returns whether or not all columns of the list are of the same size.
Returns whether or not item at the specified index is currently selected.
Remove item at specified index from the list.
Select the item at the specified index. Note: This method does not trigger the item selection signal.
Allow (or disallow) selection of (selectable) items in the list using right mouse button.
Set the size (width) all columns in the list are to use.
Disable (or enable) item at specified index. Disabled items are not be selectable and do not fire activation (Enter or double-click) signals.
Set (or replace) icon of the item at the specified index.
Sets a value (of any type) to be stored with the item at the specified index.
Allow or disallow selection of the item at the specified index.
Sets text of item at specified index.
Sets tooltip hint for item at specified index.
Sets whether the tooltip is enabled for specified item index.
Set maximum number of columns to use for the list.
Set maximum number of lines to use for the list.
Sets a fixed size (width) to use for all columns of the list.
Sorts items in the list by their text.
Ensure item at specified index is not selected.
Fired when specified list item is activated via double click or Enter.
Fired when specified list item has been selected via right mouse clicking. The click position is also provided to allow appropriate popup of context menus at the correct location.
Fired when specified item has been selected.
Fired when a multiple selection is altered on a list allowing mutliple selection.
Base node for all joint constraints in 2D physics.
Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint.
Return the path to the A node for the joint.
Return the path to the B node for the joint.
Set the path to the A node for the joint. Must be of type [PhysicsBody2D].
Set the path to the B node for the joint. Must be of type [PhysicsBody2D].
Kinematic body 3D node.
Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). Kinematic Characters: KinematicBody also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics.
Return if this body can collide with character bodies.
Return if this body can collide with kinematic bodies.
Return if this body can collide with rigid bodies.
Return if this body can collide with static bodies.
Returns whether the KinematicBody can be teleported to the destination given as an argument, checking all collision shapes of the body against potential colliders at the destination.
Return the body that collided with this one.
Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding].
Return the velocity of the body that collided with this one.
Return the collision margin for this object.
Return the normal of the surface the body collided with. This is useful to implement sliding along a surface.
Return the point in space where the body is touching another. If there is no collision, this method will return (0,0,0), so collisions must be checked first with [method is_colliding].
Return whether the body is colliding with another.
Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped.
Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped.
Set if this body should collide with character bodies.
Set if this body should collide with kinematic bodies.
Set if this body should collide with rigid bodies.
Set if this body should collide with static bodies.
Set the collision margin for this object. A collision margin is an amount that all shapes will grow when computing collisions, to account for numerical imprecision.
Kinematic body 2D node.
Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). Kinematic Characters: KinematicBody2D also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics.
Return the body that collided with this one.
Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Additionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata].
Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding].
Return the velocity of the body that collided with this one.
Return the collision margin for this object.
Return the normal of the surface the body collided with. This is useful to implement sliding along a surface.
Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with [method is_colliding].
Return the last movement done by the body.
Return whether the body is colliding with another.
Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped.
Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped.
Undo the last movement done by the body.
Set the collision margin for this object. A collision margin is an amount (in pixels) that all shapes will grow when computing collisions, to account for numerical imprecision.
Return true if there would be a collision if the body moved from the given point in the given direction.
Control that displays formatted text.
Label is a control that displays formatted text, optionally autowrapping it to the [Control] area. It inherits from range to be able to scroll wrapped text vertically.
Return the alignment mode (any of the ALIGN_* enumeration values).
Return the amount of lines.
Return the height of a line.
Return the the number of lines to skipped before displaying.
Return the restricted number of lines to display. Returns -1 if unrestricted.
Return the restricted number of characters to display (as a percentage of the total text).
Return the label text. Text can contain newlines.
Return the total length of the text.
Return the vertical alignment mode (any of the VALIGN_* enumeration values).
Return the restricted number of characters to display. Returns -1 if unrestricted.
Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]).
Return true if text would be cut off if it is too wide.
Return true if text is displayed in all capitals.
Sets the alignment mode to any of the ALIGN_* enumeration values.
Set [i]autowrap[/i] mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows.
Cuts off the rest of the text if it is too wide.
Sets the number of lines to skip before displaying. Useful for scrolling text.
Restricts the number of lines to display. Set to -1 to disable.
Restricts the number of characters to display (as a percentage of the total text).
Set the label text. Text can contain newlines.
Display text in all capitals.
Sets the vertical alignment mode to any of the VALIGN_* enumeration values.
Restricts the number of characters to display. Set to -1 to disable.
Align rows to the left (default).
Align rows centered.
Align rows to the right (default).
Expand row whitespaces to fit the width.
Align the whole text to the top.
Align the whole text to the center.
Align the whole text to the bottom.
Align the whole text by spreading the rows.
A Texture capable of storing many smaller Textures with offsets.
A Texture capable of storing many smaller Textures with offsets. You can dynamically add pieces(Textures) to this fLargeTexture] using different offsets.
Add another [Texture] to this [LargeTexture], starting on offset "ofs".
Clear the [LargeTexture].
Return the number of pieces currently in this [LargeTexture].
Return the offset of the piece with index "idx".
Return the [Texture] of the piece with index "idx".
Set the offset of the piece with index "idx" to "ofs".
Set the [Texture] of the piece with index "idx" to "ofs".
Set the size of this [LargeTexture].
Provides a base class for different kinds of light nodes.
Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting.
Node that casts light in a 2D environment.
Node that casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask.
Return the color of the Light2D.
Return the energy value of the Light2D.
Return the height of the Light2D. Used with 2D normalmapping.
Return the item mask of the Light2D.
Return the item shadow mask of the Light2D.
Set the maximum layer value of objects of the scene that are affected by the Light2D.
Get the minimum layer value of objects of the scene that are affected by the Light2D.
Return the current mode set to the Light2D.
Return the shadow buffer size.
Return the color of casted shadows for this Light2D.
Return the Exponential Shadow Multiplier (ESM) value of the Light2D.
Return the texture of the Light2D.
Return the offset of the light texture.
Return the scale value of the light texture.
Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D.
Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D.
Return true if the Light2D is enabled, false if it is not.
Return true if shadow casting is enabled for this Light2D, else return false.
Set the color of the Light2D.
Switches the Light2D on or off, depending on the 'enabled' parameter.
Set the energy value of the Light2D. The bigger the value, the stronger the light.
Set the height of the Light2D. Used with 2D normalmapping.
Set the item mask of the Light2D to 'item_mask' value.
Set the item shadow mask to 'item_shadow_mask' value.
Set the maximum layer value of objects of the scene that are affected by the Light2D.
Set the minimum layer value of objects of the scene that are affected by the Light2D.
Set the behaviour mode of the Light2D. Use constants defined in the constants section.
Set the shadow buffer size.
Set the color of casted shadows for this Light2D.
Enable or disable shadows casting from this Light2D according to the 'enabled' parameter.
Set the Exponential Shadow Multiplier (ESM) value of the Light2D.
Set the texture of the Light2D.
Set the offset of the light texture.
Set the scale value of the light texture.
Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D.
Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D.
Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light.
Substract the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.
The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture.
Occludes light cast by a Light2D, thus casting shadows.
Occludes light cast by a Light2D, thus casting shadows. The LightOccluder2D must be provided with a shape (see OccluderPolygon2D) that allows the shadow to be computed. This shape affects the resulting shadow, while the shape of the representating asset shadowed does not actually affect shadows.
Return the light mask of the LightOccluder2D.
Return the OccluderPolygon2D that defines the LightOccluder2D.
Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s).
Set the OccluderPolygon2D that defines the LightOccluder2D.
Control that provides single line string editing.
LineEdit provides a single line string editor, used for text fields.
Append text at cursor, scrolling the [LineEdit] when needed.
Clear the [LineEdit] text.
Gets whether the line edit caret is blinking.
Gets the line edit caret blink speed.
Set the line edit caret to blink.
Set the line edit caret blink speed. Cannot be less then or equal to 0.
Return the cursor position inside the [LineEdit].
Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists.
Return the text in the [LineEdit].
Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]).
Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]).
Select the whole string.
Set the cursor position inside the [LineEdit], causing it to scroll if needed.
Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added.
Set the maximum amount of characters the [LineEdit] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit.
Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*".
Set the text in the [LineEdit], clearing the existing one and the selection.
When the text changes, this signal is emitted.
This signal is emitted when the user presses KEY_ENTER on the [LineEdit]. This signal is often used as an alternate confirmation mechanism in dialogs.
Line shape for 2D collision objects.
Line shape for 2D collision objects. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame.
Return the line distance from the origin.
Return the line normal.
Set the line distance from the origin.
Set the line normal.
Simple button used to represent a link to some resource
This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page).
Returns the text of the button.
Returns the underline mode for this button.
Sets the text of the button.
Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section).
The LinkButton will always show an underline at the bottom of its text
The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it.
The LinkButton will never show an underline at the bottom of its text.
Main loop is the abstract main loop base class.
Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [MainLoop] has to be provided to OS, else the application will exit. This happens automatically (and a [SceneTree] is created), unless a main [Script] is supplied, which may or not create and return a [MainLoop].
Simple margin container.
Simple margin container. Adds a left margin to anything contained.
Abstract base [Resource] for coloring and shading geometry.
Material is a base [Resource] used for coloring and shading geometry. All materials inherit from it and almost all [VisualInstance] derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here.
Return blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations.
Return a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list.
Return the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX).
Set blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations.
Set a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list.
Set the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX).
Geometry is visible when this flag is enabled (default).
Both front facing and back facing triangles are rendered when this flag is enabled.
Front facing and back facing order is swapped when this flag is enabled.
Shading (lighting) is disabled when this flag is enabled.
Maximum amount of flags.
Use the regular alpha blending equation (source and dest colors are faded) (default).
Use additive blending equation, often used for particle effects such as fire or light decals.
Use subtractive blending equation, often used for some smoke effects or types of glass.
3x3 matrix datatype.
3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z. Can also be accessed as array of 3D vectors. Almost always used as orthogonal basis for a [Transform].
Create a matrix from a quaternion.
Create a matrix which rotates around the given axis by the specified angle.
Create a matrix from 3 axis vectors.
Return the determinant of the matrix.
Return euler angles (in the XYZ convention: first Z, then Y, and X last) from the matrix. Returned vector contains the rotation angles in the format (third,second,first).
Return the affine inverse of the matrix.
Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix.
Return the scaled version of the matrix, by a 3D scale.
Transposed dot product with the x axis of the matrix.
Transposed dot product with the y axis of the matrix.
Transposed dot product with the z axis of the matrix.
Return the transposed version of the matrix.
Return a vector transformed by the matrix and return it.
Return a vector transformed by the transposed matrix and return it.
3x2 Matrix for 2D transforms.
3x2 Matrix for 2D transforms.
Special button that brings up a [PopupMenu] when clicked.
Special button that brings up a [PopupMenu] when clicked. That's pretty much all it does, as it's just a helper class when building GUIs.
Return the [PopupMenu] contained in this button.
A [Resource] that contains vertex-array based geometry.
Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials.
Create a new surface ([method get_surface_count] that will become surf_idx for this. Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed.
Return the amount of surfaces that the [Mesh] holds.
Return the length in indices of the index array in the requested surface (see [method add_surface]).
Return the length in vertices of the vertex array in the requested surface (see [method add_surface]).
Return the format mask of the requested surface (see [method add_surface]).
Return a [Material] in a given surface. Surface is rendered using this material.
Return the primitive type of the requested surface (see [method add_surface]).
Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
Set a [Material] for a given surface. Surface will be rendered using this material.
Default value used for index_array_len when no indices are present.
Amount of weights/bone indices per vertex (always 4).
Vertex array (array of [Vector3] vertices).
Normal array (array of [Vector3] normals).
Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
Vertex array (array of [Color] colors).
UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)).
Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)).
Array of bone indices, as a float array. Each element in groups of 4 floats.
Array of bone weights, as a float array. Each element in groups of 4 floats.
Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
Array format will include vertices (mandatory).
Array format will include normals
Array format will include tangents
Array format will include a color array.
Array format will include UVs.
Array format will include another set of UVs.
Array format will include bone indices.
Array format will include bone weights.
Index array will be used.
Render array as points (one vertex equals one point).
Render array as lines (every two vertices a line is created).
Render array as line strip.
Render array as line loop (like line strip, but closed).
Render array as triangles (every three vertices a triangle is created).
Render array as triangle strips.
Render array as triangle fans.
Node that instances meshes into a scenario.
MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead.
This helper creates a [StaticBody] child [Node] using the mesh geometry as collision. It's mainly used for testing.
Return the AABB of the mesh, in local coordinates.
Return the current [Mesh] resource for the instance.
Set the [Mesh] resource for the instance.
Library of meshes.
Library of meshes. Contains a list of [Mesh] resources, each with name and ID. Useful for GridMap or painting Terrain.
Clear the library.
Create a new item in the library, supplied an id.
Return the list of items.
Return the mesh of the item.
Return the name of the item.
Get an unused id for a new item.
Remove the item.
Set the mesh of the item.
Set the name of the item.
Provides high performance mesh instancing.
MultiMesh provides low level mesh instancing. If the amount of [Mesh] instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance] nodes may affect performance by using too much CPU or video memory. For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead. As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [method generate_aabb].
Generate a new visibility AABB, using mesh AABB and instance transforms. Since instance information is stored in the [VisualServer], this function is VERY SLOW and must NOT be used often.
Return the visibility AABB.
Get the color of a specific instance.
Return the amount of instances that is going to be drawn.
Return the transform of a specific instance.
Return the [Mesh] resource drawn as multiple instances.
Set the visibility AABB. If not provided, MultiMesh will not be visible.
Set the color of a specific instance.
Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data.
Set the transform for a specific instance.
Set the [Mesh] resource to be drawn in multiple instances.
Node that instances a [MultiMesh].
MultiMeshInstance is a [Node] that takes a [MultiMesh] resource and adds it to the current scenario by creating an instance of it (yes, this is an instance of instances).
Return the [MultiMesh] that is used for instancing.
Set the [MultiMesh] to be instance.
A synchronization Mutex.
A synchronization Mutex. Element used in multi-threadding. Basically a binary [Semaphore]. Guarantees that only one thread has this lock, can be used to protect a critical section.
Lock this [Mutex], blocks until it is unlocked by the current owner.
Try locking this [Mutex], does not block. Returns [OK] on success else [ERR_BUSY].
Unlock this [Mutex], leaving it to others threads.
PacketPeer implementation using the ENet library.
A connection (or a listening server) that should be passed to [method SceneTree.set_network_peer]. Socket events can be handled by connecting to [SceneTree] signals.
Base class for all the [i]scene[/i] elements.
Nodes are the base bricks with which Godot games are developed. They can be set as children of other nodes, resulting in a tree arrangement. A given node can contain any number of nodes as children (but there is only one scene tree root node) with the requirement that all siblings (direct children of a node) should have unique names. Any tree of nodes is called a [i]scene[/i]. Scenes can be saved to the disk and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of the projects. Nodes can optionally be added to groups. This makes it easy to reach a number of nodes from the code (for example an "enemies" group) to perform grouped actions. [b]Scene tree:[/b] The [SceneTree] contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its [method _enter_tree] callback is triggered. Children nodes are always added [i]after[/i] their parent node, i.e. the [method _enter_tree] callback of a parent node will be triggered before its child's. Once all nodes have been added in the scene tree, they receive the NOTIFICATION_READY notification and their respective [method _ready] callbacks are triggered. For groups of nodes, the [method _ready] callback is called in reverse order, from the children up to the parent nodes. It means that when adding a scene to the scene tree, the following order will be used for the callbacks: [method _enter_tree] of the parent, [method _enter_tree] of the children, [method _ready] of the children and finally [method _ready] of the parent (and that recursively for the whole scene). [b]Processing:[/b] Nodes can be set to the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback [method _process], toggled with [method set_process]) happens as fast as possible and is dependent on the frame rate, so the processing time [i]delta[/i] is variable. Fixed processing (callback [method _fixed_process], toggled with [method set_fixed_process]) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. Nodes can also process input events. When set, the [method _input] function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the [method _unhandled_input] function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI [Control] nodes), ensuring that the node only receives the events that were meant for it. To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with [method set_owner]. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed with [method free] or [method queue_free], it will also free all its children. [b]Networking with nodes:[/b] After connecting to a server (or making one, see [NetworkedMultiplayerENet]) it is possible to use the built-in RPC (remote procedure call) system to easily communicate over the network. By calling [method rpc] with a method name, it will be called locally, and in all connected peers (peers = clients and the server that accepts connections), with behaviour varying depending on the network mode ([method set_network_mode]) on the receiving peer. To identify which [Node] receives the RPC call Godot will use it's [NodePath] (make sure node names are the same on all peers).
Called when the node enters the [SceneTree] (e.g. upon instancing, scene changing or after calling [method add_child] in a script). If the node has children, its [method _enter_tree] callback will be called first, and then that of the children. Corresponds to the NOTIFICATION_ENTER_TREE notification in [method Object._notification].
Called when the node leaves the [SceneTree] (e.g. upon freeing, scene changing or after calling [method remove_child] in a script). If the node has children, its [method _exit_tree] callback will be called last, after all its children have left the tree. Corresponds to the NOTIFICATION_EXIT_TREE notification in [method Object._notification].
Called during the fixed processing step of the main loop. Fixed processing means that the frame rate is synced to the physics, i.e. the [code]delta[/code] variable should be constant. It is only called if fixed processing has been enabled with [method set_fixed_process]. Corresponds to the NOTIFICATION_FIXED_PROCESS notification in [method Object._notification].
Called for every input event. It has to be enabled with [method set_process_input] or the corresponding property in the inspector.
Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [code]delta[/code] time since the previous frame is not constant. It is only called if processing has been enabled with [method set_process]. Corresponds to the NOTIFICATION_PROCESS notification in [method Object._notification].
Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their [method _ready] callback gets triggered first, and the node will receive the ready notification only afterwards. Corresponds to the NOTIFICATION_READY notification in [method Object._notification].
Called for every input event that has not already been handled by another node. It has to be enabled with [method set_process_unhandled_input] or the corresponding property in the inspector.
Called for every [i]key[/i] input event that has not already been handled by another node. It has to be enabled with [method set_process_unhandled_key_input] or the corresponding property in the inspector.
Add a child [Node]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. The optional boolean argument enforces creating child nodes with human-readable names, based on the name of the node being instanced instead of its type only.
Add a node to a group. Groups are helpers to name and organize a subset of nodes, like for example "enemies" or "collectables". A [Node] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_tree]).
Return true if the node can process, i.e. whether its pause mode allows processing while the scene tree is paused (see [method set_pause_mode]). Always returns true if the scene tree is not paused, and false if the node is not in the tree. FIXME: Why FAIL_COND?
Duplicate the node, returning a new [Node]. If [code]use_instancing[/code] is true, the duplicated node will be a new instance of the original [PackedScene], if not it will be an independent node. The duplicated node has the same group assignments and signals as the original one.
Find a descendant of this node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names.
Return a child node by its index (see [method get_child_count]). This method is often used for iterating all children of a node.
Return the amount of child nodes.
Return an array of references ([Node]) to the child nodes.
Return a filename that may be contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [method set_filename]).
Return the time elapsed since the last fixed frame (see [method _fixed_process]). This is always the same in fixed processing unless the frames per second is changed in [OS].
Return an array listing the groups that the node is part of.
Get the node index, i.e. its position among the siblings of its parent.
Return the name of the node. This name is unique among the siblings (other child nodes from the same parent).
Fetch a node. The [NodePath] must be valid (or else an error will be raised) and can be either the path to child node, a relative path (from the current node to another node), or an absolute path to a node. Note: fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). [i]Example:[/i] Assume your current node is Character and the following tree: [codeblock] /root /root/Character /root/Character/Sword /root/Character/Backpack/Dagger /root/MyGame /root/Swamp/Alligator /root/Swamp/Mosquito /root/Swamp/Goblin [/codeblock] Possible paths are: [codeblock] get_node("Sword") get_node("Backpack/Dagger") get_node("../Swamp/Alligator") get_node("/root/MyGame") [/codeblock]
Get the node owner (see [method set_owner]).
Return the parent node of the current node, or an empty [Node] if the node lacks a parent.
Return the absolute path of the current node. This only works if the current node is inside the scene tree (see [method is_inside_tree]).
Return the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or else the function will fail.
Return the time elapsed (in seconds) since the last process callback. This is almost always different each time.
Return [i]true[/i] if the "node" argument is a direct or indirect child of the current node, otherwise return [i]false[/i].
Return true if fixed processing is enabled (see [method set_fixed_process]).
Return [i]true[/i] if "node" occurs later in the scene hierarchy than the current node, otherwise return [i]false[/i].
Return whether processing is enabled in the current node (see [method set_process]).
Return true if the node is processing input (see [method set_process_input]).
Return true if the node is processing unhandled input (see [method set_process_unhandled_input]).
Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful.
Print the scene to stdout. Used mainly for debugging purposes.
Notify the current node and all its children recursively by calling notification() in all of them.
Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs ([Control]), because their order of drawing fully depends on their order in the tree.
Remove a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed.
Remove a child [Node]. Node is NOT deleted and will have to be deleted manually.
Remove a node from a group.
Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost.
Send a remote procedure call request to all peers on the network (and locally), optionally sending additional data as arguments. Call request will be received by nodes with the same [NodePath].
Change the method's RPC mode (one of RPC_MODE_* constants).
Send a [method rpc] to a specific peer identified by [i]peer_id[/i].
Send a [method rpc] using an unreliable protocol.
Send a [method rpc] to a specific peer identified by [i]peer_id[/i] using an unreliable protocol.
Remotely change property's value on other peers (and locally).
Change the property's RPC mode (one of RPC_MODE_* constants).
Remotely change property's value on a specific peer identified by [i]peer_id[/i].
Remotely change property's value on other peers (and locally) using an unreliable protocol.
Remotely change property's value on a specific peer identified by [i]peer_id[/i] using an unreliable protocol.
A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded.
Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_delta_time].
Set the name of the [Node]. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed.
Change the networking mode of the [Node], where [i]mode[/i] is one of the constants NETWORK_MODE_*. Master nodes will only call gdscript methods defined as [i]master func[/i] if a RPC call is received (slave nodes will only call [i]slave func[/i]; both will call [i]remote func[/i] if the call is not local, and [i]sync func[/i] in any case). Inherit mode looks at the parent node to determine the value (root node depends on the [SceneTree] having a networking peer set with [method SceneTree.set_network_peer])
Set the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing.
Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_process_delta_time].
Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]).
Enable unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]).
Emitted when the node is renamed.
Notification received every frame when the process flag is set (see [method set_process]).
Notification received when a node is set as a child of another node. Note that this doesn't mean that a node entered the Scene Tree.
Notification received when a node is unparented (parent removed it from the list of children).
Base node for 2D system.
Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierarchies for animation and positioning.
Set the pivot position of the 2D node to 'pivot' value. This method is implemented only in some nodes that inherit Node2D.
Return the rotation angle in radians needed for the 2d node to point at 'point' position.
Return the global position of the 2D node.
Return the global rotation in radians of the 2D node.
Return the global rotation in degrees of the 2D node.
Return the global scale of the 2D node.
Return the position of the 2D node.
Return the transform [Matrix32] calculated relatively to the parent of this 2D node.
Return the rotation of the 2D node.
Return the scale of the 2D node.
Return the Z-index of the 2D node.
Apply a global translation of 'offset' to the 2D node, starting from its current global position.
Return true if the Z-index value of this 2D node is relative to its parent's. Else, return false.
Rotate the 2d node so it points at 'point' position.
Apply a local translation on X axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized.
Apply a local translation on Y axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized.
Apply a 'radians' rotation to the 2D node, starting from its current rotation.
Apply the 'ratio' scale to the 2D node, according to its current scale value.
Set the global position of the 2D node to 'pos'.
Set the global rotation in radians of the 2D node.
Set the global rotation in degrees of the 2D node.
Set the global scale of the 2D node.
Set the global transform [Matrix32] of the 2D node.
Set the position of the 2D node.
Set the rotation of the 2D node.
Set the rotation of the 2D node.
Set the scale of the 2D node.
Set the local transform [Matrix32] of the 2D node.
Set the Z-index value of the 2D node.
Set the Z-index value as relative to the parent node of this 2D node. Thus, if this 2D node's Z-index value is 2 and its parent's effective Z-index is 3, then the effective Z-index value of this 2D node would be 3 + 2 = 5.
Apply a local translation of 'offset' to the 2D node, starting from its current local position.
Pre-parsed scene tree path.
A pre-parsed relative or absolute path in a scene tree, for use with [method Node.get_node] and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, [code]"Path2D/PathFollow2D/Sprite:texture:size"[/code] would refer to the size property of the texture resource on the node named "Sprite" which is a child of the other named nodes in the path. Note that if you want to get a resource, you must end the path with a colon, otherwise the last element will be used as a property name. You will usually just pass a string to [method Node.get_node] and it will be automatically converted, but you may occasionally want to parse a path ahead of time with [NodePath] or the literal syntax [code]@"path"[/code]. Exporting a [NodePath] variable will give you a node selection widget in the properties panel of the editor, which can often be useful. A [NodePath] is made up of a list of node names, a list of "subnode" (resource) names, and the name of a property in the final node or resource.
Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent.
Get the node name indicated by [code]idx[/code] (0 to [method get_name_count])
Get the number of node names which make up the path.
Get the path's property name, or an empty string if the path doesn't have a property.
Get the resource name indicated by [code]idx[/code] (0 to [method get_subname_count])
Get the number of resource names in the path.
Return true if the node path is absolute (not relative).
Return true if the node path is empty.
Operating System functions.
Operating System functions. OS Wraps the most common functionality to communicate with the host Operating System, such as: mouse grabbing, mouse cursors, clipboard, video mode, date and time, timers, environment variables, execution of binaries, command line, etc.
Displays a modal dialog box utilizing the host OS.
Return true if the host OS allows drawing.
Returns if the current host platform is using multiple threads.
Delay executing of the current thread by given milliseconds.
Delay executing of the current thread by given microseconds.
Dumps the memory allocation ringlist to a file (only works in debug). Entry format per line: "Address - Size - Description"
Dumps all used resources to file (only works in debug). Entry format per line: "Resource Type : Resource Location" At the end of the file is a statistic of all used Resource Types.
Execute the binary file in given path, optionally blocking until it returns. A process ID is returned.
Returns the scancode of the given string (e.g. "Escape")
Returns true if the current window is borderless.
Get clipboard from the host OS.
Return the commandline passed to the engine.
Returns the current screen index (0 padded).
Returns the value of the commandline argument "-level".
Return the absolute directory path of user data path([user://]).
Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time).
Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second.
Get a dictionary of time values when given epoch time. Dictionary Time values will be a union of values from [method get_time] and [method get_date] dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch).
Return the total amount of dynamic memory used (only works in debug).
Returns the current engine version information in a Dictionary.

"major" - Holds the major version number as a String "minor" - Holds the minor version number as a String "patch" - Holds the patch version number as a String "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String "revision" - Holds the revision (e.g. "custom-build") as a String "string" - major + minor + patch + status + revision in a single String
Return an environment variable.
Return the path to the current engine executable.
Return the total amount of frames drawn.
Returns the frames per second of the running game.
Return the list of fullscreen modes.
Return the amount of fixed iterations per second (for fixed process and physics).
Returns the current latin keyboard variant as a String. Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO" or "ERROR"
Return the host OS locale.
Return the main loop object (see [MainLoop]).
Returns the model name of the current device.
Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11"
Returns the game process ID
Returns the number of cores available in the host machine.
Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape").
Returns the number of displays attached to the host machine
Returns the dots per inch density of the specified screen.

On Android Devices, the actual screen densities are grouped into six generalized densities: ldpi - 120 dpi mdpi - 160 dpi hdpi - 240 dpi xhdpi - 320 dpi xxhdpi - 480 dpi xxxhdpi - 640 dpi
Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class.
Returns the dimensions in pixels of the specified screen.
Return the max amount of static memory used (only works in debug).
Return the amount of time passed in milliseconds since the engine started.
Returns current time as a dictionary of keys: hour, minute, second
Return the current unix timestamp.
Get an epoch time value from a dictionary of time values. [code]datetime[/code] must be populated with the following keys: year, month, day, hour, minute, second. You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored.
Return the current video mode size.
Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right.
Returns the size of the window (without counting window manager decorations).
Return true if an environment variable exists.
Returns true if the platform has a virtual keyboard, false otherwise.
Hides the virtual keyboard if it is shown, does nothing otherwise.
Return true if low cpu usage mode is enabled.
Returns whether the screen is being kept on or not.
Return true if the engine was executed with -v (verbose stdout).
Return true if the current video mode is fullscreen.
Return true if the window is resizable.
Returns whether the window is in fullscreen mode or not.
Return true if the window is maximized.
Return true if the window is minimized.
Returns whether the window is resizable or not.
Kill a process ID (this method can be used to kill processes that were not spawned by the game).
Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX.
Set clipboard to the OS.
Set the amount of fixed iterations per second (for fixed process and physics).
Set keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS)
Set to true to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. This way, editors using the engine UI only use very little cpu.
Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class.
Speeds up or slows down the physics by changing the delta variable. (delta * time_scale)
Change the video mode.
Sets window fullscreen mode to the [i]enabled[/i] argument, [i]enabled[/i] is a toggle for the fullscreen mode, calling the function with [i]enabled[/i] true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with [i]enabled[/i] false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode.
Set the window size to maximized.
Set whether the window is minimized.
Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen).
Set the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings.
Sets the window size to the specified size.
Sets the window title to the specified string.
Shows the virtual keyboard if the platform has one. The [i]existing_text[/i] parameter is useful for implementing your own LineEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions).
Base class for all non built-in types.
Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [method free] function from the script or delete from C++). Some derivates add memory management, such as [Reference] (which keeps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted. Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [method _get_property_list] and handled in [method _get] and [method _set]. However, scripting languages and C++ have simpler means to export them. Objects also receive notifications ([method _notification]). Notifications are a simple way to notify the object about simple events, so they can all be handled together.
Deprecated, will go away.
Return a property, return null if the property does not exist.
Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals).
Notification request, the notification id is received.
Set a property. Return true if the property was found.
Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*).
Return true if this object can translate strings.
Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT_*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use [method is_connected] to check.
Disconnect a signal from a method.
Get a property from the object.
Return the instance ID. All objects have a unique instance ID.
Return a metadata from the object.
Return the list of metadata in the object.
Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals).
Return the object script (or null if it doesn't have one).
Return the list of signals as an array of dictionaries.
Return the type of the object as a string.
Return true if a metadata is found with the requested name.
Return true if signal emission blocking is enabled.
Return true if a connection exists for a given signal and target/method.
Check the type of the object against a string (including inheritance).
Notify the object of something.
Set property into the object.
If set to true, signal emission is blocked.
Set true if this object can translate strings (in calls to tr() ). Default is true.
Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i].
Set a script into the object, scripts extend the object functionality.
Translate a message. Only works in message translation is enabled (which is by default). See [method set_message_translation].
Called right when the object is initialized. Not available in script.
Called before the object is about to be deleted.
Connect a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time.
Persisting connections are saved when the object is serialized to file.
One short connections disconnect themselves after emission.
OmniDirectional Light, such as a light bulb or a candle.
An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of an omnilight.
Button control that provides selectable options when pressed.
OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text.
Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end.
Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end.
Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end.
Clear all the items in the [OptionButton].
Return the ID of the item at index "idx".
Return the amount of items in the OptionButton.
Return the icon of the item at index "idx".
Return the text of the item at index "idx".
Return the current item index
Select an item by index and make it the current item.
Set the ID of an item at index "idx".
Set the icon of an item at index "idx".
Set the text of an item at index "idx".
This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index).
Optimized translation.
Optimized translation. Uses real-time compressed translations, which results in very small dictionaries.
TODO: explain ownership, and that node does not need to own itself
Pack will ignore any sub-nodes not owned by given node. See [method Node.set_owner].
Abstraction and base class for packet-based protocols.
PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering.
Return the number of packets currently available in the ring-buffer.
Get a raw packet.
Return the error state of the last packet received (via [method get_packet] and [method get_var]).
Get a Variant.
Send a raw packet.
Send a Variant as a packet.
Wrapper to use a PacketPeer over a StreamPeer.
PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly.
Set the StreamPeer object to be wrapped
UDP packet peer.
UDP packet peer. Can be used to send raw UDP packets as well as [Variant]s.
Close the UDP socket the [PacketPeerUDP] is currently listening on.
Return the address of the remote peer(as a 32bit integer) that sent the last packet(that was received with [method get_packet] or [method get_var]).
Return the IP of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]).
Return the port of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]).
Return whether this [PacketPeerUDP] is listening.
Make this [PacketPeerUDP] listen on the "port" with a buffer size "recv_buf_size". Listens on all available addresses.
Set the destination address and port for sending packets and variables, a hostname will be resolved using if valid.
Wait for a packet to arrive on the listening port, see [method listen].
Provides an opaque background for [Control] children.
Panel is a [Control] that displays an opaque background. It's commonly used as a parent and container for other types of [Control] nodes.
Panel container type.
Panel container type. This container fits controls inside of the delimited area of a stylebox. It's useful for giving controls an outline.
A node used to create a parallax scrolling background.
A ParallaxBackground will use one or more [ParallaxLayer] nodes to create a parallax scrolling background. Each [ParallaxLayer] can be set to move at different speeds relative to the camera movement, this can be used to create an illusion of depth in a 2D game.
Return the beginning limit.
Return the ending limit.
Return the base offset.
Return the base motion scale.
Return ignoring camera zoom.
Set to true for all child [ParallaxLayer] nodes to not be affected by the zoom level of the camera.
Set the left and top limits in pixels for scrolling to begin. If the camera is outside of this limit the background will not continue to scroll. If an axis is greater than or equal to the corresponding axis of limit_end, then it will not limit scrolling for that axis.
Set the right and bottom limits in pixels for scrolling to end. If the camera is outside of this limit the background will not continue to scroll. If an axis is less than or equal to the corresponding axis of limit_begin, then it will not limit scrolling for that axis.
Set the base offset in pixels of all children [ParallaxLayer] nodes.
Set the base motion scale of all children [ParallaxLayer] nodes.
A parallax scrolling layer to be used with [ParallaxBackground].
A ParallaxLayer must be the child of a [ParallaxBackground] node. All child nodes will be affected by the parallax scrolling of this layer.
Return the mirroring of the ParallaxLayer.
Return the motion scale of the ParallaxLayer.
Set the mirroring of the ParallaxLayer. If an axis is set to 0 then that axis will have no mirroring.
Set the motion scale of the ParallaxLayer. If an axis is set to 0 then it will not move at all, it will stick with the camera.
Particle system 3D Node
Particles is a particle system 3D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist).
Return the total amount of particles in the system.
Return the color of a color phase.
Return the position of a color phase (0 to 1).
Return the half extents for the emission box.
Return the normal vector towards where gravity is pulling (by default, negative Y).
Return the material used to draw particles.
Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted.
Return a specific variable for the particle system (see VAR_* enum).
Return the current visibility AABB.
Return the "emitting" property state (see [method set_emitting]).
Set total amount of particles in the system.
Set the color of a color phase.
Set the position of a color phase (0 to 1).
Set the half extents for the emission box.
Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate.
Set the normal vector towards where gravity is pulling (by default, negative Y).
Set the material used to draw particles.
Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted.
Set a specific variable for the particle system (see VAR_* enum).
Set the visibility AABB for the particle system, since the default one will not work properly most of the time.
2D Particle emitter
Particles2D is a particle system 2D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist).
Returns the amount of particles spawned at each emission
Returns the tint color for each particle.
Returns the [ColorRamp] used to tint each particle
Returns the half extents of the emission box.
Returns the particle spawn origin position relative to the emitter.
Returns the amount of seconds during which the emitter will spawn particles
Gets the amount of seconds that each particle will be visible.
Returns the value of the specified emitter parameter
Returns the randomness value of the specified emitter parameter
Returns the texture for emitted particles
Returns the emitter time scale
Returns whether this emitter is currently emitting or not
Sets the amount of particles spawned at each emission
Set the tint color for each particle.
Sets the [ColorRamp] used to tint each particle. Particle will be tinted according to their lifetimes.
Sets the half extents of the emission box, particles will be spawned at random inside this box.
Sets the particle spawn origin position relative to the emitter center. for example if this value is set to (50, 50), the particle will spawn 50 units to the right and 50 units to the bottom of the emitter center.
Sets the amount of seconds during which the emitter will spawn particles, after the specified seconds the emitter state will be set to non emitting, so calling [method is_emitting] will return false. If the timeout is 0 the emitter will spawn forever.
If this is set to true then the particle emitter will emit particles, if its false it will not.
Sets the amount of seconds that each particle will be visible.
Sets the value of the specified emitter parameter (see the constants secction for the list of parameters)
Sets the randomness value of the specified emitter parameter (see the constants secction for the list of parameters), 0 means no randomness, so every particle will have the parameters specified, 1 means that the parameter will be choosen at random, the closer the randomness value gets to 0 the more conservative the variation of the parameter will be.
Sets the texture for each particle
Sets the increment or decrement for the particle lifetime. for example: if the time scale is set to 2, the particles will die and move twice as fast.
Direction in degrees at which the particles will be launched, Notice that when the direction is set to 0 the particles will be launched to the negative
Velocity at which the particles will be launched.
The speed at which particles will spin around its own center.
Velocity at which the particles will orbit around the emitter center
Direction in degrees at which the particles will be attracted
Strength of the gravitation attraction for each particle
Amount of damping for each particle
Initial angle in radians at which each particle will be spawned
Initial size of each particle
Final size of each particle, the particle size will interpolate to this value during its lifetime.
Container for a [Curve3D].
This class is a container/Node-ification of a [Curve3D], so it can have [Spatial] properties and [Node] info.
Returns the [Curve3D] contained.
Sets the [Curve3D].
Container for a [Curve2D].
This class is a container/Node-ification of a [Curve2D], so it can have [Node2D] properties and [Node] info.
Returns the [Curve2D] contained.
Sets the [Curve2D].
Point sampler for a [Path].
This node takes its parent [Path], and returns the coordinates of a point within it, given a distance from the first vertex. It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly.
This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly.
Returns the X displacement this node has from its parent [Path].
Returns the distance along the path in 3D units.
Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode.
Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last).
Returns the Y displacement this node has from its parent [Path].
Returns whether this node wraps its offsets around, or truncates them to the path ends.
The points along the [Curve3D] of the [Path] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. This method controls whether the position between two cached points is interpolated linearly, or cubicly.
Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. A similar effect may be achieved moving the this node's descendants.
If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths.
Sets the distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path.
Allows or forbids rotation on one or more axes, per the constants below.
Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
Moves this node in the Y axis, for the same reasons of [method set_h_offset].
Forbids the PathFollow to rotate.
Allows the PathFollow to rotate in the Y axis only.
Allows the PathFollow to rotate in both the X, and Y axes.
Allows the PathFollow to rotate in any axis.
Point sampler for a [Path2D].
This node takes its parent [Path2D], and returns the coordinates of a point within it, given a distance from the first vertex. It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly.
This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly.
Returns the horizontal displacement this node has from its parent [Path2D].
Returns the distance along the path in pixels.
Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last).
Returns the vertical displacement this node has from its parent [Path2D].
Returns whether this node wraps its offsets around, or truncates them to the path ends.
Returns whether this node rotates to follow the path.
The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. This method controls whether the position between two cached points is interpolated linearly, or cubicly.
Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. A similar effect may be achieved moving this node's descendants.
If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths.
Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path.
If set, this node rotates to follow the path, making its descendants rotate.
Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset].
Singleton containing the list of remapped resources.
When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necessary to access to this directly (path remapping happens automatically when opening a file), it's exported just for information.
Add a remap from a file to another.
Clear all remaps.
Erase a remap.
Return the remapped new path of a file.
Return true if a file is being remapped.
Direct access object to a physics body in the [Physics2DServer].
Direct access object to a physics body in the [Physics2DServer]. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body.
Return the angular velocity of the body.
Return the [RID] of the collider.
Return the object id of the collider.
Return the collider object, this depends on how it was created (will return a scene node if such was used to create it).
Return the contact position in the collider.
Return the collider shape index.
Return the metadata of the collided shape. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data].
Return the linear velocity vector at contact point of the collider.
Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts.
Return the local normal (of this body) of the contact point.
Return the local position (of this body) of the contact point.
Return the local shape index of the collision.
Return the inverse of the inertia of the body.
Return the inverse of the mass of the body.
Return the current linear velocity of the body.
Return the current state of space, useful for queries.
Return the timestep (delta) used for the simulation.
Return the rate at which the body stops rotating, if there are not any other forces moving it.
Return the total gravity vector being currently applied to this body.
Return the rate at which the body stops moving, if there are not any other forces moving it.
Return the transform matrix of the body.
Call the built-in force integration code.
Return true if this body is currently sleeping (not active).
Change the angular velocity of the body.
Change the linear velocity of the body.
Set the sleeping state of the body, only affects character/rigid bodies.
Change the transform matrix of the body.
Software implementation of [Physics2DDirectBodyState].
Software implementation of [Physics2DDirectBodyState]. This object exposes no new methods or properties and should not be used, as [Physics2DDirectBodyState] selects the best implementation available.
Direct access object to a space in the [Physics2DServer].
Direct access object to a space in the [Physics2DServer]. It's used mainly to do queries against objects and areas residing in a given space.
Check whether the shape can travel to a point. If it can, the method will return an array with two floats: The first is the distance the shape can move in that direction without colliding, and the second is the distance at which it will collide. If the shape can not move, the array will be empty.
Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time.
Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. If it collides with more than a shape, the nearest one is selected. The returned object is a dictionary containing the following fields: pointo: Place where the shapes intersect. normal: Normal of the object at the point where the shapes intersect. shape: Shape index within the object against which the shape intersected. metadata: Metadata of the shape against which the shape intersected. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. collider_id: Id of the object against which the shape intersected. collider: Object against which the shape intersected. rid: [RID] of the object against which the shape intersected. linear_velocity: The movement vector of the object the shape intersected, if it was a body. If it was an area, it is (0,0). If the shape did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead.
Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: shape: Shape index within the object the point is in. metadata: Metadata of the shape the point is in. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. collider_id: Id of the object the point is in. collider: Object the point is inside of. rid: [RID] of the object the point is in. Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants).
Intersect a ray in a given space. The returned object is a dictionary with the following fields: position: Place where ray is stopped. normal: Normal of the object at the point where the ray was stopped. shape: Shape index within the object against which the ray was stopped. metadata: Metadata of the shape against which the ray was stopped. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. collider_id: Id of the object against which the ray was stopped. collider: Object against which the ray was stopped. rid: [RID] of the object against which the ray was stopped. If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants).
Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: shape: Shape index within the object the shape intersected. metadata: Metadata of the shape intersected by the shape given through the [Physics2DShapeQueryParameters]. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. collider_id: Id of the object the shape intersected. collider: Object the shape intersected. rid: [RID] of the object the shape intersected. The number of intersections can be limited with the second paramater, to reduce the processing time.
Check for collisions with static bodies.
Check for collisions with kinematic bodies.
Check for collisions with rigid bodies.
Check for collisions with rigid bodies in character mode.
Check for collisions with areas.
Check for collisions with any kind of bodies (but not areas).
Physics 2D Server.
Physics 2D Server is the server responsible for all 2D physics. It can create many kinds of physics objects, but does not insert them on the node tree.
Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
Assign the area to a descendant of [Object], so it can exist in the node tree.
Remove all shapes from an area. It does not delete the shapes, so they can be reassigned later.
Create an [Area2D].
Get the instance ID of the object the area is assigned to.
Return an area parameter value.
Return the [RID] of the nth shape of an area.
Return the number of shapes assigned to an area.
Return the transform matrix of a shape within an area.
Return the space assigned to the area.
Return the space override mode for the area.
Return the transform matrix for an area.
Remove a shape from an area. It does not delete the shape, so it can be reassigned later.
Set which physics layers the area will monitor.
Assign the area to one or many physics layers.
Set the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area. 2: [RID] of the object that entered/exited the area. 3: Instance ID of the object that entered/exited the area. 4: The shape index of the object that entered/exited the area. 5: The shape index of the area where the object entered/exited.
Set the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants.
Substitute a given area shape by another. The old shape is selected by its index, the new one by its [RID].
Set the transform matrix for an area shape.
Assign a space to the area.
Set the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*.
Set the transform matrix for an area.
Add a body to the list of bodies exempt from collisions.
Add a positioned force to the applied force and torque. As with [method body_apply_impulse], both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied.
Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
Add a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates.
Assign the area to a descendant of [Object], so it can exist in the node tree.
Remove all shapes from a body.
Create a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
Return the physics layer or layers a body can collide with.
Return the continuous collision detection mode.
Return the physics layer or layers a body belongs to.
Return the maximum contacts that can be reported. See [method body_set_max_contacts_reported].
Return the body mode.
Get the instance ID of the object the area is assigned to.
Return the direction used for one-way collision detection.
Return how far a body can go through the given one, when it allows one-way collisions.
Return the value of a body parameter.
Return the [RID] of the nth shape of a body.
Return the number of shapes assigned to a body.
Return the metadata of a shape of a body.
Return the transform matrix of a body shape.
Return the [RID] of the space assigned to a body.
Return a body state.
Return whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
Return whether a body's shape is marked as a trigger.
Remove a body from the list of bodies exempt from collisions.
Remove a shape from a body. The shape is not deleted, so it can be reused afterwards.
Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
Set the physics layer or layers a body can collide with.
Set the continuous collision detection mode from any of the CCD_MODE_* constants. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
Set the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]).
Set the physics layer or layers a body belongs to.
Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
Set the body mode, from one of the constants BODY_MODE*.
Set whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
Set a direction in which bodies can go through the given one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions.
Set how far a body can go through the given one, if it allows one-way collisions (see [method body_set_one_way_collision_direction]).
Set a body parameter (see BODY_PARAM* constants).
Substitute a given body shape by another. The old shape is selected by its index, the new one by its [RID].
Mark a body's shape as a trigger. A trigger shape cannot affect other bodies, but detects other shapes entering and exiting it.
Set metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries.
Set the transform matrix for a body shape.
Assign a space to the body (see [method create_space]).
Set a body state (see BODY_STATE* constants).
Return whether a body can move from a given point in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in.
Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself.
Return the value of a damped spring joint parameter.
Set a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants.
Destroy any of the objects created by Physics2DServer. If the [RID] passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console.
Return information about the current state of the 2D physics engine. The states are listed under the INFO_* constants.
Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself.
Return the value of a joint parameter.
Return the type of a joint (see JOINT_* constants).
Set a joint parameter. Parameters are explained in the JOINT_PARAM* constants.
Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself.
Activate or deactivate the 2D physics engine.
Create a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape].
Return the shape data.
Return the type of shape (see SHAPE_* constants).
Set the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type].
Create a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space].
Return the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries.
Return the value of a space parameter.
Return whether the space is active.
Mark a space as active. It will not have an effect, unless it is assigned to an area or body.
Set the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants.
Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
Constant to set/get the maximum distance a shape can be from another before they are considered separated.
Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
Constant to set/get the linear velocity threshold. Bodies slower than this will be marked as potentially inactive.
Constant to set/get the angular velocity threshold. Bodies slower than this will be marked as potentially inactive.
Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time.
Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks.
This is the constant for creating segment shapes. A segment shape is a line from a point A to a point B. It can be checked for intersections.
This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks.
This is the constant for creating rectangle shapes. A rectangle shape is defined by a width and a height. It can be used for intersections and inside/outside checks.
This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks.
This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method [method CollisionPolygon2D.set_polygon], polygons modified with [method shape_set_data] do not verify that the points supplied form, in fact, a convex polygon.
This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks.
This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
Constant to set/get gravity strength in an area.
Constant to set/get gravity vector/center in an area.
Constant to set/get whether the gravity vector of an area is a direction, or a center point.
Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance.
This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE.
Constant to set/get the linear dampening factor of an area.
Constant to set/get the angular dampening factor of an area.
Constant to set/get the priority (order of processing) of an area.
This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
Constant for static bodies.
Constant for kinematic bodies.
Constant for rigid bodies.
Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
Constant to set/get a body's bounce factor.
Constant to set/get a body's friction.
Constant to set/get a body's mass.
Constant to set/get a body's inertia.
Constant to set/get a body's gravity multiplier.
Constant to set/get a body's linear dampening factor.
Constant to set/get a body's angular dampening factor.
This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0.
Constant to set/get the current transform matrix of the body.
Constant to set/get the current linear velocity of the body.
Constant to set/get the current angular velocity of the body.
Constant to sleep/wake up a body, or to get whether it is sleeping.
Constant to set/get whether the body can sleep.
Constant to create pin joints.
Constant to create groove joints.
Constant to create damped spring joints.
Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
The value of the first parameter and area callback function receives, when an object enters one of its shapes.
The value of the first parameter and area callback function receives, when an object exits one of its shapes.
Constant to get the number of objects that are not sleeping.
Constant to get the number of possible collisions.
Constant to get the number of space regions where a collision could occur.
Software implementation of [Physics2DServer].
Software implementation of [Physics2DServer]. This class exposes no new methods or properties and should not be used, as [Physics2DServer] automatically selects the best implementation available.
Parameters to be sent to a 2D shape physics query.
This class contains the shape and other parameters for intersection/collision queries.
Return the list of objects, or object [RID]s, that will be excluded from collisions.
Return the physics layer(s) the shape belongs to.
Return the collision margin for the shape.
Return the current movement speed of the shape.
Return the type of object the shape belongs to.
Return the [RID] of the shape queried.
Return the transform matrix of the shape queried.
Set the list of objects, or object [RID]s, that will be excluded from collisions.
Set the physics layer(s) the shape belongs to.
Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision.
Set the current movement speed of the shape.
Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*).
Set the [Shape2D] that will be used for collision/intersection queries.
Set the [RID] of the shape to be used in queries.
Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale.
Base class for different types of Physics bodies.
PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it.
Base class for all objects affected by physics.
PhysicsBody2D is an abstract base class for implementing a physics body. All *Body2D types inherit from it.
Adds a body to the collision exception list. This list contains bodies that this body will not collide with.
Return the physics layers this area can scan for collisions.
Return an individual bit on the collision mask.
Return the physics layer this area is in.
Return an individual bit on the collision mask.
Return the direction used for one-way collision detection.
Return how far a body can go through this one, when it allows one-way collisions.
Removes a body from the collision exception list.
Set the physics layers this area can scan for collisions.
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
Set the physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier.
Set a direction in which bodies can go through this one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions.
Set how far a body can go through this one, when it allows one-way collisions (see [method set_one_way_collision_direction]).
This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
Result of a shape query in Physics2DServer.
Pin Joint for 2D Shapes.
Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space.
Plane in hessian form.
Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing.
Creates a plane from the three parameters "a", "b", "c" and "d".
Creates a plane from three points.
Creates a plane from the normal and the plane's distance to the origin.
Returns the center of the plane.
Returns the shortest distance from the plane to the position "point".
Returns a point on the plane.
Returns true if "point" is inside the plane (by a very minimum threshold).
Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned.
Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned.
Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned.
Returns true if "point" is located above the plane.
Returns a copy of the plane, normalized.
Returns the orthogonal projection of point "p" into a point in the plane.
2D polygon representation
A Polygon2D is defined by a set of n vertices connected together by line segments, meaning that the vertex 1 will be connected with vertex 2, vertex 2 with vertex 3 ..., vertex n-1 with vertex n and vertex n with vertex 1 in order to close the loop and define a polygon.
Return the polygon fill color.
Return whether this polygon is inverted or not.
Return the added padding around the bounding box.
Return the offset for the polygon vertices.
Return the set of vertices that defines this polygon.
Return the polygon texture
Return the polygon texture offset.
Return the rotation in radians of the texture polygon.
Return the uv coordinate multiplier.
Return the texture coordinates associated with every vertex of the polygon.
Return the list of vertex colors.
Set the polygon fill color. If the polygon has a texture defined, the defined texture will be multiplied by the polygon fill color. This, also, is the default color for those vertices that are not defined by [method get_vertex_colors].
Set the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on the square that contains the defined polygon).
Add extra padding around the bounding box, making it bigger. Too small a value can make the polygon triangulate strangely, due to numerical imprecision.
Set the an offset that will be added to the vertices' position. E.g. if the offset is set to (10,10) then all the polygon points will move 10 units to the right and 10 units to the bottom.
Define the set of vertices that will represent the polygon.
Set the polygon texture.
Set the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top.
Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation.
Set the value that will multiply the uv coordinates ([method get_uv]) when applying the texture. Larger values make the texture smaller, and vice versa.
Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored.
Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be [method get_color]. Extra color entries are ignored. Colors are interpolated between vertices, resulting in smooth gradients when they differ.
Base container control for popups and dialogs.
Popup is a base [Control] used to show dialogs and popups. It's a subwindow and modal by default (see [Control]) and has helpers for custom popup behavior.
Returns whether the popup will hide other popups when shown on the screen.
Popup (show the control in modal form).
Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size".
Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than [code]minsize[/code].
Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen.
Make the popup hide other popups when shown on the screen.
This signal is emitted when a popup is about to be shown. (often used in [PopupMenu] for clearing the list of options and creating a new one according to the current context).
This signal is emitted when a popup is hidden.
Notification sent right after the popup is shown.
Notification sent right after the popup is hidden.
Base class for Popup Dialogs.
PopupDialog is a base class for popup dialogs, along with [WindowDialog].
PopupMenu displays a list of options.
PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus.
Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index.
Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index.
Add a separator between items. Separators also occupy an index.
Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index.
Clear the popup menu, in effect removing all items.
Returns a boolean that indicates whether or not the PopupMenu will hide on item selection.
Return the id of the item at index "idx".
Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused.
Return the amount of items.
Return the icon of the item at index "idx".
Find and return the index of the item containing a given id.
Return the metadata of an item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items.
Return the submenu name of the item at index "idx".
Return the text of the item at index "idx".
Return whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
Return the checkstate status of the item at index "idx".
Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked.
Return whether the item is a seperator. If it is, it would be displayed as a line.
Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one.
Sets whether or not the PopupMenu will hide on item selection.
Set the id of the item at index "idx".
Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused.
Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line.
Set the checkstate status of the item at index "idx".
Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked.
Set the icon of the item at index "idx".
Sets the metadata of an item, which might be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items.
Sets the submenu of the item at index "idx". The submenu is the name of a child PopupMenu node that would be shown when the item is clicked.
Set the text of the item at index "idx".
This even is emitted when an item is pressed or its accelerator is activated. The id of the item is returned if it exists, else the index.
Class for displaying popups with a panel background.
Class for displaying popups with a panel background. In some cases it might be simpler to use than [Popup], since it provides a configurable background. If you are making windows, better check [WindowDialog].
Portals provide virtual openings to rooms.
Portals provide virtual openings to [VisualInstance] nodes, so cameras can look at them from the outside. Note that portals are a visibility optimization technique, and are in no way related to the game of the same name (as in, they are not used for teleportation). For more information on how rooms and portals work, see [VisualInstance]. Portals are represented as 2D convex polygon shapes (in the X,Y local plane), and are placed on the surface of the areas occupied by a [VisualInstance], to indicate that the room can be accessed or looked-at through them. If two rooms are next to each other, and two similar portals in each of them share the same world position (and are parallel and opposed to each other), they will automatically "connect" and form "doors" (for example, the portals that connect a kitchen to a living room are placed in the door they share). Portals must always have a [VisualInstance] node as a parent, grandparent or far parent, or else they will not be active.
Return the range for auto-connecting two portals from different rooms sharing the same space.
Return the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [method set_disabled_color]).
Return the color for when the portal goes beyond the disable distance (see [method set_disable_distance]) and becomes disabled.
Return the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane.
Return whether the portal is active. When disabled it causes the parent [VisualInstance] to not be visible any longer when looking through the portal.
Set the range for auto-connecting two portals from different rooms sharing the same space.
Set the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [method set_disabled_color]).
When the portal goes beyond the disable distance (see [method set_disable_distance]), it becomes opaque and displayed with color "color".
Enable the portal (it is enabled by default though), disabling it will cause the parent [VisualInstance] to not be visible any longer when looking through the portal.
Set the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane.
Generic 2D Position hint for editing.
Generic 2D Position hint for editing. It's just like a plain [Node2D] but displays as a cross in the 2D-Editor at all times.
Generic 3D Position hint for editing
Generic 3D Position hint for editing. It's just like a plain [Spatial] but displays as a cross in the 3D-Editor at all times.
General purpose progress bar.
General purpose progress bar. Shows fill percentage from right to left.
General purpose proximity-detection node.
General purpose proximity-detection node.
Quaternion.
Quaternion is a 4 dimensional vector that is used to represent a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between to rotations obtained by a Matrix3 cheaply. Multiplying quaternions also cheaply reproduces rotation sequences, however quaternions need to be often normalized, or else they suffer from precision issues.
Returns a quaternion that will rotate around the given axis by the specified angle.
Returns the rotation matrix corresponding to the given quaternion.
Returns the dot product of two quaternions.
Returns the inverse of the quaternion.
Returns the length of the quaternion.
Returns the length of the quaternion, squared.
Returns a copy of the quaternion, normalized to unit length.
Perform a spherical-linear interpolation with another quaternion.
Handle for a [Resource]'s unique ID.
The RID type is used to access the unique integer ID of a resource. They are opaque, so they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as [VisualServer].
Create a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
Retrieve the ID of the referenced resource.
Abstract base class for range-based controls.
Range is a base class for [Control] nodes that change a floating point [i]value[/i] between a [i]minimum[/i] and a [i]maximum[/i], using [i]step[/i] and [i]page[/i], for example a [ScrollBar].
Return the maximum value.
Return the minimum value.
Return the page size, if page is 0, paging is disabled.
Return the stepping, if step is 0, stepping is disabled.
Return value mapped to 0 to 1 (unit) range.
Return the current value.
Set minimum value, clamped range value to it if it's less.
Set page size. Page is mainly used for scrollbars or anything that controls text scrolling.
Set step value. If step is 0, stepping will be disabled.
Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max.
This signal is emitted when min, max, range or step change.
This signal is emitted when value changes.
Raw byte array.
Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory.
Create from a generic array.
Append an [RawArray] at the end of this array.
Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart).
Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input.
Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
Reverse the order of the elements in the array (so first element will now be the last).
Append an element at the end of the array.
Remove an element from the array by index.
Set the size of the [RawArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
Change the byte at the given index.
Return the size of the array.
Returns the slice of the [RawArray] between indices (inclusive) as a new [RawArray]. Any negative index is considered to be from the end of the array.
Query the closest object intersecting a ray.
A RayCast represents a line from its origin to its destination position [code]cast_to[/code], it is used to query the 3D space in order to find the closest object intersecting with the ray.

RayCast can ignore some objects by adding them to the exception list via [code]add_exception[/code], setting proper filtering with layers, or by filtering object types with type masks.

Only enabled raycasts will be able to query the space and report collisions!

RayCast calculates intersection every fixed frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast.
Adds a collision exception so the ray does not report collisions with the specified [code]node[/code].
Removes all collision exception for this ray.
Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, [code]set_enabled[/code] is not required for this to work.
Return the destination point of this ray object.
Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use [method is_colliding] to check if the object returned is actually colliding with the ray.
Returns the collision shape of the closest object the ray is pointing to.
Returns the normal of the intersecting object shape face containing the collision point.
Returns collision point. This point is in [b]global[/b] coordinate system.
Returns the layer mask for this ray.
Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [PhysicsDirectSpaceState].
Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length).
Returns whether this raycast is enabled or not.
Removes a collision exception so the ray does report collisions with the specified [code]node[/code].
Sets to which point ray should be casted. This point is in [b]local[/b] coordinate system.
Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions.
Set the mask to filter objects. Only objects with at least the same mask element set will be detected.
Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [PhysicsDirectSpaceState], eg. [code]PhysicsDirectSpaceState.TYPE_MASK_STATIC_BODY | PhysicsDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types.
Query the closest object intersecting a ray.
A RayCast2D represents a line from its origin to its destination position [code]cast_to[/code], it is used to query the 2D space in order to find the closest object intersecting with the ray.

RayCast2D can ignore some objects by adding them to the exception list via [code]add_exception[/code], setting proper filtering with layers, or by filtering object types with type masks.

Only enabled raycasts will be able to query the space and report collisions!

RayCast2D calculates intersection every fixed frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast.
Adds a collision exception so the ray does not report collisions with the specified [code]node[/code].
Removes all collision exception for this ray.
Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, [code]set_enabled[/code] is not required for this to work.
Return the destination point of this ray object.
Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use [method is_colliding] to check if the object returned is actually colliding with the ray.
Returns the collision shape of the closest object the ray is pointing to.
Returns the normal of the intersecting object shape face containing the collision point.
Returns the collision point in which the ray intersects the closest object. This point is in [b]global[/b] coordinate system.
Returns whether this ray should hit your parent node, if it's a body.
Returns the layer mask for this ray.
Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [Physics2DDirectSpaceState].
Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length).
Returns whether this raycast is enabled or not.
Removes a collision exception so the ray does report collisions with the specified [code]node[/code].
Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code]
Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions.
Toggle whether this ray should hit your parent node, if it's a body.
Set the mask to filter objects. Only objects with at least the same mask element set will be detected.
Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [Physics2DDirectSpaceState], eg. [code]Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types.
Ray 2D shape resource for physics.
Ray 2D shape resource for physics. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters.
Return the length of the ray.
Set the length of the ray.
Real Array .
Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory.
Create from a generic array.
Append an element at the end of the array (alias of [method push_back]).
Append an [RealArray] at the end of this array.
Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
Reverse the order of the elements in the array (so first element will now be the last).
Append an element at the end of the array.
Remove an element from the array by index.
Set the size of the [RealArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
Change the float at the given index.
Return the size of the array.
2D Axis-aligned bounding box.
Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
Construct a [Rect2] by position and size.
Construct a [Rect2] by x, y, width and height.
Returns the intersection of this [Rect2] and b.
Returns true if this [Rect2] completely encloses another one.
Return this [Rect2] expanded to include a given point.
Get the area of the [Rect2].
Return a copy of the [Rect2] grown a given amount of units towards all the sides.
Return true if the [Rect2] is flat or empty.
Return true if the [Rect2] contains a point.
Return true if the [Rect2] overlaps with another.
Combine this [Rect2] with another, a larger one is returned that contains both.
- Ending corner.
- Position (starting corner).
- Size from position to end.
Rectangle Shape for 2D Physics.
Rectangle Shape for 2D Physics. This shape is useful for modeling box-like 2D objects.
Return the half extents, the actual width and height of this shape is twice the half extents.
Set the half extents, the actual width and height of this shape is twice the half extents.
Base class for anything that keeps a reference count.
Base class for anything that keeps a reference count. Resource and many other helper objects inherit this. References keep an internal reference counter so they are only released when no longer in use.
Increase the internal reference counter. Use this only if you really know what you are doing.
Decrease the internal reference counter. Use this only if you really know what you are doing.
Reference frame for GUI.
Reference frame for GUI. It's just like an empty control, except a red box is displayed while editing around its size at all times.
Simple regular expression matcher.
Class for finding text patterns in a string using regular expressions. It can not perform replacements. Regular expressions are a way to define patterns of text to be searched. Details on writing patterns are too long to explain here but the Internet is full of tutorials and detailed explanations. Once created, the RegEx object needs to be compiled with the pattern before it can be used. The pattern must be escaped first for gdscript before it is escaped for the expression. For example: [code]var exp = RegEx.new()[/code] [code]exp.compile("\\d+")[/code] would be read by RegEx as [code]\d+[/code] Similarly: [code]exp.compile("\"(?:\\\\.|[^\"])*\"")[/code] would be read as [code]"(?:\\.|[^"])*"[/code] Currently supported features: * Capturing [code]()[/code] and non-capturing [code](?:)[/code] groups * Named capturing groups [code](?P<name>)[/code] * Any character [code].[/code] * Shorthand character classes [code]\w \W \s \S \d \D[/code] * User-defined character classes such as [code][A-Za-z][/code] * Simple quantifiers [code]?[/code], [code]*[/code] and [code]+[/code] * Range quantifiers [code]{x,y}[/code] * Lazy (non-greedy) quantifiers [code]*?[/code] * Beginning [code]^[/code] and end [code]$[/code] anchors * Alternation [code]|[/code] * Backreferences [code]\1[/code], [code]\g{1}[/code], and [code]\g<name>[/code] * POSIX character classes [code][[:alnum:]][/code] * Lookahead [code](?=)[/code], [code](?!)[/code] and lookbehind [code](?<=)[/code], [code](?<!)[/code] * ASCII [code]\xFF[/code] and Unicode [code]\uFFFF[/code] code points (in a style similar to Python) * Word boundaries [code]\b[/code], [code]\B[/code]
This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object.
Compiles and assign the regular expression pattern to use.
Returns the number of numeric capturing groups.
Returns an array of names of named capturing groups.
Returns the expression used to compile the code.
Returns whether this object has a valid regular expression assigned.
Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching reult if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be.
Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]\1[/code] and [code]\g<name>[/code] expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be.
Using results from the search, returns the specified string with escapes and backreferences such as [code]\1[/code] and [code]\g<name>[/code] expanded and resolved.
Returns the end position of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
Returns an array of the results of the numeric groups.
Returns the number of numeric capturing groups.
Returns a dictionary containing the named capturing groups and their results.
Returns an array of names of named capturing groups.
Returns the starting position of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
Returns the result of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
Base class for all resources.
Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node], which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource.
Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only.
Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else.
Return the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high level abstractions of resources stored in a server, so this function will return the original RID.
Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only.
Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [Resource] already has path "path".
Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing.
Interactive Resource Loader.
Interactive Resource Loader. This object is returned by ResourceLoader when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying load bars/percentages.
Return the loaded resource (only if loaded). Otherwise, returns null.
Return the load stage. The total amount of stages can be queried with [method get_stage_count]
Return the total amount of stages (calls to [method poll]) needed to completely load this resource.
Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource].
Resource Loader.
Resource Loader. This is a static object accessible as [ResourceLoader]. GDScript has a simplified load() function, though.
Return the list of recognized extensions for a resource type.
Load a resource interactively, the returned object allows to load with high granularity.
Change the behavior on missing sub-resources. Default is to abort load.
Resource Preloader Node.
Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resources are ready to use and be retrieved from here.
Add a resource to the preloader. Set the text-id that will be used to identify it (retrieve it/erase it/etc).
Return the resource given a text-id.
Return the list of resources inside the preloader.
Return true if the preloader has a given resource.
Remove a resource from the preloader by text id.
Rename a resource inside the preloader, from a text-id to a new text-id.
Resource Saving Interface.
Resource Saving Interface. This interface is used for saving resources to disk.
Return the list of extensions available for saving a resource of a given type.
Save a resource to disk, to a given path.
Label that displays rich text.
Label that displays rich text. Rich text can contain custom text, fonts, images and some basic formatting. It also adapts itself to given width/heights.
Returns the raw text, stripping out the formatting information.
Return true if selecting the text inside this richtext is allowed.
Set to true if selecting the text inside this richtext is allowed.
Rigid body node.
Rigid body node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift mode between regular Rigid body, Kinematic, Character or Static.
Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body.
Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates.
Return the current body angular damp. Default is -1.
Return the current body angular velocity.
Return the current axis lock of the body. One of AXIS_LOCK_* enum.
Return the current body bounciness.
Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it.
Return the current body friction, from 0 (frictionless) to 1 (max friction).
Return the current body gravity scale.
Return the current body linear damp. Default is -1.
Return the current body linear velocity.
Return the current body mass.
Return the maximum contacts that can be reported. See [method set_max_contacts_reported].
Return the current body mode, see [method set_mode].
Return the current body weight, given standard earth-weight (gravity 9.8).
Return whether the body has the ability to fall asleep when not moving. See [method set_can_sleep].
Return whether contact monitoring is enabled.
Return whether the body is sleeping.
Return whether this body is using continuous collision detection.
Return whether the body is using a custom integrator.
Set the angular damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any angular damp derived from the world or areas will be overridden.
Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
Set the axis lock of the body, from the AXIS_LOCK_* enum. Axis lock stops the body from moving along the specified axis(X/Y/Z) and rotating along the other two axes.
Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness).
Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body.
Enable contact monitoring. This allows the body to emit signals when it collides with another.
Set the body friction, from 0 (frictionless) to 1 (max friction).
Set the gravity factor. This factor multiplies gravity intensity just for this body.
Set the linear damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden.
Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
Set the body mass.
Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body.
Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] wakes them up. Until then, they behave like a static body.
Set the continuous collision detection mode from the enum CCD_MODE_*. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects.
Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined.
Set the body weight given standard earth-weight (gravity 9.8).
Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work.
Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with.
Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work.
Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with.
Emitted when the body changes it's sleeping state. Either by sleeping or waking up.
Static mode. The body behaves like a [StaticBody], and can only move by user code.
Kinematic body. The body behaves like a [KinematicBody], and can only move by user code.
Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code.
Character body. This behaves like a rigid body, but can not rotate.
Rigid body 2D node.
Rigid body 2D node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift state between regular Rigid body, Kinematic, Character or Static. Character mode forbids the node from being rotated. This node can have a custom force integrator function, for writing complex physics motion behavior per node. As a warning, don't change this node position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior.
Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body.
Add a positioned force to the applied force and torque. As with [method apply_impulse], both the force and the offset from the body origin are in global coordinates.
Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates.
Return the angular damp for this body.
Return the body angular velocity. This changes by physics granularity. See [method set_angular_velocity].
Return the applied force vector.
Return the torque which is being applied to this body.
Return the body bounciness.
Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. You must also enable contact monitor, see [method set_contact_monitor]
Return whether this body is using continuous collision detection.
Return the body friction.
Return the gravity factor.
Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet.
Return the linear damp for this body.
Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity].
Return the body mass.
Return the maximum contacts that can be reported. See [method set_max_contacts_reported].
Return the current body mode, see [method set_mode].
Return the body weight given standard earth-weight (gravity 9.8).
Return true if the body has the ability to fall asleep when not moving. See [method set_can_sleep].
Return whether contact monitoring is enabled.
Return whether the body is sleeping.
Return true if the body is not doing any built-in force integration.
Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden.
Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly.
Set a constant torque which will be applied to this body.
Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
Set the body bounciness, from 0 (no bounce) to 1 (full bounce).
Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body.
Enable contact monitoring. This allows the body to emit signals when it collides with another.
Set the continuous collision detection mode from the enum CCD_MODE_*. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects.
Set the body friction, from 0 (frictionless) to 1 (full friction).
Set the gravity factor. This factor multiplies gravity intensity just for this body.
Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.
Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden.
Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
Set the body mass.
Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body.
Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body.
Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined.
Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels.
Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type [Physics2DTestMotionResult], which will store additional information about the collision (should there be one).
Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work.
Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with.
Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work.
Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with.
Emitted when the body changes it's sleeping state. Either by sleeping or waking up.
Static mode. The body behaves like a [StaticBody2D], and can only move by user code.
Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code.
Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code.
Character body. This behaves like a rigid body, but can not rotate.
Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
Room data resource.
Room contains the data to define the bounds of a scene (using a BSP Tree). It is instanced by a [VisualInstance] node to create rooms. See that class documentation for more information about rooms.
Audio sample (sound) class.
Sample provides an audio sample class, containing audio data, together with some information for playback, such as format, mix rate and loop. It is used by sound playback routines.
Create new data for the sample, with format (see FORMAT_* constants), stereo hint, and length in samples (not bytes). Calling this method overrides previously existing data. Stereo samples are interleaved pairs of left and right points (in that order), but count as one sample for length purposes.
Return sample data as little endian.
Return the sample format.
Return the sample length in samples. Stereo samples count as one, even if they are made of a left and a right sample.
Return the loop begin position.
Return the loop end position.
Return the loop format.
Return the mix rate for the sample.
Return whether the current sample was created as stereo.
Set sample data. Data must be little endian, no matter the host platform, and exactly as long as to fit all samples. The length of this array can be calculated as follows: Get the sample length ([method get_length]). If the sample format is FORMAT_PCM16, multiply it by 2. If the sample format is FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. If the sample is stereo ([method is_stereo]), multiply it by 2.
Set the loop begin position. It must be a valid frame and less than the loop end position.
Set the loop end position. It must be a valid frame and greater than the loop begin position.
Set the loop format (use LOOP_* constants as argument).
Set the mix rate for the sample (expected playback frequency).
8-bits signed PCM audio.
16-bits signed little endian PCM audio.
IMA-ADPCM Audio.
No loop enabled.
Forward looping (when playback reaches loop end, goes back to loop begin).
Ping-pong looping (when playback reaches loop end, plays backward until loop begin). Not available in all platforms.
Library that contains a collection of samples.
Library that contains a collection of [Sample], each identified by a text ID. This is used as a data container for the majority of the SamplePlayer classes and derivatives.
Add a sample to the library, with a given text ID.
Return the sample from the library matching the given text ID. Return null if the sample is not found.
Return true if the sample text ID exists in the library.
Remove the sample matching the given text ID.
Return the pitch scale for the given sample.
Return the volume (in dB) for the given sample.
Set the pitch scale for the given sample.
Set the volume (in dB) for the given sample.
Sample Player node.
SamplePlayer is a [Node] meant for simple sample playback. A library of samples is loaded and played back "as is", without positioning or anything.
Return the current chorus send level for a given voice.
Return the default chorus send level of the player.
Return the default filter cutoff frequency of the player.
Return the default filter gain of the player.
Return the default filter resonance of the player.
Return the default filter type in use (see FILTER_* constants) for the player.
Return the default panning of the player.
Return the default pan depth of the player.
Return the default pan height of the player.
Return the default pitch scale of the player.
Return the default reverberation send level of the player.
Return the default reverberation room type of the player (see REVERB_* enum).
Return the default volume (on a linear scale) of the player.
Return the default volume (in dB) of the player.
Return the current filter cutoff frequency for a given voice.
Return the current filter gain for a given voice.
Return the current filter resonance for a given voice.
Return the current filter type in use (see FILTER_* constants) for a given voice.
Return the current mix rate for a given voice.
Return the current panning for a given voice.
Return the current pan depth for a given voice.
Return the current pan height for a given voice.
Return the current pitch scale for a given voice.
Return the polyphony of the player.
Return the current reverberation send level for a given voice.
Return the current reverberation room type for a given voice (see REVERB_* enum).
Return the sample library used by the player.
Return the current volume (on a linear scale) for a given voice.
Return the current volume (in dB) for a given voice.
Return whether the player is currently active.
Return whether the given voice is currently active.
Play a sample referenced by its name. Optionally, the playback can be made "unique" to force stopping all other samples currently played. The voices allocated for playback will then be returned.
Set the chorus send level of a voice (from 0 to 1.0). For setting chorus parameters, see [AudioServer].
Set the default chorus send level of the player (from 0 to 1.0). For setting chorus parameters, see [AudioServer].
Set the default filter for the player, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). Optionally, a gain can also be given (from 0 to 2.0).
Set the default panning of the player. Panning goes from -1.0 (left) to +1.0 (right). Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0).
Set the default pitch scale of the player. A ratio of 1.0 is the normal scale.
Set the default reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of the player.
Set the default volume of the player using a linear scale. The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB). A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output.
Set the default volume of the player in dB. The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half.
Set the filter for a given voice, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). Optionally, a gain can also be given (from 0 to 2.0).
Set the mix rate (in Hz) of a given voice.
Set the panning of a voice. Panning goes from -1.0 (left) to +1.0 (right). Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0).
Set the pitch scale of a given voice. A ratio of 1.0 is the normal scale.
Set the polyphony of the player (maximum amount of simultaneous voices).
Set the reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of a voice.
Set the sample library for the player.
Set the volume of a given voice using a linear scale. The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB). A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output.
Set the volume of a given voice in dB. The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half.
Stop a given voice.
Stop all playing voices.
Filter is disabled for voice.
Low-pass filter is used for voice.
Band-pass filter is used for voice.
High-pass filter is used for voice.
Notch (band reject) filter is used for voice.
Peak (exclusive band) filter is used for voice.
Band-limit filter is used for voice, in this case resonance is the high-pass cutoff. A band-limit filter has a different frequency response than a notch filter, but otherwise both are band-rejecting filters.
Low-shelf filter is used for voice.
High-shelf filter is used for voice.
Small reverberation room (house room).
Medium reverberation room (street)
Large reverberation room (theatre)
Huge reverberation room (cathedral, warehouse).
Value returned if the voice ID is invalid.
Sample player for positional 2D Sound.
Sample player for positional 2D Sound. Plays sound samples positionally, left and right depending on the distance/place on the screen.
Return the polyphony of the player.
Return the amplitude used for random pitch scale variations.
Return the sample library used by the player.
Return whether a voice is still active or has stopped playing.
Play a sample. An internal polyphony ID can optionally be passed, or defaults to NEXT_VOICE. Return a voice ID which can be used to modify the voice parameters, or INVALID_VOICE if the voice or sample are invalid.
Set the polyphony of the player (maximum amount of simultaneous voices).
Set the amplitude for random pitch scale variations. If different from zero, the pitch scale will vary randomly around 1.0 in a range defined by val. The actual pitch scale will be, with "variation" ranging from -val to val: * variation > 0: 1.0 + variation * variation < 0: 1.0/(1.0 - variation)
Set the sample library for the player.
Stop all playing voices.
Stop a given voice.
Change the pitch scale of a currently playing voice.
Change the volume scale (in dB) of a currently playing voice.
Value returned if the voice or sample are invalid.
Default voice for the play method. Corresponds to the first voice following the last used voice.
Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections).
Set the peer object to handle the RPC system (effectively enabling networking). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals.
Base class for scripts.
Base class for scripts. Any script that is loaded becomes one of these resources, which can then create instances.
Return true if this script can be instance (ie not a library).
Return the script source code (if available).
Return true if the script contains source code.
Return true if a given object uses an instance of this script.
Set the script source code.
Base class for scroll bars.
Scrollbars are a [Range] based [Control], that display a draggable area (the size of the page). Horizontal ([HScrollBar]) and Vertical ([VScrollBar]) versions are available.
A helper node for displaying scrollable elements (e.g. lists).
A ScrollContainer node with a [Control] child and scrollbar child ([HScrollbar], [VScrollBar], or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a [Panel] control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension).
Return current horizontal scroll value.
Return current vertical scroll value.
Return true if horizontal scroll is allowed.
Return true if vertical scroll is allowed.
Set allows horizontal scroll.
Set allows vertical scroll.
Set horizontal scroll value.
Set vertical scroll value.
Segment Shape for 2D Collision Detection.
Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'.
Return the first point's position.
Return the second point's position.
Set the first point's position.
Set the second point's position.
A synchronization Semaphore.
A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation.
Lowers the [Semaphore], allowing one more thread in.
Tries to wait for the [Semaphore], if it's value is zero, blocks until non-zero.
Base class for separators.
Separator is a [Control] used for separating other controls. It's purely a visual decoration. Horizontal ([HSeparator]) and Vertical ([VSeparator]) versions are available.
To be changed, ignore.
To be changed, ignore.
Base class for all 2D Shapes.
Base class for all 2D Shapes. All 2D shape types inherit from this.
Return whether this shape is colliding with another. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]).
Return a list of the points where this shape touches another. If there are no collisions, the list is empty. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]).
Return whether this shape would collide with another, if a given movement was applied. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]).
Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]).
Return the custom solver bias.
Use a custom solver bias. No need to change this unless you really know what you are doing. The solver bias is a factor controlling how much two objects "rebound" off each other, when colliding, to avoid them getting into each other because of numerical imprecision.
Skeleton for characters and animated objects.
Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future.
Add a bone, with name "name". [method get_bone_count] will become the bone index.
Deprecated soon.
Clear all the bones in this skeleton.
Return the bone index that matches "name" as its name.
Return the amount of bones in the skeleton.
Return the name of the bone at index "index"
Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx".
Return the pose transform for bone "bone_idx".
Return the rest transform for a bone "bone_idx".
Deprecated soon.
Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx".
Return the pose transform for bone "bone_idx".
Set the rest transform for bone "bone_idx"
Deprecated soon.
Base class for GUI Sliders.
Base class for GUI Sliders.
Return amounts of ticks to display on slider.
Return true if ticks are visible on borders.
Set amount of ticks to display in slider.
Set true if ticks are visible on borders.
Base class for playing spatial 2D sound.
Base class for playing spatial 2D sound.
Base class for all 3D nodes.
Spatial is the base for every type of 3D [Node]. It contains a 3D [Transform] which can be set or get as local or global. If a Spatial [Node] has Spatial children, their transforms will be relative to the parent.
Return the global transform, relative to worldspace.
Return the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial].
Return the local transform, relative to the bone parent.
Set the transform globally, relative to worldspace.
Set the transform locally, relative to the parent spatial node.
Spatial nodes receive this notification with their global transform changes. This means that either the current or a parent node changed its transform.
Server for Spatial 2D Sound.
Server for Spatial 2D Sound.
Numerical input text field.
SpinBox is a numerical input text field. It allows entering integers and floats.
Return the specific suffix.
Return if the spinbox is editable.
Set whether the spinbox is editable.
Set a prefix.
Set a specific suffix.
Container for splitting and adjusting.
Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
Return visibility of the split dragger(One of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]).
Return the split offset.
Return true if the split is collapsed.
Set if the split must be collapsed.
Set visibility of the split dragger([i]mode[/i] must be one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]).
Set the split offset.
Emmited when the dragger is gragged by user.
The split dragger is visible.
The split dragger is invisible.
The split dragger is invisible and collapsed.
Spotlight [Light], such as a reflector spotlight or a lantern.
A SpotLight light is a type of [Light] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of a spotlight.
General purpose Sprite node.
General purpose Sprite node. This Sprite node can show any texture as a sprite. The texture can be used as a spritesheet for animation, or only a region from a bigger texture can referenced, like an atlas.
Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
Return the amount of horizontal frames. See [method set_hframes].
Return color modulation for the sprite. All sprite pixels are multiplied by this color.
Return sprite draw offset.
Return the region rect to read from.
Return the base texture for the sprite.
Return the amount of vertical frames. See [method set_vframes].
Return if the sprite is centered at the local origin.
Return true if the sprite is flipped horizontally.
Return true if the sprite is flipped vertically.
Return if the sprite reads from a region.
Set whether the sprite should be centered on the origin.
Set true to flip the sprite horizontally.
Set true to flip the sprite vertically.
Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation.
Set color modulation for the sprite. All sprite pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect.
Set the sprite draw offset, useful for setting rotation pivots.
Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases.
Set the region rect to read from.
Set the base texture for the sprite.
Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation.
Sprite frame library for AnimatedSprite.
Sprite frame library for [AnimatedSprite].
Static body for 3D Physics.
Static body for 3D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody3D] so they are great for scenario collision. A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies. Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels).
Return the body bounciness.
Return the constant angular velocity for the body.
Return the constant linear velocity for the body.
Return the body friction.
Set the body bounciness, from 0 (not bouncy) to 1 (bouncy).
Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating.
Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving.
Set the body friction, from 0 (frictionless) to 1 (full friction).
Static body for 2D Physics.
Static body for 2D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody2D] so they are great for scenario collision. A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies. Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels).
Return the body bounciness.
Return the constant angular velocity for the body.
Return the constant linear velocity for the body.
Return the body friction.
Set the body bounciness, from 0 (not bouncy) to 1 (bouncy).
Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating.
Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving.
Set the body friction, from 0 (frictionless) to 1 (full friction).
Abstraction and base class for stream-based protocols.
StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings.
Get a signed 16 bit value from the stream.
Get a signed 32 bit value from the stream.
Get a signed 64 bit value from the stream.
Get a signed byte from the stream.
Return the amount of bytes this [StreamPeer] has available.
Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array.
Get a double-precision float from the stream.
Get a single-precision float from the stream.
Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array.
Get a string with byte-length "bytes" from the stream.
Get an unsigned 16 bit value from the stream.
Get an unsigned 32 bit value from the stream.
Get an unsigned 16 bit value from the stream.
Get an unsigned byte from the stream.
Get an utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8).
Get a Variant from the stream.
Return whether this [StreamPeer] is using big-endian format.
Put a signed 16 bit value into the stream.
Put a signed 32 bit value into the stream.
Put a signed 64 bit value into the stream.
Put a signed byte into the stream.
Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code.
Put a double-precision float into the stream.
Put a single-precision float into the stream.
Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent.
Put an unsigned 16 bit value into the stream.
Put an unsigned 32 bit value into the stream.
Put an unsigned 64 bit value into the stream.
Put an unsigned byte into the stream.
Put a zero-terminated utf8 string into the stream.
Put a Variant into the stream.
Set this [StreamPeer] to use big-endian format. Default is false.
SSL Stream peer.
SSL Stream peer. This object can be used to connect to SSL servers.
Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname".
Disconnect from host.
Return the status of the connection, one of STATUS_* enum.
A status representing a [StreamPeerSSL] that is disconnected.
A status representing a [StreamPeerSSL] that is connected to a host.
An errot status that shows the peer did not present a SSL certificate and validation was requested.
An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation.
TCP Stream peer.
TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a tcp server.
Connect to the specified host:port pair. A hostname will be resolved if valid. Returns [OK] on success or [FAILED] on failure.
Disconnect from host.
Return the IP of this peer.
Return the port of this peer.
Return the status of the connection, one of STATUS_* enum.
Return whether this peer is connected. Returns true while connecting and connected.
The initial status of the [StreamPeerTCP], also the status after a disconnect.
A status representing a [StreamPeerTCP] that is connecting to a host.
A status representing a [StreamPeerTCP] that is connected to a host.
A staus representing a [StreamPeerTCP] in error state.
Base class for audio stream playback.
Base class for audio stream playback. Audio stream players inherit from it.
Return the size of the audio buffer.
Return the length of the stream, in seconds.
Return the number of times the playback has looped.
Return the point in time the stream will rewind to, when looping.
Return the playback position, in seconds.
Return the currently assigned stream.
Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>".
Return the playback volume for this player.
Return the playback volume for this player, in decibels.
Return whether this player will start playing as soon as it enters the scene tree.
Return whether the stream will be restarted at the end.
Return whether the playback is currently paused.
Return whether this player is playing.
Play the currently assigned stream, starting from a given position (in seconds).
Set the playback position, in seconds.
Set whether this player will start playing as soon as it enters the scene tree.
Set the size (in milliseconds) of the audio buffer. A long audio buffer protects better against slowdowns, but responds worse to changes (in volume, stream played...). A shorter buffer takes less time to respond to changes, but may stutter if the application suffers some slowdown. Default is 500 milliseconds.
Set whether the stream will be restarted at the end.
Set the point in time the stream will rewind to, when looping.
Pause stream playback.
Set the [EventStream] this player will play.
Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 will amplify sound even more, but may introduce distortion. Negative values will just invert the output waveform, which produces no audible difference.
Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see [method set_volume]) still apply.
Stop the playback.
This signal triggers when the player stops playing. It will not trigger on each loop.
Built-in string class.
This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources.
If the string is a path to a file, return the path to the file without the extension.
Return true if the strings begins with the given string.
Return the bigrams (pairs of consecutive letters) of this string.
Return a copy of the string with special characters escaped using the C language standard.
Return a copy of the string with escaped characters replaced by their meanings according to the C language standard.
Change the case of some letters. Replace underscores with spaces, convert all letters to lowercase then capitalize first and every letter following the space character. For [code]capitalize camelCase mixed_with_underscores[/code] it will return [code]Capitalize Camelcase Mixed With Underscores[/code].
Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater.
Return true if the string is empty.
Return true if the strings ends with the given string.
Erase [code]chars[/code] characters from the string starting from [code]pos[/code].
If the string is a path to a file, return the extension.
Find the first occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.
Find the last occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.
Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.
If the string is a path to a file, return the base directory.
If the string is a path to a file, return the file and ignore the base directory.
Hash the string and return a 32 bits integer.
Convert a string containing an hexadecimal number into an int.
Insert a substring at a given position.
If the string is a path to a file or directory, return true if the path is absolute.
If the string is a path to a file or directory, return true if the path is relative.
Check whether this string is a subsequence of the given string.
Check whether this string is a subsequence of the given string, without considering case.
Check whether the string contains a valid float.
Check whether the string contains a valid color in HTML notation.
Check whether the string is a valid identifier. As is common in programming languages, a valid identifier may contain only letters, digits and underscores (_) and the first character may not be a digit.
Check whether the string contains a valid integer.
Check whether the string contains a valid IP address.
Return a copy of the string with special characters escaped using the JSON standard.
Return an amount of characters from the left of the string.
Return the length of the string in characters.
Do a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'.
Do a simple case insensitive expression match, using ? and * wildcards (see [method match]).
Return the MD5 hash of the string as an array of bytes.
Return the MD5 hash of the string as a string.
Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater.
Return the character code at position [code]at[/code].
Format a number to have an exact number of [code]digits[/code] after the decimal point.
Format a number to have an exact number of [code]digits[/code] before the decimal point.
Decode a percent-encoded string. See [method percent_encode].
Percent-encode a string. This is meant to encode parameters in a URL when sending a HTTP GET request and bodies of form-urlencoded POST request.
If the string is a path, this concatenates [code]file[/code] at the end of the string as a subpath. E.g. [code]"this/is".plus_file("path") == "this/is/path"[/code].
Replace occurrences of a substring for different ones inside the string.
Replace occurrences of a substring for different ones inside the string, but search case-insensitive.
Perform a search for a substring, but start from the end of the string instead of the beginning.
Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive.
Return the right side of the string from a given position.
Return the SHA-256 hash of the string as a string.
Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar.
Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",".
Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",".
Return a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively.
Return part of the string from the position [code]from[/code], with length [code]len[/code].
Convert the String (which is a character array) to RawArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters.
Convert a string, containing a decimal number, into a [code]float[/code].
Convert a string, containing an integer number, into an [code]int[/code].
Return the string converted to lowercase.
Return the string converted to uppercase.
Convert the String (which is an array of characters) to RawArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii().
Return a copy of the string with special characters escaped using the XML standard.
Return a copy of the string with escaped characters replaced by their meanings according to the XML standard.
String Array.
String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory.
Create from a generic array.
Append an element at the end of the array (alias of [method push_back]).
Append an [StringArray] at the end of this array.
Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
Reverse the order of the elements in the array (so first element will now be the last).
Append a string element at end of the array.
Remove an element from the array by index.
Set the size of the [StringArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
Change the [String] at the given index.
Return the size of the array.
Base class for drawing stylized boxes for the UI.
StyleBox is [Resource] that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below.
Return the default offset of the margin "margin" (see MARGIN_* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded.
Return the offset of margin "margin" (see MARGIN_* enum).
Return the minimum size that this stylebox can be shrunk to.
Return the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code].
Set the default offset "offset" of the margin "margin" (see MARGIN_* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded.
Test a position in a rectangle, return whether it passes the mask test.
Empty stylebox (does not display anything).
Empty stylebox (really does not display anything).
Stylebox of a single color.
Stylebox of a single color. Displays the stylebox of a single color, alternatively a border with light/dark colors can be assigned.
Image mask based StyleBox, for mask test.
This StyleBox is similar to [StyleBoxTexture], but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the point clicked is masked or not.
Return whether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size.
Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand.
Return the image used for mask testing. (see [method set_image]).
Set the expand property (default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size.
Set an expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand.
Set the image used for mask testing. Pixels (converted to grey) that have a value, less than 0.5 will fail the test.
Texture Based 3x3 scale style.
Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles.
Helper tool to create geometry.
Helper tool to create geometry.
TCP Server.
TCP Server class. Listens to connections on a port and returns a [StreamPeerTCP] when got a connection.
Return true if a connection is available for taking.
Listen on a port using protocol, alternatively give a white-list of accepted hosts.
Stop listening.
If a connection is available, return a StreamPeerTCP with the connection/
Tabbed Container.
Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking on the top tabs allows to change the currently visible one. Children controls of this one automatically.
Return whether the tabs should be visible or hidden.
Return the current tab that is being showed.
Return tab alignment, from the ALIGN_* enum.
Return the amount of tabs.
Return the title for the tab. Tab titles are by default the children node name, but this can be overridden.
Bring a tab (and the Control it represents) to the front, and hide the rest.
Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center.
Set an icon for a tab.
Set a title for the tab. Tab titles are by default the children node name, but this can be overridden.
Set whether the tabs should be visible or hidden.
Emitted when the current tab changes.
Tabs Control.
Simple tabs control, similar to [TabContainer] but is only in charge of drawing tabs, not interact with children.
A simple cube used for testing in 3D.
The TestCube is a simple 2x2x2 cube with a basic texture. It can be used as a placeholder, to verify how the lighting looks, to test shaders, or any other task you may need a textured model to test with.
Multiline text editing control.
TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo.
Add color region (given the delimiters) and its colors.
Add a keyword and its color.
Clear all the syntax coloring information.
Clear the undo history.
Copy the current selection.
Gets whether the text editor caret is blinking.
Gets the text editor caret blink speed.
Return the column the editing cursor is at.
Return the line the editing cursor is at.
Gets whether the text editor caret is in block mode.
Set the text editor caret to blink.
Set the text editor caret blink speed. Cannot be less then or equal to 0.
Set the text editor caret to block mode.
Cut the current selection.
Return the text of a specific line.
Return the amount of total lines in the text.
Return the selection begin column.
Return the selection begin line.
Return the text inside the selection.
Return the selection end column.
Return the selection end line.
Return the whole text.
Insert a given text at the cursor position.
Returns true if highlight all occurrences is enabled.
Return true if the selection is active.
Returns true if line numbers are enabled.
Return true if the syntax coloring is enabled.
Paste the current selection.
Perform redo operation.
Perform a search inside the text. Search flags can be specified in the SEARCH_* enum.
Perform selection, from line/column to line/column.
Select all the text.
Set a custom background color. A background color with alpha==0 disables this.
Set to enable highlighting all occurrences of the current selection.
Set the maximum amount of characters editable.
Set the text editor as read-only. Text can be displayed but not edited.
Set to enable showing line numbers.
Set the color for symbols.
Set to enable the syntax coloring.
Set the entire text.
Enable text wrapping when it goes beyond he edge of what is visible.
Perform undo operation.
Emitted when a breakpoint is placed via the breakpoint gutter.
Emitted when the cursor changes.
Emitted when the text changes.
Match case when searching.
Match whole words when searching.
Search from end to beginning.
Texture for 2D and 3D.
A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite] or GUI [Control].
Return the current texture flags.
Return the texture height.
Return the texture RID as used in the [VisualServer].
Return the texture size.
Return the texture width.
Change the texture flags.
Generate mipmaps, to enable smooth zooming out of the texture.
Repeat (instead of clamp to edge).
Turn on magnifying filter, to enable smooth zooming in of the texture.
Texture is a video surface.
Default flags. Generate mipmaps, repeat, and filter are enabled.
Button that can be themed with textures.
Button that can be themed with textures. This is like a regular [Button] but can be themed by assigning textures to it. This button is intended to be easy to theme, however a regular button can expand (that uses styleboxes) and still be better if the interface is expect to have internationalization of texts. Only the normal texture is required, the others are optional.
Control Frame that draws a texture.
Control frame that simply draws an assigned texture. It can stretch or not. It's a simple way to just show an image in a UI.
Textured progress bar implementation.
[ProgressBar] implementation that is easier to theme (by just passing a few textures).
Theme for controls.
Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any [Control], and it and its children will automatically use it. Theme resources can be alternatively loaded by writing them in a .theme file, see docs for more info.
A unit of execution in a process.
A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects.
Return the id of the thread, uniquely identifying it among all threads.
Whether this thread is currently active, an active Thread cannot start work on a new method but can be joined with [method wait_to_finish].
Start a new [Thread], it will run "method" on object "instance" using "userdata" as an argument and running with "priority", one of PRIORITY_* enum. Returns OK on success, or ERR_CANT_CREATE on failure.
Joins the [Thread] and waits for it to finish. Returns what the method called returned.
Node for 2D tile-based games.
Node for 2D tile-based games. Tilemaps use a [TileSet] which contain a list of tiles (textures, their rect and a collision) and are used to create complex grid-based maps. To optimize drawing and culling (sort of like [GridMap]), you can specify a quadrant size, so chunks of the map will be batched together at drawing time.
Clear all cells.
Return the tile index of the referenced cell.
Return the cell size.
Return the tile index of the cell referenced by a Vector2.
Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner).
Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner).
Return the collision bounce parameter.
Return the collision friction parameter.
Return the collision layer.
Return the collision mask.
Return whether the tilemap handles collisions as a kinematic body.
Return the custom transform matrix.
Return the current half offset configuration.
Return the orientation mode.
Return the quadrant size.
Return the tile origin configuration.
Return the current tileset.
Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1).
Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector).
Return whether the referenced cell is flipped over the X axis.
Return whether the referenced cell is flipped over the Y axis.
Return the Y sort mode.
Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. Optionally, the tilemap's potential half offset can be ignored.
Set the tile index for the cell referenced by its grid-based X and Y coordinates. A tile index of -1 clears the cell. Optionally, the tile can also be flipped over the X and Y coordinates or transposed.
Set the cell size.
Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. A tile index of -1 clears the cell. Optionally, the tile can also be flipped over the X and Y axes or transposed.
Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner).
Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner).
Set the collision bounce parameter. Allowable values range from 0 to 1.
Set the collision friction parameter. Allowable values range from 0 to 1.
Set the collision layer. Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1.
Set the collision masks. Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1.
Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled).
Set custom transform matrix, to use in combination with the custom orientation mode.
Set an half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET_* constants as argument). Half offset sets every other tile off by a half tile size in the specified direction.
Set the orientation mode as square, isometric or custom (use MODE_* constants as argument).
Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. Allowed values are integers ranging from 1 to 128.
Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument).
Set the current tileset.
Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate. A tile with a higher Y coordinate will therefore be drawn later, potentially covering up the tile(s) above it if its sprite is higher than its cell size.
Return the tilemap (grid-based) coordinates corresponding to the absolute world position given as an argument.
Signal indicating that a tilemap setting has changed.
Returned when a cell doesn't exist.
Orthogonal orientation mode.
Isometric orientation mode.
Custom orientation mode.
Half offset on the X coordinate.
Half offset on the Y coordinate.
Half offset disabled.
Tile origin at its top-left corner.
Tile origin at its center.
Tile library for tilemaps.
A TileSet is a library of tiles for a [TileMap]. It contains a list of tiles, each consisting of a sprite and optional collision shapes. Tiles are referenced by a unique integer ID.
Clear all tiles.
Create a new tile which will be referenced by the given ID.
Find the first tile matching the given name.
Return the ID following the last currently used ID, useful when creating a new tile.
Return an array of all currently used tile IDs.
Remove the tile referenced by the given ID.
Return the light occluder of the tile.
Return the material of the tile.
Return the name of the tile.
Return the navigation polygon of the tile.
Return the offset of the tile's navigation polygon.
Return the offset of the tile's light occluder.
Return the tile sub-region in the texture.
Return the shape of the tile.
Return the shape offset of the tile.
Return the array of shapes of the tile.
Return the texture of the tile.
Return the texture offset of the tile.
Set a light occluder for the tile.
Set the material of the tile.
Set the name of the tile, for descriptive purposes.
Set a navigation polygon for the tile.
Set an offset for the tile's navigation polygon.
Set an offset for the tile's light occluder.
Set the tile sub-region in the texture. This is common in texture atlases.
Set a shape for the tile, enabling physics to collide with it.
Set the shape offset of the tile.
Set an array of shapes for the tile, enabling physics to collide with it.
Set the texture of the tile.
Set the texture offset of the tile.
A simple Timer node.
Timer node. This is a simple node that will emit a timeout callback when the timer runs out. It can optionally be set to loop.
Return the time left for timeout in seconds if the timer is active, 0 otherwise.
Return the timer's processing mode.
Return the wait time in seconds.
Return true if set to automatically start when entering the scene.
Return if the timer is active or not.
Return true if configured as one-shot.
Set whether the timer is active or not. An inactive timer will be paused until it is activated again.
Set to automatically start when entering the scene.
Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart.
Set the timer's processing mode (fixed or idle, use TIMER_PROCESS_* constants as argument).
Set wait time in seconds. When the time is over, it will emit the timeout signal.
Start the timer.
Stop (cancel) the timer.
Emitted when the time runs out.
Update the timer at fixed intervals (framerate processing).
Update the timer during the idle time at each frame.
3D Transformation.
Transform is used to store transformations, including translations. It consists of a Matrix3 "basis" and Vector3 "origin". Transform is used to represent transformations of any object in space. It is similar to a 4x3 matrix.
Construct the Transform from four Vector3. Each axis creates the basis.
Construct the Transform from a Matrix3 and Vector3.
Construct the Transform from a Matrix32.
Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0)
Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0)
Returns the inverse of the transfrom, even if the transform has scale or the axis vectors are not orthogonal.
Returns the inverse of the transform.
Rotate the transform around the up vector to face the target.
Returns a transfrom with the basis orthogonal (90 degrees), and normalized axis vectors.
Rotate the transform locally. This introduces an additional pre-rotation to the transform, changing the basis to basis * Matrix3(axis, phi).
Scale the transform locally.
Translate the transform locally.
Transforms vector "v" by this transform.
Inverse-transforms vector "v" by this transform.
- The basis contains 3 [Vector3]. X axis, Y axis, and Z axis.
- The origin of the transform. Which is the translation offset.
Language Translation.
Translations are resources that can be loaded/unloaded on demand. They map a string to another string.
Add a message for translation.
Erase a message.
Return the locale of the translation.
Return a message for translation.
Return all the messages (keys).
Set the locale of the translation.
Server that manages all translations. Translations can be set to it and removed from it.
Control to show a tree of items.
This shows a tree of items that can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like text editing, buttons and popups. It can be useful for structural displaying and interactions. Trees are built via code, using [TreeItem] objects to create the structure. They have a single root but multiple root can be simulated if a dummy hidden root is added. [codeblock] func _ready(): var tree = Tree.new() var root = tree.create_item() tree.set_hide_root(true) var child1 = tree.create_item(root) var child2 = tree.create_item(root) var subchild1 = tree.create_item(child1) subchild1.set_text(0, "Subchild1") [/codeblock]
Get whether the column titles are being shown.
Clear the tree. This erases all of the items.
Create an item in the tree and add it as the last child of [code]parent[/code]. If parent is not given, it will be added as the last child of the root, or it'll the be the root itself if the tree is empty.
Make the current selected item visible. This will scroll the tree to make sure the selected item is in sight.
Get whether a right click can select items.
Get the column index under the given point.
Get the title of the given column.
Get the width of the given column in pixels.
Get the amount of columns.
Get the rectangle for custom popups. Helper to create custom cell controls that display a popup. See [method TreeItem.set_cell_mode].
Get the flags of the current drop mode.
Get the current edited item. This is only available for custom cell mode.
Get the column of the cell for the current edited icon. This is only available for custom cell mode.
Get the rectangle area of the the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns.
Get the tree item at the specified position (relative to the tree origin position).
Get the next selected item after the given one.
Get the index of the last pressed button.
Get the root item of the tree.
Get the current scrolling position.
Get the currently selected item.
Get the column number of the current selection.
Get whether the editing of a cell should only happen when it is already selected.
Get whether the folding arrow is hidden.
Set whether or not a right mouse button click can select items.
Set whether a column will have the "Expand" flag of [Control].
Set the minimum width of a column.
Set the title of a column.
Set whether the column titles visibility.
Set the amount of columns.
Set the drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants.
Set whether the folding arrow should be hidden.
Set whether the root of the tree should be hidden.
Set the selection mode. Use one of the [code]SELECT_*[/code] constants.
Set whether the editing of a cell should only happen when it is already selected.
Emitted when a button on the tree was pressed (see [method TreeItem.add_button]).
Emitted when a cell is selected.
Emitted when a cell with the [code]CELL_MODE_CUSTOM[/code] is clicked to be edited.
Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty.
Emitted when an item is activated (double-clicked).
Emitted when an item is collapsed by a click on the folding arrow.
Emitted when an item is editted.
Emitted when an item is selected with right mouse button.
Emitted when an item is selected with right mouse button.
Node useful for animations with unknown start and end points.
Node useful for animations with unknown start and end points, procedural animations, making one node follow another, and other simple behavior. Because it is easy to get it wrong, here is a quick usage example: [codeblock] var tween = get_node("Tween") tween.interpolate_property(get_node("Node2D_to_move"), "transform/pos", Vector2(0,0), Vector2(100,100), 1, Tween.TRANS_LINEAR, Tween.EASE_IN_OUT) tween.start() [/codeblock] Some of the methods of this class require a property name. You can get the property name by hovering over the property in the inspector of the editor. Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an TRANS_* constant, and refers to the way the timing of the animation is handled (you might want to see [code]http://easings.net/[/code] for some examples). The second accepts an EASE_* constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the begining, the end, or both). If you don't know which transision and easing to pick, you can try different TRANS_* constants with EASE_IN_OUT, and use the one that looks best.
Follow [code]method[/code] of [code]object[/code] and apply the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] later. Methods are animated by calling them with consequitive values. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
Follow [code]property[/code] of [code]object[/code] and apply it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Note that [code]target:target_property[/code] would equal [code]object:property[/code] at the end of the tween. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished.
Returns the speed that has been set from editor GUI or [method set_repeat].
Returns the process mode that has been set from editor GUI or [method set_tween_process_mode]
Call [code]callback[/code] of [code]object[/code] after [code]times_in_sec[/code]. [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback.
Call [code]callback[/code] of [code]object[/code] after [code]times_in_sec[/code] on the main thread (similar to [methog Object.call_deferred). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback.
Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
Animate [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended.
Returns true if repeat has been set from editor GUI or [method set_repeat].
Stop animating and completely remove a tween, given its object and property/method pair. Passing empty String as key will remove all tweens for given object.
Stop animating and completely remove all tweens.
Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. Passing empty String as key will reset all tweens for given object.
Resets all tweens to their initial values (the ones given, not those before the tween).
Continue animating a stopped tween, given its object and property/method pair. Passing empty String as key will resume all tweens for given object.
Continue animating all stopped tweens.
Seek the animation to the given [code]time[/code] in seconds.
Activate/deactivate the tween. You can use this for pausing animations, though [method stop_all] and [method resume_all] might be more fit for this.
Make the tween repeat after all tweens have finished.
Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this.
Set whether the Tween uses [code]_process[/code] or [code]_fixed_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_FIXED constants, respectively).
Start the tween node. You can define tweens both before and after this.
Stop animating a tween, given its object and property/method pair. Passing empty String as key will stop all tweens for given object.
Stop animating all tweens.
Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
Animate [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
Returns the current time of the tween.
This signal is emitted when a tween ends.
This signal is emitted when a tween starts.
This signal is emitted each step of the tweening.
The [Tween] should use [code]_fixed_process[/code] for timekeeping when this is enabled.
The [Tween] should use [code]_process[/code] for timekeeping when this is enabled (default).
Means that the animation is interpolated linearly.
Means that the animation is interpolated using a sine wave.
Means that the animation is interpolated with a quinary (to the power of 5) function.
Means that the animation is interpolated with a quartic (to the power of 4) function.
Means that the animation is interpolated with a quadratic (to the power of 2) function.
Means that the animation is interpolated with a exponential (some number to the power of x) function.
Means that the animation is interpolated with elasticity, wiggling around the edges.
Means that the animation is interpolated with a cubic (to the power of 3) function.
Means that the animation is interpolated with a function using square roots.
Means that the animation is interpolated by bouncing at, but never surpassing, the end.
Means that the animation is interpolated backing out at edges.
Signifies that the interpolation should be focused in the beginning.
Signifies that the interpolation should be focused in the end.
Signifies that the interpolation should be focused in both ends.
Signifies that the interpolation should be focused in both ends, but they should be switched (a bit hard to explain, try it for yourself to be sure).
Helper to manage UndoRedo in the editor or custom tools.
Helper to maange UndoRedo in the editor or custom tools. It works by storing calls to functions in both 'do' an 'undo' lists. Common behavior is to create an action, then add do/undo calls to functions or property changes, then commiting the action.
Set a property with a custom value.
Add a 'do' reference that will be erased if the 'do' history is lost. This is useful mostly for new nodes created for the 'do' call. Do not use for resources.
Undo setting of a property with a custom value.
Add an 'undo' reference that will be erased if the 'undo' history is lost. This is useful mostly for nodes rmoved with the 'do' call (not the 'undo' call!).
Clear the undo/redo history and associated references.
Commit the action. All 'do' methods/properties are called/set when this function is called.
Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property] and [method add_un do_property].
Get the name of the current action.
Get the version, each time a new action is commited, the version number of the UndoRedo is increased automatically. This is useful mostly to check if something changed from a saved version.
Vertical box container.
Vertical box container. See [BoxContainer].
Vertical button array.
Vertical button array. See [ButtonArray].
Vertical version of [ScrollBar], which goes from left (min) to right (max).
Vertical version of [Separator].
Vertical version of [Separator]. It is used to separate objects horizontally, though (but it looks vertical!).
Vertical slider.
Vertical slider. See [Slider]. This one goes from left (min) to right (max).
Vertical split container.
Vertical split container. See [SplitContainer]. This goes from left to right.
Vector used for 2D Math.
2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values.
Constructs a new Vector2 from the given x and y.
Returns the result of atan2 when called with the Vector's x and y as parameters (Math::atan2(x,y)). Be aware that it therefore returns an angle oriented clockwise with regard to the (0, 1) unit vector, and not an angle oriented counter-clockwise with regard to the (1, 0) unit vector (which would be the typical trigonometric representation of the angle when calling Math::atan2(y,x)).
Returns the angle in radians between the two vectors.
Returns the angle in radians between the line connecting the two points and the x coordinate.
Cubicly interpolates between this Vector and "b", using "pre_a" and "post_b" as handles, and returning the result at position "t".
Returns the squared distance to vector "b". Prefer this function over "distance_to" if you need to sort vectors or need the squared distance for some formula.
Returns the distance to vector "b".
Returns the dot product with vector "b".
Remove the fractional part of x and y.
Remove the fractional part of x and y.
Returns the ratio of X to Y.
Returns the length of the vector.
Returns the squared length of the vector. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula.
Returns the result of the linear interpolation between this vector and "b", by amount "t".
Returns a normalized vector to unit length.
Like "slide", but reflects the Vector instead of continuing along the wall.
Rotates the vector by "phi" radians.
Slides the vector by the other vector.
Snaps the vector to a grid with the given size.
Returns a perpendicular vector.
- Height of the vector (Same as Y).
- Width of the vector (Same as X).
- X component of the vector.
- Y component of the vector.
An Array of Vector2.
An Array specifically designed to hold Vector2.
Construct a new [Vector2Array]. Optionally, you can pass in an Array that will be converted.
Append an element at the end of the array (alias of [method push_back]).
Append an [Vector2Array] at the end of this array.
Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
Reverse the order of the elements in the array (so first element will now be the last).
Insert a [Vector2] at the end.
Remove an element from the array by index.
Set the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
Change the [Vector2] at the given index.
Return the size of the array.
Vector class, which performs basic 3D vector math operations.
Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations.
Returns a Vector3 with the given components.
Returns a new vector with all components in absolute values (e.g. positive).
Returns a new vector with all components rounded up.
Return the cross product with b.
Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t).
Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula.
Return the distance to b.
Return the dot product with b.
Returns a new vector with all components rounded down.
Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )
Return the length of the vector.
Return the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula.
Linearly interpolates the vector to a given one (b), by the given amount (t).
Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest.
Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest.
Return a copy of the normalized vector to unit length. This is the same as v / v.length().
Like "slide", but reflects the Vector instead of continuing along the wall.
Rotates the vector around some axis by phi radians.
Slides the vector along a wall.
Return a copy of the vector, snapped to the lowest neared multiple.
- X component of the vector.
- Y component of the vector.
- Z component of the vector.
Enumerated value for the X axis. Returned by functions like max_axis or min_axis.
Enumerated value for the Y axis.
Enumerated value for the Z axis.
An Array of Vector3.
An Array specifically designed to hold Vector3.
Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted.
Append an element at the end of the array (alias of [method push_back]).
Append an [Vector3Array] at the end of this array.
Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
Reverse the order of the elements in the array (so first element will now be the last).
Insert a Vector3 at the end.
Remove an element from the array by index.
Set the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
Change the [Vector3] at the given index.
Return the size of the array.
Returns the VehicleBody's velocity vector. To get the absolute speed in scalar value, get the length of the return vector in pixels/second. Example: [codeblock] # vehicle is an instance of VehicleBody var speed = vehicle.get_linear_velocity().length() [/codeblock]
Control to play video files.
This control has the ability to play video streams. The only format accepted is the OGV Theora, so any other format must be converted before using in a project.
Get the selected audio track (for multitrack videos).
Get the amount of miliseconds to store in buffer while playing.
Get the video stream.
Get the name of the video stream.
Get the current position of the stream, in seconds.
Get the current frame of the video as a [Texture].
Get the volume of the audio track as a linear value.
Get the volume of the audio track in decibels.
Get whether or not the video is set as autoplay.
Get whether or not the expand property is set.
Get whether or not the video is paused.
Get whether or not the video is playing.
Start the video playback.
Set the audio track (for multitrack videos).
Set whether this node should start playing automatically.
Set the amount of miliseconds to buffer during playback.
Set the expand property. If enabled, the video will grow or shrink to fit the player size, otherwise it will play at the stream resolution.
Set whether the video should pause the playback.
Set the video stream for this player.
Set the audio volume as a linear value.
Set the audio volume in decibels.
Stop the video playback.
Creates a sub-view into the screen.
A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will render on it too. Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports. If a viewport is a child of a [Control], it will automatically take up its same rect and position, otherwise they must be set manually. Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it. Also, viewports can be assigned to different screens in case the devices have multiple screens. Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw.
Return the 3D world of the viewport, or if no such present, the one of the parent viewport.
Return the 2D world of the viewport.
Return the active 3D camera.
Get the canvas transform of the viewport.
Get the total transform of the viewport.
Get the global canvas transform of the viewport.
Get the mouse position, relative to the viewport.
Get whether picking for all physics objects inside the viewport is enabled.
Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space.
Return whether automatic clearing of the render target on each frame is enabled.
Get whether the rendered texture has filters enabled.
Get whether the rendered texture will have mipmaps generated.
Get the render target's texture, for use with various objects that you want to texture with the viewport.
Get when the render target would be updated, will be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants.
Set whether the render target is flipped on the Y axis.
Return the captured screenshot after [method queue_screen_capture]. You might need to check more than one frame untill the right image is returned.
Get the size override set with [method set_size_override].
Get the viewport RID from the visual server.
Return the final, visible rect in global screen coordinates.
Return the 3D world of the viewport.
Returs the drag data from the GUI, that was previously returned by [method Control.get_drag_data].
Returs whether there are shown modals on-screen.
Return whether the viewport lets whatever is behind it to show.
Returns whether the viewport sends sounds to the speakers.
Returns whether the viewport sends soundsfrom 2D emitters to the speakers.
Return whether input to the viewport is disabled.
Return whether the viewport is set as a render target by [method set_as_render_target].
Get the enabled status of the size override set with [method set_size_override].
Get the enabled status of the size strech override set with [method set_size_override_stretch].
Return whether the viewport is using a world separate from the parent viewport's world.
Queue a multithreaded screenshot, you can retrive it at a later frame via [method get_screen_capture].
Clear the render target manually.
Makes the viewport send sounds to the speakers.
Makes the viewport send sounds from 2D emitters to the speakers.
Set the viewport's render target mode.
Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport.
Set whether input to the viewport is disabled.
Set the global canvas transform of the viewport. The canvas transform is relative to this.
Enable/disable picking for all physics objects inside the viewport.
Set the viewport rect. If the viewport is child of a control, it will use the same rect as the parent.
Enable/disable automatic clearing of the render target on each frame. You might find it better to disable this if you are using the viewport for rarely updated textures. To clear manually, check [method render_target_clear]
Set whether the rendered texture should have filters enabled. Disable if you want the texture's pixels be visible.
Set whether the rendered texture should have mipmaps generated. Mipmaps allow the texture to have better antialiasing from far away.
Map a part of the screen to the render target directly.
Set when the render target should be updated, has to be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants.
Set whether the render target should be flipped on the Y axis.
Set the size of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size.
Set whether the size override affects stretch as well.
If this viewport is a child of another viewport, keep the previously drawn background visible.
Make the viewport use a world separate from the parent viewport's world.
Change the 3D world of the viewport.
Force update of the 2D and 3D worlds.
Warp the mouse to a position, relative to the viewport.
Emitted when the size of the viewport is changed, whether by [method set_size_override], resize of window, or some other means.
Do not update the render target.
Update the render target once, then switch to [code]RENDER_TARGET_UPDATE_DISABLED[/code]
Update the render target only when it is visible. This is the default value.
Update the render target always.
Displays a viewport as a sprite.
Used to display a [Viewport] node at some position in the world, without having to mess with [RenderTargetTexture]s.
Get color modulation for the texture. All texture pixels are multiplied by this color.
get the offset to the origin of the texture.
Return the path to the shown [Viewport] node.
Return whether the viewport's texture is centered on the origin.
Set whether the viewport's texture should be centered on the origin.
Set color modulation for the texture. All texture pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect.
Set the offset to the origin of the texture.
Set the path to the shown [Viewport] node.
Enable certain nodes only when visible.
The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself.
Returns whether the specified enabler was set to true or not.
Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler is not in view. See the constants for enablers and what they affect.
This enabler will freeze [RigidBody] nodes.
This enabler will pause [AnimationPlayer] nodes.
Enable certain nodes only when visible.
The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself.
Returns whether the specified enabler was set to true or not.
Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect.
This enabler will freeze [RigidBody2D] nodes.
This enabler will pause [AnimationPlayer] nodes.
This enabler will stop [Particles2D] nodes.
This enabler will stop the parent's _process function.
This enabler will stop the parent's _fixed_process function.
Detect when the node is visible on screen.
The VisibilityNotifier is used to notify when its bounding box enters the screen, is visible on the screen, or when it exits the screen.
Return the visibility bounding box of the VisibilityNotifier.
Return true if any part of the bounding box is on the screen.
Set the visibility bounding box of the VisibilityNotifier.
Emitted when the VisibilityNotifier enters a [Camera]'s view.
Emitted when the VisibilityNotifier enters the screen.
Emitted when the VisibilityNotifier exits a [Camera]'s view.
Emitted when the VisibilityNotifier exits the screen.
Detect when the node is visible on screen.
The VisibilityNotifier2D is used to notify when its bounding rectangle enters the screen, is visible on the screen, or when it exits the screen.
Return the visibility bounding rectangle of the VisibilityNotifier2D.
Return true if any part of the bounding rectangle is on the screen.
Set the visibility bounding rectangle of the VisibilityNotifier2D.
Emitted when the VisibilityNotifier2D enters the screen.
Emitted when the VisibilityNotifier2D enters a [Viewport].
Emitted when the VisibilityNotifier2D exits the screen.
Emitted when the VisibilityNotifier2D exits a [Viewport].
Server for anything visible.
Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display. The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed.
Holds an [Object], but does not contribute to the reference count if the object is a reference.
A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to eachother. Without weakrefs, using these classes could lead to memory leaks, since both references keep eachother from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released.
Returns the [Object] this weakref is referring to.
Base class for window dialogs.
Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [Control] that draws a window decoration and allows motion and resizing.
Return the close [TextureButton].
Return the title of the window.
Set the title of the window.
Class that has everything pertaining to a world.
Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world.
Class that has everything pertaining to a 2D world.
Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world.
Retrieve the [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing.
Retrieve the state of this world's physics space. This allows arbitrary querying for collision.
Retrieve the [RID] of this world's sound space resource. Used by the [SpatialSound2DServer] for 2D spatial audio.
Retrieve the [RID] of this world's physics space resource. Used by the [Physics2DServer] for 2D physics, treating it as both a space and an area.
Low-level class for creating parsers for XML files.
This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low level so it can be applied to any possible schema.
Get the amount of attributes in the current element.
Get the name of the attribute specified by the index in [code]idx[/code] argument.
Get the value of the attribute specified by the index in [code]idx[/code] argument.
Get the current line in the parsed file (currently not implemented).
Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute.
Get the value of a certain attribute of the current element by name. This will return an empty [String] if the attribute is not found.
Get the contents of a text node. This will raise an error in any other type of node.
Get the name of the current element node. This will raise an error if the current node type is not [code]NODE_ELEMENT[/code] nor [code]NODE_ELEMENT_END[/code]
Get the byte offset of the current node since the beginning of the file or buffer.
Get the type of the current node. Compare with [code]NODE_*[/code] constants.
Check whether or not the current element has a certain attribute.
Check whether the current element is empty (this only works for completely empty tags, e.g. <element \>).
Open a XML file for parsing. This returns an error code.
Open a XML raw buffer for parsing. This returns an error code.
Read the next node of the file. This returns an error code.
Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code.
Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element.
There's no node (no file or buffer opened)
Element (tag)
End of element
Text node
Comment node
CDATA content
Unknown node
Sort all child nodes based on their Y positions.
Sort all child nodes based on their Y positions. The child node must inherit from [CanvasItem] for it to be sorted. Nodes that have a higher Y position will be drawn later, so they will appear on top of nodes that have a lower Y position.
Returns true if the children nodes are being sorted.
Set whether the children nodes are sorted or not. (default true)
Boolean built-in type
Boolean built-in type.
Cast an [int] value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case.
Cast a [float] value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case.
Cast a [String] value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: [code]bool('False')[/code] returns true, [code]bool('')[/code]. returns false
Float built-in type
Float built-in type.
Cast a [bool] value to a floating point value, [code]float(true)[/code] will be equals to 1.0 and [code]float(false)[/code] will be equals to 0.0.
Cast an [int] value to a floating point value, [code]float(1)[/code] will be equals to 1.0.
Cast a [String] value to a floating point value. This method accepts float value strings like [code] '1.23' [/code] and exponential notation strings for its parameter so calling [code] float('1e3') [/code] will return 1000.0 and calling [code] float('1e-3') [/code] will return -0.001.
Integer built-in type.
Integer built-in type.
Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0.
Cast a float value to an integer value, this method simply removes the number fractions, so for example [code]int(2.7)[/code] will be equals to 2, [code]int(.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2.
Cast a [String] value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like [code]'1.7'[/code]. This method will ignore all non-number characters, so calling [code]int('1e3')[/code] will return 13.