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.
Standard sine function.
Standard cosine function.
Standard tangent function.
Hyperbolic sine.
Hyperbolic tangent.
Arc-sine.
Arc-cosine.
Arc-tangent.
Arc-tangent that takes a 2D vector as argument, retuns the full -pi to +pi range.
Square root.
Module (remainder of x/y).
Module (remainder of x/y) that wraps equally in positive and negative.
Floor (rounds down to nearest integer).
Ceiling (rounds up to nearest integer).
Round to nearest integer.
Remove sign (works for integer and float).
Return sign (-1 or +1).
Power function, x elevate to y.
Natural logarithm.
Exponential logarithm.
Return true if the float is not a number.
Return true if the float is infinite.
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.
Return the amount of decimals in the floating point value.
Snap float value to a given step.
Random value (integer).
Random value (0 to 1 float).
Random range.
random from seed, pass a seed and an array with both number and new seed is returned.
Convert from degrees to radians.
Convert from radias to degrees.
Convert from linear energy to decibels (audio).
Convert from decibels to linear energy (audio).
Return the maximum of two values.
Return the minimum of two values.
Clamp both values to a range.
Return the nearest larger power of 2 for an integer.
Return a weak reference to an object.
Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in Global Scope.
Convert one or more arguments to strings in the best way possible.
Convert one or more arguments to strings in the best way possible.
Print one or more arguments to strings in the best way possible to a console line.
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.
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).
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.
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
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
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.
Hint string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
Hint string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
Property hint is an enumerated value, like "Hello,Something,Else". This is valid for integers, floats and strings properties.
Property hint is a bitmask description, for bits 0,1,2,3 abd 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". 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 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 integer.
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 fo type [Matrix3].
Variable is fo type [Transform].
Variable is fo type [Color].
Variable is fo type [Image].
Variable is fo type [NodePath].
Variable is fo type [RID].
Variable is fo type [Object].
Variable is fo type [InputEvent].
Variable is fo type [Dictionary].
Variable is fo type [Array].
Axis-Aligned Bounding Box.
AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position and a size, and several utility functions. It is typically used for simple (fast) overlap tests.
Return true if this [AABB] completely encloses another one.
Return this [AABB] expanded to include a given point.
Get the area inside 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 a mount 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]s. 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.
Combine this [AABB] with another one, a larger one is returned that contains both.
Optional constructor, accepts position and size.
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.
Return the OK Button.
Return the label used for built-in text.
Set whether the dialog is hidden when accepted (default true).
Return true if the dialog will be hidden when accepted (default true).
Register a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
Set the built-in label text.
Return the built-in label text.
Emitted when accepted.
Emitted with a custom button is added.
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. [br] 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 te TYPE_* enumeration.
Remove a track by specifying the track index.
Return the amount of tracks in the animation.
Get the type of a track.
Get the path of a track. for more information on the path format, see [method track_set_path]
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"
Move a track up.
Nove a track down.
Insert a transform key for a transform track.
Insert a generic key in a given track.
Remove a key by index in a given track.
Remove a key by position (seconds) in a given track.
Set the value of an existing key.
Set the transition curve (easing) for a specific key (see built-in math function "ease").
Return the transition curve (easing) for a specific key (see built-in math function "ease").
Return the amount of keys in a given track.
Return the value of a given key in a given track.
Return the time at which the key is located.
Find the key index by time in a given track. Optionally, only find it if the exact time is given.
Set the interpolation type of a given track, from the INTERPOLATION_* enum.
Return the interpolation type of a given track, from the INTERPOLATION_* enum.
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]).
Enable or disable interpolation for a whole track. By default tracks are interpolated.
Return wether interpolation is enabled or disabled for a whole track. By default tracks are interpolated.
Return all the key indices of a value track, given a position and delta time.
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.
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.
Return the total length of the animation (in seconds).
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.
Return wether the animation has the loop flag set.
Clear the animation (clear all tracks and reset all).
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 [Animaton] 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 diferent channels.
Add an animation resource to the player, which will be later referenced by the "name" arguemnt.
Remove an animation from the player (by supplying the same name used to add it).
Rename an existing animation.
Request wether an [Animation] name exist within the player.
Get an [Animation] resource by requesting a name.
Get the list of names of the animations stored in the player.
Specify a blend time (in seconds) between two animations, referemced by their names.
Get the blend time between two animations, referemced by their names.
Set the default blend time between animations.
Return the default blend time between animations.
Stop playback on all animation channels.
Return wether an animation chanel is playing (or channel 0 if none is provided).
Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to claling play().
Return the name of the animation being played in a channel (or channel 0 if none is provided).
Queue an animation for playback once the current one is done.
Set the player as active (playing)
Return true if the player is active.
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).
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).
Set the name of the animation that will be automatically played when the scene is loaded.
Return the name of the animation that will be automatically played when the scene is loaded.
Seek the animation in an animation channel (or channel 0 if none is provided) to a specific position (in seconds).
Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided)
Find an animation name by resource.
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.
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_*.
Return the mode in which the animation player processes. See [method set_animation_process_mode].
General purpose area detection and influence for 2D Phisics.
General purpose area detection for 2D Phisics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). An Area2D can be set as a children to a RigidBody2D to generate a custom gravity field. For this, use SPACE_OVERRIDE_COMBINE and point gravity at the center of mass.
When overriding space parameters, areas can have a center of gravity as a point.
Return if gravity is a point. When overriding space parameters, areas can have a center of gravity as a point.
Set gravity vector. If gravity is a point, this will be the attraction center
Generic array datatype.
Generic array, contains several elements of any type, accessible by numerical index starting at 0. Arrays are always passed by reference.
Clear the array (resize to 0).
Return true if the array is empty (size==0).
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()).
Append an element at the end 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.
Return the amount of elements in the array.
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].
Server interface for low level audio access.
AudioServer is a low level server interface for audio access. It is"#10;"#9;in charge of creating sample data (playable audio) as well as it's"#10;"#9;playback via a voice interface.
Create an audio sample, return a [RID] referencing"#10;"#9;"#9;"#9;it. The sample will be created with a given format"#10;"#9;"#9;"#9;(from the SAMPLE_FORMAT_* enum), a total length (in"#10;"#9;"#9;"#9;frames, not samples or bytes), in either stereo or"#10;"#9;"#9;"#9;mono.
Set the description of an audio sample. Mainly used"#10;"#9;"#9;"#9;for organization.
Return the description of an audio sample. Mainly"#10;"#9;"#9;"#9;used for organization.
Return the format of the audio sample, in the form"#10;"#9;"#9;"#9;of the SAMPLE_FORMAT_* enum.
Return wether the sample is stereo (2 channels)
Return the length in frames of the audio sample (not"#10;"#9;"#9;"#9;samples or bytes).
Set the sample data for a given sample as an array"#10;"#9;"#9;"#9;of floats. The length must be equal to the sample"#10;"#9;"#9;"#9;lenght or an error will be produced.
Set the sample data for a given sample as an array"#10;"#9;"#9;"#9;of bytes. The length must be equal to the sample"#10;"#9;"#9;"#9;lenght expected in bytes or an error will be produced.
Return the sample data as an array of bytes. The"#10;"#9;"#9;"#9;length will be the expected length in bytes.
Change the default mix rate of a given sample.
Return the mix rate of the given sample.
Set the loop format for a sample from the"#10;"#9;"#9;"#9;SAMPLE_LOOP_* enum. As a warning, Ping Pong loops"#10;"#9;"#9;"#9;may not be available on some hardware-mixing"#10;"#9;"#9;"#9;platforms.
Return the loop format for a sample, as a value from"#10;"#9;"#9;"#9;the SAMPLE_LOOP_* enum.
Set the initial loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [method sample_set_loop_format].
Return the initial loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [method sample_set_loop_format].
Set the final loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [method sample_set_loop_format].
Return the final loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [method sample_set_loop_format].
Allocate a voice for playback. Voices are"#10;"#9;"#9;"#9;persistent. A voice can play a single sample at the"#10;"#9;"#9;"#9;same time. See [method sample_create].
Start playback of a given voice using a given"#10;"#9;"#9;"#9;sample. If the voice was already playing it will be"#10;"#9;"#9;"#9;restarted.
Change the volume of a currently playing voice."#10;"#9;"#9;"#9;Volume is expressed as linear gain where 0.0 is mute"#10;"#9;"#9;"#9;and 1.0 is default.
Change the pan of a currently playing voice and,"#10;"#9;"#9;"#9;optionally, the depth and height for a positional/3D"#10;"#9;"#9;"#9;sound. Panning values are expressed within the -1 to"#10;"#9;"#9;"#9;+1 range.
Set a resonant filter post processing for the voice."#10;"#9;"#9;"#9;Filter type is a value from the FILTER_* enum.
Set chorus send post processing for the voice (from"#10;"#9;"#9;"#9;0 to 1).
Set the reverb send post processing for the voice (from"#10;"#9;"#9;"#9;0 to 1) and the reverb type, from the REVERB_* enum.
Set a different playback mix rate for the given"#10;"#9;"#9;"#9;voice.
Set wether a given voice is positional. This is only"#10;"#9;"#9;"#9;interpreted as a hint and used for backends that may"#10;"#9;"#9;"#9;support binaural encoding.
Return the current volume for a given voice.
Return the current pan for a given voice (-1 to +1"#10;"#9;"#9;"#9;range).
Return the current pan height for a given voice (-1 to +1"#10;"#9;"#9;"#9;range).
Return the current pan depth for a given voice (-1 to +1"#10;"#9;"#9;"#9;range).
Return the current selected filter type for a given"#10;"#9;"#9;"#9;voice, from the FILTER_* enum.
Return the current filter cutoff (in hz) for a given"#10;"#9;"#9;"#9;voice.
Return the current filter resonance for a given"#10;"#9;"#9;"#9;voice.
Return the current chorus send for a given"#10;"#9;"#9;"#9;voice (0 to 1).
Return the current reverb type for a given voice"#10;"#9;"#9;"#9;from the REVERB_* enum.
Return the current reverb send for a given voice"#10;"#9;"#9;"#9;(0 to 1).
Return the current mix rate for a given voice.
Return wether the current voice is positional. See"#10;"#9;"#9;"#9;[method voice_set_positional].
Stop a given voice.
Free a [RID] resource.
Set global scale for stream playback. Default is 1.0.
Return the global scale for stream playback.
Sample format is 8 bits, signed.
Sample format is 16 bits, signed.
Sample format is IMA-ADPCM compressed.
Sample does not loop.
Sample loops in forward mode.
Sample loops in a bidirectional way.
Filter is disable.
Filter is a resonant lowpass.
Filter is a resonant bandpass.
Filter is a resonant highpass.
Filter is a notch.
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.
Base class for audio streams.
Base class for audio streams. Audio streams are used for music"#10;"#9;playback, or other types of streamed sounds that don't fit or"#10;"#9;requiere more flexibility than a [Sample].
Start playback of an audio stream.
Stop playback of an audio stream.
Return wether the audio stream is currently playing.
Set the loop hint for the audio stream playback. if"#10;"#9;"#9;"#9;true, audio stream will attempt to loop (restart)"#10;"#9;"#9;"#9;when finished.
Return wether the audio stream loops. See [method set_loop]
Return the name of the audio stream. Often the song"#10;"#9;"#9;"#9;title when the stream is music.
Return the amount of times that the stream has"#10;"#9;"#9;"#9;looped (if loop is supported).
Seek to a certain position (in seconds) in an audio"#10;"#9;"#9;"#9;stream.
Return the current playing position (in seconds) of the audio"#10;"#9;"#9;"#9;stream (if supported). Since this value is updated"#10;"#9;"#9;"#9;internally, it may not be exact or updated"#10;"#9;"#9;"#9;continuosly. Accuracy depends on the sample buffer"#10;"#9;"#9;"#9;size of the audio driver.
Return the type of update that the stream uses. Some"#10;"#9;"#9;"#9;types of stream may need manual polling.
Manually poll the audio stream (if it is requested"#10;"#9;"#9;"#9;to).
Does not need update, or manual polling.
Stream is updated on the main thread, when idle.
Stream is updated on its own thread.
Simple gibberish speech stream playback.
AudioStream used for gibberish playback. It plays randomized phonemes, which can be used to accompany text dialogs.
Set the phoneme library.
Return the phoneme library.
Set pitch scale for the speech. Animating this value holds amusing results.
Return the pitch scale.
Set the random scaling for the pitch.
Return the pitch random scaling.
Set the cross-fade time between random phonemes.
Return the cross-fade time between random phonemes.
MusePack audio stream driver.
MusePack audio stream driver.
Set the file to be played.
Return the file being played.
OGG Vorbis audio stream driver.
OGG Vorbis audio stream driver.
Base class for resampled audio streams.
Base class for resampled audio streams.
Speex audio stream driver.
Speex audio stream driver. Speex is very useful for compressed speech. It allows loading a very large amount of speech in memory at little IO/latency cost.
Set the speech file (which is loaded to memory).
Return the speech file.
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 doesnt display anything). Other types of buttons inherit from it.
Set the button to pressed state (only if toggle_mode is active).
Return when the button is pressed (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.
Return the toggle_mode property (see [method set_toggle_mode]).
Set the button into disabled state. When a button is disabled, it can"apos;t be clicked or toggled.
Return wether the button is in disabled state (see [method set_disabled]).
Set the button click_on_press mode. This mode generates click events when a mousebutton 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).
Return the state of the click_on_press property (see [method set_click_on_press]).
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.
This signal is emitted every time the button is pressed or toggled.
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.
Box shape resource.
Box shape resource, which can be set into a [PhysicsBody] or area.
Set the half extents for the shape.
Return the half extents of the shape.
Standard themed Button.
Button is just the standard themed button: [image src="images/button_example.png"/] It can contain text and an icon, and will display them according to the current [Theme].
Set the button text, which will be displayed inside the button area.
Return the button text.
Set the [i]flat[/i] property of a Button. Flat buttons don"apos;t display decoration unless hoevered or pressed.
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.
Return the state of the [i]clip_text[/i] property (see [method set_clip_text])
Return the state of the [i]flat[/i] property (see [method set_flat])
Array of Buttons.
Array of Buttons. A Button array is useful to have an array of buttons laid out vertically or horizontally. Only one can be selected. This is useful for joypad based interfaces and option menus.
Add a new button.
Set the icon of an existing button.
Return the text of an existing button.
Return the icon of an existing button.
Return the amount of buttons in the array.
Return the currently selected button in the array.
Return the currently hovered button in the array.
Sekect a button in the array.
Remove a button in the array, by index.
Clear the button array.
A Button was selected (returns the index).
Align buttons at the begining.
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]s. All direct and indirect children buttons become radios. Only one allows being pressed.
Return the pressed button.
Return the index of the pressed button (by tree order).
Return the focused button.
Return the list of all the buttons in the group.
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.
Return a normal vector in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera proyection. 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 proyection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
Return how a 3D point in worldpsace maps to a 2D coordinate in the [Viewport] rectangle.
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.
Set the camera projection to orthogonal mode, by specifying a"#10;"#9;"#9;"#9;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)
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"apos;s added.
Return wether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree).
Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform.
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].
Set the scroll offset. Useful for looking around or camera shake animations.
Return the scroll offset.
Set to true if the camera is at the center of the screen (default: true).
Return true if the camera is at the center of the screen (default: true).
Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.
Return true of this is the current camera (see [method Camera2D.make_current]).
Set the scrolling limit in pixels
Return the scrolling limit in pixels
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.
Return the margins needed to drag the camera (see [method set_drag_margin]).
Return the camera position.
Force the camera to update scroll immediately.
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() overrided 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.
Used for editing, returns an opaque value represeting the transform state.
Used for editing, handle rotation.
Return a rect containing the editable contents of the item.
Return the canvas item RID used by [VisualServer] for this item.
Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden.
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.
Show the CanvasItem currently hidden.
Hide the CanvasItem currently visible.
Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw.
Set as toplevel. This means that it will not inherit transform from parent canvas items.
Return if set as toplevel. See [method set_as_toplevel]/
Set the blending mode from enum BLEND_MODE_*.
Return the current blending mode from enum BLEND_MODE_*.
Set canvas item opacity. This will affect the canvas item and all the children.
Return the canvas item opacity. This affects the canvas item and all the children.
Set canvas item self-opacity. This does not affect the opacity of children items.
Set canvas item as drawing over the parent canvas item (default: true).
Return if the canvas item is drawing over the parent canvas item (default: true).
Draw a line from a 2D point to another, with a given color and width.
Draw a colored rectangle.
Draw a colored circle.
Draw a texture at a given position.
Draw a textured rectangle at a given position, optionally modulated by a color.
Draw a textured rectangle region at a given position, optionally modulated by a color.
Draw a styled rectangle.
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 polygon of any amount of points, convex or concave.
Draw a colored polygon of any amount of points, convex or concave.
Draw a string using a custom font.
Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
Set a custom transform for drawing. Anything drawn afterwards will be transformed by this.
Emitted when the intem rect has changed.
Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing.
Emitted when the visibility (hidden/visible) changes.
Emitten when becoming hidden.
Mix blending mode.
Additive blending mode.
Substractive blending mode.
Multiplicative blending mode.
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).
Set the layer index, determines the draw order, a lower value will be below a higher one.
Return the layer index, determines the draw order, a lower value will be below a higher one.
Set the base transform for this layer.
Return the base transform for this layer.
Set the base offset for this layer (helper).
Return the base offset for this layer (helper).
Set the base rotation for this layer (helper).
Return the base rotation for this layer (helper).
Set the base scale for this layer (helper).
Return the base scale for this layer (helper).
Return the [World2D] used by this layer.
Return the viewport RID for this layer.
Capsule shape resource.
Capsule shape resource, which can be set into a [PhysicsBody] or area.
Set the capsule radius.
Return the capsule radius.
Set the capsule height.
Return the capsule height.
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 modelling biped characters.
Radius of the [CapsuleShape2D].
Return the radius of the [CapsuleShape2D].
Height of the [CapsuleShape2D].
Return the height of the [CapsuleShape2D].
Keeps children controls centered.
CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center.
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 modelling balls or small characters and it's collision detection with everything else is very fast.
Set the radius of the circle shape;
Return 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 CollisionBody2D and CollisionPolygon2D nodes as children. Such nodes are for reference ant not present outside the editor, so code should use the regular shape API.
Add a [Shape2D] to the collision body, with a given custom transform.
Return the amount of shapes in the collision body.
Change a shape in the collision body.
Change the shape transform in the collision body.
Return the shape in the given index.
Return the shape transform in the given index.
Remove the shape in the given index.
Remove all shapes.
Editor-Only class.
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.
Editor-Only class.
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.
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, ranging from 0 to 1.
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 represets a RGBA).
Convert color to ARGB32, more compatible with DirectX.
Return the HTML hexadecimal color string.
Construct the color from an RGBA profile.
Construct the color from an RGBA profile.
Array of Colors
Array of Color, can only contains colors. Optimized for memory usage, cant fragment the memory.
Get an index in the array.
Append a value to the array.
Resize the array.
Set an index in the array.
Return the array size.
Create from a generic array.
Color picker control.
This is a simple color picker [Control]. It's useful for selecting a color from an RGB/RGBA colorspace.
Select the current color.
Return the current (edited) color.
Emitted when the color changes.
Concave polygon shape.
Concave polygon shape resource, which can be set into a [PhysicsBody] or area."#10; This shape is created by feeding a list of triangles.
Set the faces (an array of triangles).
Return 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 RigidBody 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.
Set the array of segments.
Return the array of segments.
Dialog for confirmation of actions.
Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel buton (in host OS order).
Return the cancel button.
Base node for containers.
Base node for conainers. A [Container] contains other controls and automatically arranges them in a certain way. A Control can inherit this to reate custom container classes.
Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
Enmitted 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 [Node._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 overrided per each control by calling the add_*_override functions, or from the editor.
Called when an input event reaches the control.
Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
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].
Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
Return wether this control is a [i]window[/i]. Controls are considered windows when their parent [Node] is not a Control.
Return the [i]window[/i] for this control, ascending the scene tree (see [method is_window]).
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 previos 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]).
Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
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.
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]).
Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]).
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]).
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]).
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.
Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
Returns the Control position, relative to the top-left corner of the parent Control and independly of the anchor mode.
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]).
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]).
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]).
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]).
Display a Control as modal. Control must be a subwindow (see [method set_as_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.
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.
Return wether the Control is the current focused control (see [method set_focus_mode]).
Steal the focus from another control and become the focused control (see [method set_focus_mode]).
Give up the focus, no other control will be able to receive keyboard input.
Return which control is owning the keyboard focus, or null if no one.
Hint for containers, set horizontal positioning flags.
Hint for containers, return horizontal positioning flags.
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.
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.
Hint for containers, set vertical positioning flags.
Hint for containers, return vertical positioning flags.
Override whole the [Theme] for this Control and all its children controls.
Return a [Theme] override, if one exists (see [method set_theme]).
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.
Override a single font (font) in the theme of this Control. If font is empty, override is cleared.
Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared.
Set a tooltip, which will appear when the cursor is resting over this control.
Return the tooltip, which will appear when the cursor is resting over this control.
Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
Return the cursor shape at a certain position in the control.
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.
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.
Ignore mouse events on this control (even touchpad events send mouse events).
Return if the control is ignoring mouse events (even touchpad events send mouse events).
Emitted when keyboard focus is gained.
Emitted when the mouse enters the control area.
Emitted when the control changed size.
Emitted when the minimum size of the control changed.
Emitted when the size flags changed.
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 mouse left the control area.
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.
Create the point set from a point cloud. The resulting convex hull will be set as the shape.
Set a list of points in either clockwise or counter clockwise order, forming a convex polygon.
Return a list of points in either clockwise or counter clockwise order, forming a convex polygon.
Damped sprint constraint for 2D physics.
Damped sprint constraint for 2D physics. This resembles a sprint joint that always want to go back to a given length.
Set the maximum length of the sprint joint.
Return the maximum length of the sprint joint.
Set the resting length of the sprint joint. The joint will always try to go to back this length when pulled apart.
Return the resting length of the sprint joint. The joint will always try to go to back this length when pulled apart.
Set the stiffness of the spring joint.
Return the stiffness of the spring joint.
Set the damping of the spring joint.
Return the damping of the spring joint.
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 a hashed integer value representing the dictionary contents.
Return the list of keys in the dictionary.
Return the size of the dictionary (in pairs).
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 worldpace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction.
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.
Clear all the added filters in the dialog.
Add a custom filter. Filter format is: "mask ; description", example (C++): dialog-"lt;add_filter("*.png ; PNG Images");
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).
Set the file dialog mode from the MODE_* enum.
Get the file dialog mode from the MODE_* enum.
Event emitted when the user selects a file (double clicks it or presses the OK button).
Editor will not allow to select unexisting files.
Editor will warn when a file exists.
Simple Material with a fixed parameter set.
FixedMaterial is a simple type of material [Resource], which contains a fixed amount of paramters. 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.
Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it"apos;s best to check the enum.
Return a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it"apos;s best to check the enum.
Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]).
Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]).
Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object.
Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object.
Sets a special transform used to post-transform UV coordinates of the uv_xfrom tecoord mode: TEXCOORD_UV_TRANSFORM
Returns the special transform used to post-transform UV coordinates of the uv_xfrom tecoord 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.
Set the total font height (ascent plus descent) in pixels.
Return the total font height (ascent plus descent) in pixels.
Set the font ascent (number of pixels above the baseline).
Return the font ascent (number of pixels above the baseline).
Return the font descent (number of pixels below the baseline).
Add a kerning pair to the [Font] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
Return a kerning pair as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
Add a texture to the [Font].
Add a character to the font, where "character" is the unicode value, "texture" is the texture index, "rect" is the region in the texture (in pixels!), "align" is the (optional) alignment for the character and "advance" is the (optional) advance.
Return the size of a character, optionally taking kerning into account if the next character is provided.
Return the size of a string, taking kerning and advance into account.
Clear all the font data.
Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies te 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 apassed. clipping the width. "pos" specifies te 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.
Base node for geometry based visual instances.
Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials.
Set the material override for the whole geometry.
Return 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.
Return true if a configuration value is present.
Set the order of a configuration value (influences when saved to the config file).
Return 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.
If returns true, this value can be saved to the configuration file. This is useful for editors.
Clear the whole configuration (not recommended, may break things).
Convert a path to a localized path (res:// path).
Convert a localized path (res://) to a full native OS path.
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 length of the groove.
Return the length of the groove.
Set the initial offset of the groove on body A.
Set the final offset of the groove on body A.
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 vertiacally, 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.
IP Protocol support functions.
IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see [TCP_Client], [TCP_Server]). IP provides hostname resolution support, both blocking and threaded.
Resolve a given hostname, blocking. Resolved hostname is returned as an IP.
Create a queue item for resolving a given hostname. The queue ID is returned, or RESOLVER_INVALID_ID on error.
Return the status of hostname queued for resolving, given it"apos;s queue ID. Returned status can be any of the RESOLVER_STATUS_* enumeration.
Return a resolved item address, or an empty string if an error happened or resolution didn"apos;t happen yet (see [method get_resolve_item_status]).
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.
Image datatype.
Built in native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it.
Return the global, unscaled, screen pointer coordinates. If the 2D viewport has been scaled, it may not work well with [Camera] or controls.
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 it's 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 if this input event is an echo event (usually for key events).
Return if this input event is pressed (for key, mouse, joy button or screen press events).
Empty input event.
Key event.
Mouse motion event.
Mouse button event.
Jostick motion event.
Joystick button event.
Singleton that manages actions.
Singleton that manages actions. InputMap has a list of the actions used in InputEvent, which can be modified.
Integer Array .
Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, cant fragment the memory.
Get an index in the array.
Append a value to the array.
Resize the array.
Set an index in the array.
Return the array size.
Create from a generic array.
Base node for all joint constraints in 2D phyisics.
Base node for all joint constraints in 2D phyisics. Joints take 2 bodies and apply a custom constraint.
Set the path to the A node for the joint. Must be of type PhysicsBody2D.
Return the path to the A node for the joint.
Set the path to the B node for the joint. Must be of type PhysicsBody2D.
Return the path to the B node for the joint.
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.
Set the alignmend mode to any of the ALIGN_* enumeration values.
Return the alignmend mode (any of the ALIGN_* enumeration values).
Set the label text. Text can contain newlines.
Return the label text. Text can contain newlines.
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.
Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]).
Return the height of a line.
Return the amount of lines.
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.
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.
Control that provides single line string editing.
LineEdit provides a single line string editor, used for text fields.
Clear the [LineEdit] text.
Select the whole string.
Set the text in the [LineEdit], clearing the existing one and the selection.
Return the text in the [LineEdit].
Set the cursor position inside the [LineEdit], causing it to scroll if needed.
Return the cursor position inside the [LineEdit].
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.
Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists.
Append text at cursor, scrolling the [LineEdit] when needed.
Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can"apos;t be modified and new text can"apos;t be added.
Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]).
Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*".
Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]).
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.
When the text changes, this signal is emitted.
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.
Set the line normal.
Return the line normal.
Set the line distance from the origin.
Return the line distance from the origin.
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 [SceneMainLoop] 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.
Set a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list.
Return a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list.
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.
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.
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).
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).
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.
Triangle geometry is drawn as lines if this flag is enabled.
Geometry world transform is computed as billboard if this flag is enabled, often used for impostors.
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 substractive 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].
Return the determinant of the matrix.
Return euler angles from the matrix.
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).
Return the rotated version of the matrix, by a given axis and angle.
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.
Create a matrix from 3 axis vectors.
Create a matrix from 3 axis vectors.
Create a matrix from 3 axis vectors.
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 bulding 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 prefered to a single surface, because objects created in 3D editing software commonly contain multiple materials.
Create a new surface ([method get_surface_count] will become surf_idx for this.[br]"#10;"#9;"#9;"#9;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).[br]"#10;"#9;"#9;"#9;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.
Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
Return the length in vertices of the vertex array in the requested surface (see [method add_surface]).
Return the length in indices of the index array in the requested surface (see [method add_surface]).
Return the format mask of the requested surface (see [method add_surface]).
Return the primitive type of the requested surface (see [method add_surface]).
Set a [Material] for a given surface. Surface will be rendered using this material.
Return a [Material] in a given surface. Surface is 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)).
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 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 sigle [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.
Set the [Mesh] resource for the instance.
Return the current [Mesh] resource for the instance.
Return the AABB of the mesh, in local coordinates.
This helper creates a [StaticBody] child [Node] using the mesh geometry as collision. It"apos;s mainly used for testing.
Library of meshes.
Library of meshes. Contains a list of [Mesh] resources, each with name and ID. Useful for GridMap or painting Terrain.
Create a new item in the library, supplied an id.
Set the name of the item.
Set the mesh of the item.
Return the name of the item.
Return the mesh of the item.
Remove the item.
Clear the library.
Return the list of items.
Get an unused id for a new item.
Provides high perfomance 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. [br]For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead.[br] As a drawback, if the instances are too far away of each other, performance may be reduced as every sigle instance will always rendered (they are spatially indexed as one, for the whole object).[br] Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [method generate_aabb].
Set the [Mesh] resource to be drawn in multiple instances.
Return the [Mesh] resource drawn as multiple instances.
Set the amount of instnces that is going to be drawn. Changing this number will erase all the existing instance transform and color data.
Return the amount of instnces that is going to be drawn.
Set the transform for a specific instance.
Return the transform of a specific instance.
Set the color of a specific instance.
Get the color of a specific instance.
Set the visibility AABB. If not provided, MultiMesh will not be visible.
Return the visibility 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.
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).
Set the [MultiMesh] to be instance.
Return the [MultiMesh] that is used for instancing.
Base class for all the "Scene" elements.
Nodes can be set as children of other nodes, resulting in a tree arrangement. Any tree of nodes is called a "Scene". Scenes can be saved to disk, and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of the projects. [SceneMainLoop] contains the "active" tree of nodes, and a node becomes active (receinving NOTIFICATION_ENTER_SCENE) when added to that tree. A node can contain any number of nodes as a children (but there is only one tree root) with the requirement that no two childrens with the same name can exist. 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). Nodes can be set to "process" state, so they constantly receive a callback requesting them to process (do anything). Normal processing ([method _process]) happens as fast as possible and is dependent on the frame rate, so the processing time delta is variable. Fixed processing ([method _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 with every input that the program receives. Since this is usually too overkill (unless used for simple projects), an [method _unhandled_input] function is called when the input was not handled by anyone else (usually, GUI [Control] nodes). To keep track of the scene hieararchy (specially when instancing scenes into scenes) an "owner" can be set to a node. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed, it will free all its children nodes too.
Called when entered the scene.
Called when being removed from the scene.
Called for fixed processing (synced to the physics).
Called when any input happens (also must enable with [method set_process_input] or the property).
Called for processing. This is called every frame, with the delta time from the previous frame.
Called when ready (entered scene and children entered too).
Called when any input happens that was not handled by something else (also must enable with [method set_process_unhandled_input] or the property).
Called when any key input happens that was not handled by something else.
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.
Return the name of the [Node]. Name is be unique within parent.
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.
Remove a child [Node]. Node is NOT deleted and will have to be deleted manually.
Return the amount of children nodes.
Return a children node by it"apos;s index (see [method get_child_count]). This method is often used for iterating all children of a node.
Fetch a node. "path" must be valid (or else error will occur) and can be either the name of a child node, a relative path (from the current node to another node), or an absolute path to a node.[br] Examples ofa paths are: get_node("Sword") , get_node("../Swamp/Alligator") , get_node("/MyGame"). [br]Note: fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_scene]).
Return the parent [Node] of the current [Node], or an empty Object if the node lacks a parent.
Return wether the node is inside a scene tree (a tree where the topmost node is a [RootNode])
Return [i]true[/i] if the "node" argument is a direct or indirect child of the current node, otherwise return [i]false[/i].
Return [i]true[/i] if "node" occurs later in the scene hierarchy than the current node, otherwise return [i]false[/i].
Return the absolute path of the current node. This only works if the curent node is inside the scene tree (see [method is_inside_scene]).
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.
Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies" "Collectables", etc. 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_scene]).
Remove a node from a group.
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 chilren nodes may be useful.
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.
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.
Get the node owner (see [method set_node_owner]).
Remove a node and set all its children as childrens of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed.
Get the node index in the parent (assuming it has a parent).
Print the screne to stdout. Used mainly for debugging purposes.
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.
Return a filename that may be containedA node can 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]).
Notify the current node and all its chldren recursively by calling notification() in all of them.
Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60fps, 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_time].
Return the time elapsed since the last fixed frame. This is always the same in fixed proecssing unless the frames per second is changed in [OS].
Return true if fixed processing is enabled (see [method set_fixed_process]).
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_time].
Return the time elapsed (in seconds) since the last process callback. This is almost always different each time.
Return wether processing is enabled in the current node (see [method set_process]).
Enable input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input (see [method _input]).
Return true if the node is processing input (see [method set_process_input]).
Enable unhandled input processing for node. This is not requiered 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]).
Return true if the node is processing unhandled input (see [method set_process_unhandled_input]).
Return true if the node can process.
Get the current SceneMainLoop. Only returned if the node is inside the scene, else returns null.
Return a duplicate of the scene, with all nodes and parameters copied. Subscriptions will not be duplicated.
Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost.
Emitted when the node enters the scene.
Emitted when the node is renamed.
Emitted when the node exits the scene.
Notification received when the node enters the Scene Tree and gains access to the [RootNode]. Note that children nodes will not have received the notification at that time yet.
Notification received when the node exits the Scene Tree and loses access to the [RootNode]. Note that parent nodes will not have received the notification at that time yet.
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 hierachies for animation and positioning.
Set the position of the 2d node.
Set the rotation of the 2d node.
Set the scale of the 2d node.
Return the position of the 2D node.
Return the rotation of the 2D node.
Return the scale of the 2D node.
Return the global position of the 2D node.
Built-in type optimized for path traversing.
Built-in type optimized for path traversing. A Node path is an optimized compiled path used for traversing the scene tree. It references nodes and can reference properties in that node, or even reference properties inside the resources of the node.
Return a path level name.
Return the path level count.
Return the property associated (empty if none).
Return the subname level name.
Return the subname count.
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 " Time -Timers -Environment Variables -Execution of Binaries -Command Line
Return the mouse pos.
Set clipboard to the OS.
Get clipboard from the host OS.
Change the video mode.
Return the current video mode size.
Return true if the current video mode is fullscreen.
Return true if the window is resizable.
Return the list of fullscreen modes.
Set the amount of fixed iterations per second (for fixed process and physics).
Return the amount of fixed iterations per second (for fixed process and physics).
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.
Return true if low cpu usage mode is enabled.
Return the path tot he current engine executable.
Execute the binary file in given path, optionally blocking until it returns. A process ID is returned.
Kill a process ID.
Return an environment variable.
Return true if an envieronment variable exists.
Return the name of the host OS.
Return the commandline passed to the engine.
Return the main loop object (see [MainLoop]).
Return the current date.
Return the current time.
Delay executing of the current thread by given usecs.
Return the amount of time passed in milliseconds since the engine started.
Return the host OS locale.
Return true if the host OS allows drawing.
Return the total amount of frames drawn.
Return true if the engine was executed with -v (verbose stdout).
Return the state of the mouse buttons (each button in each bit).
Return the max amount of static memory used (only works in debug).
Return the total amount of dynamic memory used (only works in debug).
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 keps 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 [_set]. However, scripting languages and C++ have simper 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.
Return a property, return null if the property does not exist.
Return the property list, array of dictionaries, dictionaries must countain: 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.
Return the type of the object as a string.
Check the type of the obeject against a string (including inheritance).
Set property into the object.
Get a property from the object.
Return the list of properties as an array of dictionaries, dictionaries countain: 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).
Notify the object of something.
Return the instance ID. All objects have a unique instance ID.
Set a script into the object, scripts extend the object functionality.
Return the object script (or null if it doesn't have one).
Set a metadata into the object. Medatada is serialized. Metadata can be [i]anything[/i].
Return a metadata from the object.
Return true if a metadata is found with the requested name.
Return the list of metadatas in the object.
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 [@GlobalScope] TYPE_*).
Emit a signal. Arguments are passed in an array.
Call a function in the object, result is returned.
Create and store a function in the object. The call will take place on idle time.
Return the list of signals as an array of dictionaries.
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.
Return true if a connection exists for a given signal and target/method.
If set to true, signal emission is blocked.
Return true if signal emission blocking is enabled.
Set true if this object can translate strings (in calls to tr() ). Default is true.
Return true if this object can translate strings.
deprecated, will go away.
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 lightbulb 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 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 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.
Set the text of an item at index "idx".
Set the icon of an item at index "idx".
Set the ID of an item at index "idx".
Return the text of the item at index "idx".
Return the icon of the item at index "idx".
Return the ID of the item at index "idx".
Return the amount of items in the OptionButton.
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].
Select an item by index and make it the current item.
Return the current item index
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.
explain ownership, and that node does not need to own itself
Pack will ignore any sub-nodes not owned by given node. See [Node.set_owner].
Abstraction and base class for packet-based protocols.
PacketPeer is an abstration 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.
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
Provides an opaque background for [Control] children.
Panel is a [Control] that displays an opaque background. It's commoly used as a parent and container for other types of [Control] nodes."#10;"#9;[center][img]images/panel_example.png[/img][/center]
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.
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).
Set total amount of particles in the system.
Return the total amount of particles in the system.
Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate.
Return the "emitting" property state (see [method set_emitting]).
Set the visibility AABB for the particle system, since the default one will not work properly most of the time.
Return the current visibility AABB.
Set the half extents for the emission box.
Return the half extents for the emission box.
Set the normal vector towards where gravity is pulling (by default, negative Y).
Return the normal vector towards where gravity is pulling (by default, negative Y).
Set a specific variable for the particle system (see VAR_* enum).
Return a specific variable for the particle system (see VAR_* enum).
Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted.
Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted.
Set the position of a color phase (0 to 1)
Return the position of a color phase (0 to 1)
Set the color of a color phase.
Return the color of a color phase.
Set the material used to draw particles
Return the material used to draw particles
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 necesary to access to this directly (path remapping happens automatically when opeining a file), it's exported just for information.
Add a remap from a file to another.
Return true if a file is being remapped.
Return the remapped new path of a file.
Erase a remap.
Clear all remaps.
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 total gravity vector being currently applied to this body.
Return the space density currently being applied to this body.
Return the inverse of the mass of the body.
Return the inverse of the inertia of the body.
Change the linear velocity of the body.
Return the current linear velocity of the body.
Change the angular velocity of the body.
Return the angular velocity of the body.
Change the transform matrix of the body.
Return the transform matrix of the body.
Set the sleeping state of the body, only affects character/rigid bodies.
Return true if this body is currently sleeping (not active).
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 position (of this body) of the contact point.
Return the local shape index of the collision.
Return the RID of the collider.
Return the contact position in 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 collider shape index.
Return the linear velocity vector at contact point of the collider.
Return the timestep (delta) used for the simulation.
Call the built-in force integration code.
Return the current state of space, useful for queries.
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.
Intersect a ray in a given space, the returned object is a dictionary with the following fields: [br] position: place where ray is stopped[br] normal: normal of the object at the point where the ray was stopped [br] shape: shape index of the object agaisnt which the ray was stopped[br] collider_: collider agaisnt which the ray was stopped[br] collider_id: collider id of the object agaisnt which the ray was stopped[br] collider: collider object agaisnt which the ray was stopped[br] rid: [RID] of the object agaisnt which the ray was stopped[br] If the ray did not intersect anything, then null is returned instead of a [Dictionary].
Intersect a given shape (RID or [Shape2D]) against the space, the intersected shapes are returned in a special result object.
Physics 2D Server.
Physics 2D Server is the server responsible for all 2D physics.
Base class for differnt types of Physics bodies.
PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it.
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.
Returns true if "p" is inside the plane (by a very minimum treshold).
Returns true if this plane intersects with planes "a" and "b". The resulting intersectin is placed in "r".
Returns true if ray consiting of position "p" and direction normal "d" intersects this plane. If true, the result is placed in "r".
Returns true if segment from position "sa" to position "sb" intersects this plane. If true, the result is placed in "r".
Returns true if "p" 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.
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.
Popup (show the control in modal form) in the center of the screen, at the curent size, or at a size determined by "size".
Popup (show the control in modal form) in the center of the screen, scalled at a ratio of size of the screen.
Popup (show the control in modal form).
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).
Base class for Popup Dialogs
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 item with text "label" and icon "texture. An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index.
Add a new item with text "label". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index.
Add a new checkable item with text "label" and icon "texture. An id can optonally 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"apos;t have any built-in checking behavior and must be checked/unchecked manually.
Add a new checkable item with text "label". An id can optonally 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"apos;t have any built-in checking behavior and must be checked/unchecked manually.
Set the text of the item at index "idx".
Set the icon 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 fucused.
Set the checkstate status of the item at index "idx".
Set the id of the item at index "idx".
Return the text of the item at index "idx".
Return the icon 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 fucused.
Return the checkstate status of the item at index "idx".
Return the id of the item at index "idx".
Find and return the index of the item containing a given id.
Return the amount of items.
Add a separator between items. Separators also occupy an index.
Clear the popup menu.
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.
Base class for Popup Panels
Portals provide virtual openings to rooms.
Portals provide virtual openings to [RoomInstance] 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 [RoomInstance]. 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 [RoomInstance], 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 [RoomInstance] node as a parent, grandparent or far parent, or else they will not be active.
Set the portal shape. The shape is an array of [Point2] points, representing a convex polygon in the X,Y plane.
Return the portal shape. The shape is an array of [Point2] points, representing a convex polygon in the X,Y plane.
Enable the portal (it is enabled by defaul though), disabling it will cause the parent [RoomInstance] to not be visible any longer when looking through the portal.
Return wether the portal is active. When disabled it causes the parent [RoomInstance] to not be visible any longer when looking through the portal.
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]).
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]).
When the portal goes beyond the disable distance (see [method set_disable_distance]), it becomes opaque and displayed with color "color".
Return the color for when the portal goes beyond the disable distance (see [method set_disable_distance]) and becomes disabled.
Set the range for auto-connecting two portals from different rooms sharing the same space.
Return the range for auto-connecting two portals from different rooms sharing the same space.
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 progres bar.
General purpose progres 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 represet a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between to rotations obtained by a Matrix3 cheaply. Adding quaternions also cheaply adds the rotations, however quaternions need to be often normalized, or else they suffer from precision issues.
Returns the dot product between two quaternions.
Returns the inverse of the quaternion (applies to the inverse rotatio too).
Returns the length of the quaternion.
Returns the length of the quaternion, minus the square root.
Returns a copy of the quaternion, normalized to unit length.
Perform a spherical-linear interpolation with another quaternion.
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 need a [i]minimum[/i], [i]maximum[/i], using [i]step[/i] and [i]page[/i], for example a [ScrollBar].
Return the current value.
Return the minimum value.
Return the maximum value.
Return the stepping, if step is 0, stepping is disabled.
Return the page size, if page is 0, paging is disabled.
Return value mapped to 0 to 1 (unit) range.
Set minimum value, clamped range value to it if it"apos;s less.
Set step value. If step is 0, stepping will be disabled.
Set page size. Page is mainly used for scrollbars or anything that controls text scrolling.
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 value changes.
This signal is emitted when min, max, range or step change.
Raw byte array.
Raw byte array. Contains bytes. Optimized for memory usage, cant fragment the memory.
Ray 2D shape resource for physics.
Ray 2D shape resource for physics. A ray is not really a collision body, isntead it tries to separate itself from wathever is touching it's far endpoint. It's often useful for ccharacters.
Real Array .
Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, cant fragment the memory.
Rectangle Shape for 2D Physics.
Rectangle Shape for 2D Physics. This shape is useful for modelling box-like 2D objects.
Set the half extents, the actual width and height of this shape is twice the half extents.
Return the half extents, the actual width and height of this shape is twice the half extents.
Base class for anything refcounted.
Base class for anything refcounted. 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 it's size at all times.
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 desred). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource.
Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn"apos;t be changed by anything else.
Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn"apos;t be changed by anything else.
Set the name of the resources, any name is ok (it doesn"apos;t have to be unique). Name is for descriptive purposes only.
Return the name of the resources, any name is ok (it doesn"apos;t have to be unique). Name is for descriptive purposes only.
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.
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.
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 [get_resource].
Return the load stage. The total amount of stages can be queried with [get_stage_count]
Return the total amount of stages (calls to [poll] ) needed to completely load this resource.
Resource Loader.
Resource Loader. This is a static object accessible as [ResourceLoader]. GDScript has a simplified load() function, though.
Load a resource interactively, the returned object allows to load with high granularity.
Load a resource. Optionally a hint can be given for the resource type to load.
Return the list of recognized extensions for a resource type.
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 resourcs 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).
Remove a resource from the preloader by text id.
Rename a resource inside the preloader, from a text-id to a new text-id.
Return true if the preloader has a given resource.
Return the resource given a text-id.
Return the list of resources inside the preloader.
Resource Saving Interface.
Resource Saving Interface. This interface is used for saving resources to disk.
Save a resource to disk, to a given path.
Return the list of extensions available for saving a resource of a given type.
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.
Set to true if selecting the text inside this richtext is allowed.
Return true if selecting the text inside this richtext is allowed.
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 to Character or even 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.[br] 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.
Override this function to use a custom force integrator. This allows to hook up to the physics processing and alter the simulation state for the object on every frame.
Set the body mode, fromt he MODE_* enum. This allows to change to a static body or a character body.
Return the current body mode, see [set_mode].
Set the body mass.
Return the body mass.
Set the body mass given standard earth-weight (gravity 9.8). Not really useful for 2D since most measuers for this node are in pixels.
Return the body mass given standard earth-weight (gravity 9.8).
Set the body friction, from 0 (friction less) to 1 (full friction).
Return the body friction.
Set the body bounciness, from 0 (no bounce) to 1 (bounce).
Return the body bouncyness.
Set the body linear velocity. Can be used sporadically, but[b] DONT SET THIS IN EVERY FRAME [b], because physics may be running in another thread and definitely runs at a different granularity. Use [_integrate_forces] as your process loop if you want to have precise control of the body state.
Return the body linear velocity. This changes by physics granularity. See [set_linear_velocity].
Set the body angular velocity. Can be used sporadically, but[b] DONT SET THIS IN EVERY FRAME [b], because physics may be running in another thread and definitely runs at a different granularity. Use [_integrate_forces] as your process loop if you want to have precise control of the body state.
Return the body angular velocity. This changes by physics granularity. See [set_angular_velocity].
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.
Return the maximum contacts that can be reported. See [set_max_contacts_reported].
Set to true if the body shall not do any internal force integration at all (like gravity or air friction). Only the [_integrate_forces] will be able to integrate them if overrided.
Return true if the body is not doing any built-in force integration.
Enable contact monitoring. (the signals to notify when a body entered/exited collision).
Return wether contact monitoring is enabled.
Enable continuos collision detection. This prevents very fast-moving bodies (such as bullets) to not go through objects.
Return true if continuous collision detection is in use.
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).
Apply a positioned impulse (which will be affected by the body mass and shape).
Change the body state between sleeping/active states. As a note, static bodies can never be active.
Return the body state. As a note, static bodies are never active.
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.
Return true if the body has the ability to fall asleep when not moving. See [set_can_sleep].
Emitted when a new body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work.
Emitted when a new body sub-shape enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work.
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.
Static mode (does not move, can't be moved).
Rigid body, can move and rotate.
Character body, can move but not rotate.
Room data resource.
Room contains the data to define the bounds of a scene (using a BSP Tree). It is instanced by a [RoomInstance] 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 "format" (see FORMAT_* enum), stereo hint, and length in frames (not samples or bytes!) "frame". Calling create overrides previous existing data if it exists. Stereo samples are interleaved pairs of left and right (in that order) points
Return the sample format (see FORMAT_* enum).
Return true if the sample was created stereo.
Return the sample length in frames.
Set sample data. Data must be little endian, no matter the host platform, and exactly as long to fit all frames. Example, if data is Stereo, 16 bits, 256 frames, it will be 1024 bytes long.
Return sample data. Data will be endian, no matter with the host platform, and exactly as long to fit all frames. Example, if data is Stereo, 16 bits, 256 frames, it will be 1024 bytes long.
Set the mix rate for the sample (expected playback frequency).
Return the mix rate for the sample (expected playback frequency).
Set the loop format, see LOOP_* enum
Return the loop format, see LOOP_* enum.
Set the loop begin position, it must be a valid frame and less than the loop end position.
Return the loop begin position.
Set the loop end position, it must be a valid frame and greater than the loop begin position.
Return the loop begin position.
8-Bits signed little endian 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 untilloop begin). Not available in all platforms.
Library that contains a collection of Samples.
Library that contains a collection of Samples, each identified by an text id. This is used as a data containeer for the majority of the SamplePlayer classes and derivatives.
Add a sample to the library, with a given text id;
Return a sample from the library, from a given text-id. Return null if the sample is not found.
Return true if the sample text id exists in the library.
Remove a sample given a specific text id.
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.
Set the amount of simultaneous voices that will be used for playback.
Return the amount of simultaneous voices that will be used for playback.
Play back sample, given it"apos;s identifier "name". if "unique" is true, all othere previous samples will be stopped. The voice allocated for playback will be returned.
Stop a voice "voice". (see [method play]).
Change the mix rate of a voice "voice" to given "hz".
Scale the pitch (mix rate) of a voice by a ratio value "ratio". A ratio of 1.0 means the voice is unscaled.
Set the volume of a voice, 0db is maximum volume (every about -6db, volume is reduced in half). "db" does in fact go from zero to negative.
Set the panning of a voice. Panning goes from -1 (left) to +1 (right). Optionally, if the hardware supports 3D sound, also set depth and height (also in range -1 to +1).
Set and enable a filter of a voice, with type "type" (see FILTER_* enum), cutoff (0 to 22khz) frequency and resonance (0+).
Set the chorus send level of a voice (0 to 1). For setting chorus parameters, see [AudioServer].
Set the reverb send level and type of a voice (0 to 1). (see REVERB_* enum for type).
Return the current mix rate for a given voice.
Return the current pitch scale for a given voice.
Return the current volume (in db) for a given voice. 0db is maximum volume (every about -6db, volume is reduced in half). "db" does in fact go from zero to negative.
Return the current panning for a given voice. Panning goes from -1 (left) to +1 (right).
Return the current pan depth for a given voice (not used unless the hardware supports 3D sound)
Return the current pan height for a given voice (not used unless the hardware supports 3D sound)
Return the current filter type in use (see FILTER_* enum) for a given voice.
Return the current filter cutoff for a given voice. Cutoff goes from 0 to 22khz.
Return the current filter resonance for a given voice. Resonance goes from 0 up.
Return the current chorus send level for a given voice. (0 to 1).
Return the current reverb room type for a given voice (see REVERB_* enum).
Return the current reverb send level for a given voice. (0 to 1).
Filter is disabled for voice.
Lowpass filter is used for voice.
Bandpass filter is used for voice.
HighPass filter is used for voice.
Notch filter is used for voice.
Band-Limit filter is used for voice, in this case resonance is the highpass cutoff.
Small reverb room (house room).
Medium reverb room (street)
Large reverb room (Theather)
Huge reverb room (cathedral, warehouse).
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.
Set the sample library for the player.
Return the sample library used for the player.
Set the polyphony of the player (maximum amount of simultaneous voices).
Return the polyphony of the player (maximum amount of simultaneous voices).
Play a sample, an internal polyphony id can be passed, or else it's assigned automatically. Returns a voice id which can be used to modify the voice parameters.
Change the pitch scale of a currently playing voice.
Change the volume scale of a currently playing voice (using dB).
Return true if a voice is still active (false if it stopped playing).
Stop a given voice.
Stop all playing voices.
If the voice is invalid, this is returned.
Scene-Based implementation of the MainLoop.
Scene implementation of the MainLoop. All scenes edited using the editor are loaded with this main loop, which provides the base for the scene system.[br] All group operations (get nodes, call, etc) is performed here. All nodes in a group can be called a specific functions, set a property or notified. This happens in scene-order.
Call a notification in all the nodes belonging to a given group. See GROUP_CALL_* enum for options.
Set a property in all the nodes belonging to a given group. See GROUP_CALL_* enum for options.
Get all the nods belonging to a given group.
Set to true if the application will quit automatically when quit is requested (Alt-f4 or ctrl-c).
Set to true to tell nodes and the scene that it is being edited. This is used by editors, not release.
Return true if the scene is being run inside an editor.
Set pause. The built-in pause system is very basic and only meant to avoid processing nodes not allowed to work in pause mode.
Return true if the scene is paused.
Handle a current input event (avoid further processing of it).
Return the frame index (how many frames were drawn).
Quit the application.
Queue an object for deletion next time the loop goes idle.
Call a function for all the nodes in a given group.
Emitted when the screen changes size.
Emitted when a node is removed from the scene.
Emitted when the scene tree changed (nodes added/removed/moved/etc)
Regular group call flag (no flags).
Call a group in inverse-scene order.
Call a group immediately (usually calls are delivered on idle).
Call a group only once, even if call is performed many times.
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 true if a given object uses an instance of this script.
Return true if the script contains source code.
Return the script source code (if available).
Set the script source code.
Reload the script. This will fail if there are existing instances.
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.
Segment Shape for 2D Collision Detection.
Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'.
Base class for separators.
Separator is a [Control] used for sepataring 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.
Use a custom solver bias. No need to change this unless you really know what you are doing.
Return the custom solver bias. No need to change this unless you really know what you are doing.
Skeleton for characters and animated objects.
Skeleton provides a hierachial 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.
Return the bone index that matches "name" as its name.
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".
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 amount of bones in the skeleton.
Return the rest transform for a bone "bone_idx".
Set the rest transform for bone "bone_idx"
Deprecated soon
Deprecated soon
Deprecated Soon
Clear all the bones in this skeleton.
Return the pose transform for bone "bone_idx".
Return the pose transform for bone "bone_idx".
Base class for GUI Sliders.
Base class for GUI Sliders.
Set amount of ticks to display in slider.
Return amounts of ticks to display on slider.
Return true if ticks are visible on borders.
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.
Set the transform locally, relative to the parent spatial node.
Return the local transform, relative to the bone parent.
Set the transform globally, relative to worldspace.
Return the gloal transform, relative to worldspace.
Return the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial.
Spatial nodes receive this notifacation with their global transform changes. This means that either the current or a parent node changed it's 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.
Set a specific suffix.
Return the specific suffix.
Set a prefix.
Set whether the spinbox is editable.
Return if the spinbox is editable.
Container for splitting and adjusting.
Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
Set the split offset.
Return the spluit offset;
Set if the split must be collapsed.
Return if the split is collapsed;
Spotlight Light, such as a reflector spotlight or a latern.
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.
Set the base texture for the sprite.
Return the base texture for the sprite.
Set whether the sprite should be centered on the origin.
Return if the sprite is centered at the local origin.
Set the sprite draw offset, useful for setting rotation pivots.
Return sprite draw offst.
Set true to flip the sprite horizontaly.
Return true if the sprite is flipped horizontally.
Set true to flip the sprite vertically.
Return true if the sprite is flipped vertically.
Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases.
Return if the sprite reads from a region.
Set the region rect to read from.
Return the region rect to read from.
Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation.
Return the amount of vertical frames. See [set_vframes].
Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation.
Return the amount of horizontal frames. See [set_hframes].
Set color modulation for the sprite. All sprite pixels are multiplied by this color.
Return color modulation for the sprite. All sprite pixels are multiplied by this color.
Sprite frame library for AnimatedSprite.
Sprite frame library for [AnimatedSprite].
Add a frame (texture).
Return the amount of frames.
Return a texture (frame).
Remove a frame
Clear the frames.
PhysicsBody for static collision objects.
StaticBody implements a static collision [Node], by utilizing a rigid body in the [PhysicsServer]. Static bodies are used for static collision. For more information on physics body nodes, see [PhysicsBody].
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 scenaro collision.[br] A static body also can 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 compute 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).
Enable or disable simulated motion mode.
Return true if simulated motion mode is enabled.
Set a constant linear velocity for the body.
Set a constant angular velocity for the body.
Return the constant linear velocity for the body.
Return the constant angular velocity for the body.
Abstraction and base class for stream-based protocols.
StreamPeer is an abstration 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.
Send a chunk of data through the connection, blocking if necesary until the data is done sending. This function returns an [Error] code.
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.
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.
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.
TCP Stream peer.
TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a tcp server.
Base class for audio stream playback.
Base class for audio stream playback. Audio stream players inherit from it.
Built-In string class.
This is the built in string class (and the one used by GDScript). It supports Unicode and provides all necesary 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 string in uppercase.
Perform a case-sensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater.
Return true if the string is empty.
If the string is a path to a file, return the extension.
Find the first occurence 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 occurence 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 occurence 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.
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.
Return an amount of characters from the left of the string.
Return the length of the string in characters.
Do a simple expression matching, using ? and * wildcards.
Do a simple, case insensitive, expression matching, using ? and * wildcards.
Perform a case-insensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater.
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 begining.
Perform a search for a substring, but start from the end of the string instead of the begining. Also search case-insensitive.
Return the right side of the string from a given position.
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 begining and the end.
Return the string converted to lowercase.
Return the string converted to uppercase.
Perform XML escaping on the string.
Perform XML un-escaping of the string.
String Array .
String Array. Array of strings. Can only contain strings. Optimized for memory usage, cant fragment the memory.
Base class for dawing stylized boxes for the UI.
StyleBox is [Resource] that provides an abstract base class for dawing stylized boxes for the UI. StyleBoxes are used for dawing 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.
Test a position in a rectangle, return wether it pases the mask test.
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.
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 Point2( style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP) )
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 poit clicked is masked or not.
Set the image used for mask testing. Pixels (converted to grey) that have a value, less than 0.5 will fail the test.
Return the image used for mask testing. (see [method set_imag]).
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.
Return wether 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.
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.
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.
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.
Listen on a port, alternatively give a white-list of accepted hosts.
Return true if a connection is available for taking.
If a connection is available, return a StreamPeerTCP with the connection/
Stop listening.
Tabbed Container.
Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking ont he top tabs allows to change the current visible one.[br] Children controls of this one automatically.
Return the amount of tabs.
Bring a tab (and the Control it represents) to the front, and hide the rest.
Return the current tab that is being showed.
Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center.
Return tab alignment, from the ALIGN_* enum
Set whether the tabs should be visible or hidden.
Return whether the tabs should be visible or hidden.
Set a title for the tab. Tab titles are by default the children node name, but this can be overriden.
Return the title for the tab. Tab titles are by default the children node name, but this can be overriden.
Set an icon for a tab.
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.
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.
Set the entire text.
Insert a given text at the cursor position.
Return the amount of total lines in the text.
Return the whole text.
Return the text of a specific line.
Set the current column of the text editor.
Set the current line of the text editor.
Return the column the editing cursor is at.
Return the line the editing cursor is at.
Set the text editor as read-only. Text can be displayed but not edited.
Enable text wrapping when it goes beyond he edge of what is visible.
Set the maximum amount of characters editable.
Cut the current selection.
Copy the current selection.
Paste the current selection.
Select all the text.
Perform selection, from line/column to line/column.
Return true if the selection is active.
Return the selection begin line.
Return the selection begin column.
Return the selection end line.
Return the selection end column.
Return the text inside the selection.
Perform a search inside the text. Search flags can be specified in the SEARCH_* enum.
Perform undo operation.
Perform redo operation.
Clear the undo history.
Set to enable the syntax coloring.
Return true if the syntax coloring is enabled.
Add a keyword and it's color.
Add color region (given the delimiters) and it's colors.
Set the color for symbols.
Set a custom background color. A background color with alpha==0 disables this.
Clear all the syntax coloring information.
Emitted when the text changes.
Emitted when the cursor changes.
Match case when searching.
Match whole words when searching.
Search from end to begining.
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]s.
Return the texture width.
Return the texture height.
Return the texture size.
Return the texture RID as used in the [VisualServer].
Change the texture flags.
Return the current texture flags.
Draw the texture into a a [VisualServer] canvas item.
Generate mipmaps.
Repeat (instead of clamp to edge).
Turn on magnifying filter.
Texture is a video surface
Default flags
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.[br] 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 the children will automatically use it.[br] Theme resources can be alternatively loaded by writing them in a .theme file, see wiki for more info.
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 the time of drawing.
Set the current tileset.
Return the current tileset.
Set the cell size.
Return the cell size.
Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time.
Return the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time.
Set tiles 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 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).
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).
Set the contents of a cell. Cells can be optionally flipped in y or x.
Return the contents of a cell.
Return if a given cell is flipped in x axis.
Return if a given cell is flipped in y axis.
Clear all cells.
Returned when a cell doesn't exist.
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.
Create a new tile, the ID must be specified.
Set the name of a tile, for decriptive purposes.
Return the name of a tile, for decriptive purposes.
Set the texture of the tile.
Return the texture of the tile.
Set the offset to draw the tile.
Return the offset to draw the tile.
Set the tile sub-region in the texture. This is common in texture atlases.
Return the tile sub-region in the texture. This is common in texture atlases.
Set a shape for the tile, enabling physics to collide it.
Return the shape of the tile.
Remove a tile, by integer id.
Clear all tiles.
Find an empty id for creating a new tile.
Find the first tile with the given name.
Timer node. This is a simple node that will emit a timeout callback when the timer runs out. It can optinally be set to loop.
Set wait time. When the time is over, it will emit timeout signal.
Return the wait time. When the time is over, it will emit timeout signal.
Set as one-shot. If true, timer will stop after timeout, otherwise it will automatically restart.
Return true if is set as one-shot. If true, timer will stop after timeout, otherwise it will automatically restart.
Set to automatically start when entering the scene.
Return true if set to automatically start when entering the scene.
Start the timer.
Stop (cancel) the timer.
Return the time left for timeout if the timer is active.
Emitted when the time runs out.
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.
Returns the inverse of the transform.
Transforms vector "v" by this transform.
Inverse-transforms vector "v" by this transform.
Language Translation.
Translations are resources that can be loaded/unloaded on demand. They map a string to another string.
Set the locale of the translation.
Return the locale of the translation.
Add a message for translation.
Return a message for translation.
Erase a message.
Return all the messages (keys).
Server that manages all translations. Translations can be set to it and removed from it.
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.
Returns the distance to vector "b".
Returns the dot product with vector "b".
Remove the fractional part of x and y.
Returns the length of the vector.
Returns the result of the linear interpolation between this vector and "b", by amount "i".
Returns a normalized vector to unit length.
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 vecor math operations.
Return the cross product with b.
Perform a cubic interpolation between vectors a,b,c,d (b is current), by the given amount (i).
Return the squared distance (distance minus the last square root) to b.
Return the distance to b.
Return the dot product with b.
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, without the square root step.
Linearly interpolates the vector to a given one (b), by the given amount (i)
Return a copy of the normalized vector to unit length. This is the same as v / v.length()
Return a copy of the vector, snapped to the lowest neared multiple.
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 renderon it too.[br] Optionally, a viewport can have it's own 2D or 3D world, so they don't share what they draw with other viewports.[br] If a viewport is a child of a [Control], it will automatically take up it's same rect and position, otherwise they must be set manually.[br] Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it.[br] Also, viewports can be assigned to different screens in the situation while devices have multiple screens.[br] Finaly, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw.
Set the viewport rect. If the viewport is child of a control, it will use the same as the parent.
Return the viewport rect. If the viewport is child of a control, it will use the same as the parent, otherwise if the rect is empty, the viewport will use all the allowed space.
Return the final, visuble rect in global screen coordinates.
Keep whathver the parent viewport has drawn
If this viewport is a child of another viewport, keep the previously drawn background visible.
Get the viewport RID from the visual server.
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.[br] The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed.
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.
Set the title of the window.
Return the title of the window.
Return the close [TextureButton].
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.
Boolean built-in type
Boolean built-in type.
Integer built-in type.
Integer built-in type.
Real (float) built-in type.
Real (float) built-in type.