Redot 26.2
Classes
API reference synchronized from Redot Engine revision 4f5b14abade2.
G
@GDScriptBuilt-in GDScript constants, functions, and annotations.@GlobalScopeGlobal scope constants and functions.GDExtensionA native library for GDExtension.GDExtensionManagerProvides access to GDExtension functionality.GDScriptA script implemented in the GDScript programming language.GDScriptSyntaxHighlighterA GDScript syntax highlighter that can be used with and nodes.Generic6DOFJoint3DA physics joint that allows for complex movement and rotation between two 3D physics bodies.Geometry2DProvides methods for some common 2D geometric operations.Geometry3DProvides methods for some common 3D geometric operations.GeometryInstance3DBase node for geometry-based visual instances.GLTFAccessorRepresents a glTF accessor.GLTFAnimationGLTFBufferViewRepresents a glTF buffer view.GLTFCameraRepresents a glTF camera.GLTFDocumentClass for importing and exporting glTF files in and out of Redot.GLTFDocumentExtensionextension class.GLTFDocumentExtensionConvertImporterMeshGLTFLightRepresents a glTF light.GLTFMeshGLTFMesh represents a glTF mesh.GLTFNodeglTF node class.GLTFObjectModelPropertyDescribes how to access a property as defined in the glTF object model.GLTFPhysicsBodyRepresents a glTF physics body.GLTFPhysicsShapeRepresents a glTF physics shape.GLTFSkeletonGLTFSkinGLTFSpecGlossArchived glTF extension for specular/glossy materials.GLTFStateRepresents all data of a glTF file.GLTFTextureGLTFTexture represents a texture in a glTF file.GLTFTextureSamplerRepresents a glTF texture samplerGPUParticles2DA 2D particle emitter.GPUParticles3DA 3D particle emitter.GPUParticlesAttractor3DAbstract base class for 3D particle attractors.GPUParticlesAttractorBox3DA box-shaped attractor that influences particles from nodes.GPUParticlesAttractorSphere3DA spheroid-shaped attractor that influences particles from nodes.GPUParticlesAttractorVectorField3DA box-shaped attractor with varying directions and strengths defined in it that influences particles from nodes.GPUParticlesCollision3DAbstract base class for 3D particle collision shapes affecting nodes.GPUParticlesCollisionBox3DA box-shaped 3D particle collision shape affecting nodes.GPUParticlesCollisionHeightField3DA real-time heightmap-shaped 3D particle collision shape affecting nodes.GPUParticlesCollisionSDF3DA baked signed distance field 3D particle collision shape affecting nodes.GPUParticlesCollisionSphere3DA sphere-shaped 3D particle collision shape affecting nodes.GradientA color transition.GradientTexture1DA 1D texture that uses colors obtained from a .GradientTexture2DA 2D texture that creates a pattern with colors obtained from a .GraphEditAn editor for graph-like structures, using s.GraphElementA container that represents a basic element that can be placed inside a control.GraphFrameGraphFrame is a special that can be used to organize other s inside a .GraphNodeA container with connection ports, representing a node in a .GridContainerA container that arranges its child controls in a grid layout.GridMapNode for 3D tile-based maps.GridMapEditorPluginEditor for nodes.GrooveJoint2DA physics joint that restricts the movement of two 2D physics bodies to a fixed axis.
A
AABBA 3D axis-aligned bounding box.AcceptDialogA base dialog used for user notification.AESContextProvides access to AES encryption/decryption of raw data.AimModifier3DThe rotates a bone to look at a reference bone.AnimatableBody2DA 2D physics body that can't be moved by external forces.AnimatableBody3DA 3D physics body that can't be moved by external forces.AnimatedSprite2DSprite node that contains multiple textures as frames to play for animation.AnimatedSprite3D2D sprite node in 3D world, that can use multiple 2D textures for animation.AnimatedTextureProxy texture for simple frame-based animations.AnimationHolds data that can be used to animate anything in the engine.AnimationLibraryContainer for resources.AnimationMixerBase class for and .AnimationNodeBase class for nodes.AnimationNodeAdd2Blends two animations additively inside of an .AnimationNodeAdd3Blends two of three animations additively inside of an .AnimationNodeAnimationAn input animation for an .AnimationNodeBlend2Blends two animations linearly inside of an .AnimationNodeBlend3Blends two of three animations linearly inside of an .AnimationNodeBlendSpace1DA set of s placed on a virtual axis, crossfading between the two adjacent ones.AnimationNodeBlendSpace2DA set of s placed on 2D coordinates, crossfading between the three adjacent ones.AnimationNodeBlendTreeA sub-tree of many type s used for complex animations.AnimationNodeExtensionBase class for extending s from GDScript, C#, or C++.AnimationNodeOneShotPlays an animation once in an .AnimationNodeOutputThe animation output node of an .AnimationNodeStateMachineA state machine with multiple s, used by .AnimationNodeStateMachinePlaybackProvides playback control for an .AnimationNodeStateMachineTransitionA transition within an connecting two s.AnimationNodeSub2Blends two animations subtractively inside of an .AnimationNodeSyncBase class for s with multiple input ports that must be synchronized.AnimationNodeTimeScaleA time-scaling animation node used in .AnimationNodeTimeSeekA time-seeking animation node used in .AnimationNodeTransitionA transition within an connecting two s.AnimationPlayerA node used for animation playback.AnimationRootNodeBase class for s that hold one or multiple composite animations.AnimationTreeA node used for advanced animation transitions in an .Area2DA region of 2D space that detects other s entering or exiting it.Area3DA region of 3D space that detects other s entering or exiting it.ArrayA built-in data structure that holds a sequence of elements.ArrayMeshtype that provides utility for constructing a surface from arrays.ArrayOccluder3D3D polygon shape for use with occlusion culling in .AspectRatioContainerA container that preserves the proportions of its child controls.AStar2DAn implementation of A* for finding the shortest path between two vertices on a connected graph in 2D space.AStar3DAn implementation of A* for finding the shortest path between two vertices on a connected graph in 3D space.AStarGrid2DAn implementation of A* for finding the shortest path between two points on a partial 2D grid.AtlasTextureA texture that crops out part of another Texture2D.AudioBusLayoutStores information about the audio buses.AudioEffectBase class for audio effect resources.AudioEffectAmplifyAdds an amplifying audio effect to an audio bus.AudioEffectBandLimitFilterAdds a band limit filter to the audio bus.AudioEffectBandPassFilterAdds a band pass filter to the audio bus.AudioEffectCaptureCaptures audio from an audio bus in real-time.AudioEffectChorusAdds a chorus audio effect.AudioEffectCompressorAdds a compressor audio effect to an audio bus.AudioEffectDelayAdds a delay audio effect to an audio bus.AudioEffectDistortionAdds a distortion audio effect to an Audio bus.AudioEffectEQBase class for audio equalizers.AudioEffectEQ10Adds a 10-band equalizer audio effect to an Audio bus.AudioEffectEQ21Adds a 21-band equalizer audio effect to an Audio bus.AudioEffectEQ6Adds a 6-band equalizer audio effect to an audio bus.AudioEffectFilterAdds a filter to the audio bus.AudioEffectHardLimiterAdds a hard limiter audio effect to an Audio bus.AudioEffectHighPassFilterAdds a high-pass filter to the audio bus.AudioEffectHighShelfFilterAdds a high-shelf filter to the audio bus.AudioEffectInstanceManipulates the audio it receives for a given effect.AudioEffectLimiterAdds a soft-clip limiter audio effect to an Audio bus.AudioEffectLowPassFilterAdds a low-pass filter to the audio bus.AudioEffectLowShelfFilterAdds a low-shelf filter to the audio bus.AudioEffectNotchFilterAdds a notch filter to the Audio bus.AudioEffectPannerAdds a panner audio effect to an audio bus.AudioEffectPhaserAdds a phaser audio effect to an audio bus.AudioEffectPitchShiftAdds a pitch-shifting audio effect to an audio bus.AudioEffectRecordAudio effect used for recording the sound from an audio bus.AudioEffectReverbAdds a reverberation audio effect to an Audio bus.AudioEffectSpectrumAnalyzerAudio effect that can be used for real-time audio visualizations.AudioEffectSpectrumAnalyzerInstanceQueryable instance of an .AudioEffectStereoEnhanceAn audio effect that can be used to adjust the intensity of stereo panning.AudioListener2DOverrides the location sounds are heard from.AudioListener3DOverrides the location sounds are heard from.AudioSampleBase class for audio samples.AudioSamplePlaybackMeta class for playing back audio samples.AudioServerServer interface for low-level audio access.AudioStreamBase class for audio streams.AudioStreamGeneratorAn audio stream with utilities for procedural sound generation.AudioStreamGeneratorPlaybackPlays back audio generated using .AudioStreamInteractiveAudio stream that can playback music interactively, combining clips and a transition table.AudioStreamMicrophonePlays real-time audio input data.AudioStreamMP3MP3 audio stream driver.AudioStreamOggVorbisA class representing an Ogg Vorbis audio stream.AudioStreamPlaybackMeta class for playing back audio.AudioStreamPlaybackInteractivePlayback component of .AudioStreamPlaybackOggVorbisAudioStreamPlaybackPlaylistPlayback class used for .AudioStreamPlaybackPolyphonicPlayback instance for .AudioStreamPlaybackResampledAudioStreamPlaybackSynchronizedAudioStreamPlayerA node for audio playback.AudioStreamPlayer2DPlays positional sound in 2D space.AudioStreamPlayer3DPlays positional sound in 3D space.AudioStreamPlaylistthat includes sub-streams and plays them back like a playlist.AudioStreamPolyphonicAudioStream that lets the user play custom streams at any time from code, simultaneously using a single player.AudioStreamRandomizerWraps a pool of audio streams with pitch and volume shifting.AudioStreamSynchronizedStream that can be fitted with sub-streams, which will be played in-sync.AudioStreamWAVStores audio data loaded from WAV files.
B
BackBufferCopyA node that copies a region of the screen to a buffer for access in shader code.BaseButtonAbstract base class for GUI buttons.BaseMaterial3DAbstract base class for defining the 3D rendering properties of meshes.BasisA 3×3 matrix for representing 3D rotation and scale.BitMapBoolean matrix.Bone2DA joint used with to control and animate other nodes.BoneAttachment3DА node that dynamically copies or overrides the 3D transform of a bone in its parent .BoneConstraint3DA node that may modify Skeleton3D's bone with associating the two bones.BoneMapDescribes a mapping of bone names for retargeting into common names defined by a .BoneTwistDisperser3DA node that propagates and disperses the child bone's twist to the parent bones.boolA built-in boolean type.BoxContainerA container that arranges its child controls horizontally or vertically.BoxMeshGenerate an axis-aligned box .BoxOccluder3DCuboid shape for use with occlusion culling in .BoxShape3DA 3D box shape used for physics collision.ButtonA themed button that can contain text and an icon.ButtonGroupA group of buttons that doesn't allow more than one button to be pressed at a time.
C
CallableA built-in type representing a method or a standalone function.CallbackTweenerCalls the specified method after optional delay.Camera2DCamera node for 2D scenes.Camera3DCamera node, displays from a point of view.CameraAttributesParent class for camera settings.CameraAttributesPhysicalPhysically-based camera settings.CameraAttributesPracticalCamera settings in an easy to use format.CameraFeedA camera feed gives you access to a single physical camera attached to your device.CameraServerServer keeping track of different cameras accessible in Redot.CameraTextureTexture provided by a .CanvasGroupMerges several 2D nodes into a single draw operation.CanvasItemAbstract base class for everything in 2D space.CanvasItemMaterialA material for s.CanvasLayerA node used for independent rendering of objects within a 2D scene.CanvasModulateA node that applies a color tint to a canvas.CanvasTextureTexture with optional normal and specular maps for use in 2D rendering.CapsuleMeshClass representing a capsule-shaped .CapsuleShape2DA 2D capsule shape used for physics collision.CapsuleShape3DA 3D capsule shape used for physics collision.CCDIK3DRotation based cyclic coordinate descent inverse kinematics solver.CenterContainerA container that keeps child controls in its center.ChainIK3DA to apply inverse kinematics to bone chains containing an arbitrary number of bones.CharacterBody2DA 2D physics body specialized for characters moved by script.CharacterBody3DA 3D physics body specialized for characters moved by script.CharFXTransformControls how an individual character will be displayed in a .CheckBoxA button that represents a binary choice.CheckButtonA button that represents a binary choice.CircleShape2DA 2D circle shape used for physics collision.ClassDBA class information repository.CodeEditA multiline text editor designed for editing code.CodeHighlighterA syntax highlighter intended for code.CollisionObject2DAbstract base class for 2D physics objects.CollisionObject3DAbstract base class for 3D physics objects.CollisionPolygon2DA node that provides a polygon shape to a parent.CollisionPolygon3DA node that provides a thickened polygon shape (a prism) to a parent.CollisionShape2DA node that provides a to a parent.CollisionShape3DA node that provides a to a parent.ColorA color represented in RGBA format.ColorPaletteA resource class for managing a palette of colors, which can be loaded and saved using .ColorPickerA widget that provides an interface for selecting or modifying a color.ColorPickerButtonA button that brings up a when pressed.ColorRectA control that displays a solid color rectangle.CompositorStores attributes used to customize how a Viewport is rendered.CompositorEffectThis resource allows for creating a custom rendering effect.CompressedCubemapAn optionally compressed .CompressedCubemapArrayAn optionally compressed .CompressedTexture2DTexture with 2 dimensions, optionally compressed.CompressedTexture2DArrayArray of 2-dimensional textures, optionally compressed.CompressedTexture3DTexture with 3 dimensions, optionally compressed.CompressedTextureLayeredBase class for texture arrays that can optionally be compressed.ConcavePolygonShape2DA 2D polyline shape used for physics collision.ConcavePolygonShape3DA 3D trimesh shape used for physics collision.ConeTwistJoint3DA physics joint that connects two 3D physics bodies in a way that simulates a ball-and-socket joint.ConfigFileHelper class to handle INI-style files.ConfirmationDialogA dialog used for confirmation of actions.ContainerBase class for all GUI containers.ControlBase class for all GUI controls.ConvertTransformModifier3DA that apply transform to the bone which converted from reference.ConvexPolygonShape2DA 2D convex polygon shape used for physics collision.ConvexPolygonShape3DA 3D convex polyhedron shape used for physics collision.CopyTransformModifier3DA that apply transform to the bone which copied from reference.CPUParticles2DA CPU-based 2D particle emitter.CPUParticles3DA CPU-based 3D particle emitter.CryptoProvides access to advanced cryptographic functionalities.CryptoKeyA cryptographic key (RSA or elliptic-curve).CSGBox3DA CSG Box shape.CSGCombiner3DA CSG node that allows you to combine other CSG modifiers.CSGCylinder3DA CSG Cylinder shape.CSGMesh3DA CSG Mesh shape that uses a mesh resource.CSGPolygon3DExtrudes a 2D polygon shape to create a 3D mesh.CSGPrimitive3DBase class for CSG primitives.CSGShape3DThe CSG base class.CSGSphere3DA CSG Sphere shape.CSGTorus3DA CSG Torus shape.CSharpScriptA script implemented in the C# programming language, saved with the .cs extension (Mono-enabled builds only).CubemapSix square textures representing the faces of a cube.CubemapArrayAn array of s, stored together and with a single reference.CurveA mathematical curve.Curve2DDescribes a Bézier curve in 2D space.Curve3DDescribes a Bézier curve in 3D space.CurveTextureA 1D texture where pixel brightness corresponds to points on a curve.CurveXYZTextureA 1D texture where the red, green, and blue color channels correspond to points on 3 curves.CylinderMeshClass representing a cylindrical .CylinderShape3DA 3D cylinder shape used for physics collision.
D
DampedSpringJoint2DA physics joint that connects two 2D physics bodies with a spring-like force.DecalNode that projects a texture onto a .DictionaryA built-in data structure that holds key-value pairs.DirAccessProvides methods for managing directories and their content.DirectionalLight2DDirectional 2D light from a distance.DirectionalLight3DDirectional light from a distance, as from the Sun.DisplayServerA server interface for low-level window management.DPITextureAn automatically scalable based on an SVG image.DTLSServerHelper class to implement a DTLS server.
E
EditorCommandPaletteRedot editor's command palette.EditorContextMenuPluginPlugin for adding custom context menus in the editor.EditorDebuggerPluginA base class to implement debugger plugins.EditorDebuggerSessionA class to interact with the editor debugger.EditorExportPlatformIdentifies a supported export platform, and internally provides the functionality of exporting to that platform.EditorExportPlatformAppleEmbeddedBase class for the Apple embedded platform exporters (iOS and visionOS).EditorExportPlatformExtensionBase class for custom implementations (plugins).EditorExportPlatformPCBase class for the desktop platform exporter (Windows and Linux/BSD).EditorExportPluginA script that is executed when exporting the project.EditorExportPresetExport preset configuration.EditorFeatureProfileAn editor feature profile which can be used to disable specific features.EditorFileDialogA modified version of used by the editor.EditorFileSystemResource filesystem, as the editor sees it.EditorFileSystemDirectoryA directory for the resource filesystem.EditorFileSystemImportFormatSupportQueryUsed to query and configure import format support.EditorImportPluginRegisters a custom resource importer in the editor.EditorInspectorA control used to edit properties of an object.EditorInspectorPluginPlugin for adding custom property editors on the inspector.EditorInterfaceRedot editor's interface.EditorNode3DGizmoGizmo for editing objects.EditorNode3DGizmoPluginA class used by the editor to define Node3D gizmo types.EditorPathsEditor-only singleton that returns paths to various OS-specific data folders and files.EditorPluginUsed by the editor to extend its functionality.EditorPropertyCustom control for editing properties that can be added to the .EditorResourceConversionPluginPlugin for adding custom converters from one resource format to another in the editor resource picker context menu; for example, converting a to a .EditorResourcePickerRedot editor's control for selecting type properties.EditorResourcePreviewA node used to generate previews of resources or files.EditorResourcePreviewGeneratorCustom generator of previews.EditorResourceTooltipPluginA plugin that advanced tooltip for its handled resource type.EditorSceneFormatImporterImports scenes from third-parties' 3D files.EditorSceneFormatImporterBlendImporter for Blender's .blend scene file format.EditorSceneFormatImporterFBX2GLTFImporter for the .fbx scene file format.EditorSceneFormatImporterGLTFEditorSceneFormatImporterUFBXImport FBX files using the ufbx library.EditorScenePostImportPost-processes scenes after import.EditorScenePostImportPluginPlugin to control and modifying the process of importing a scene.EditorScriptBase script that can be used to add extension functions to the editor.EditorScriptPickerRedot editor's control for selecting the script property of a .EditorSelectionManages the SceneTree selection in the editor.EditorSettingsObject that holds the project-independent editor settings.EditorSpinSliderRedot editor's control for editing numeric values.EditorSyntaxHighlighterBase class for used by the .EditorToasterManages toast notifications within the editor.EditorTranslationParserPluginPlugin for adding custom parsers to extract strings that are to be translated from custom files (.csv, .json etc.).EditorUndoRedoManagerManages undo history of scenes opened in the editor.EditorVCSInterfaceVersion Control System (VCS) interface, which reads and writes to the local VCS in use.EncodedObjectAsIDHolds a reference to an 's instance ID.ENetConnectionA wrapper class for an ENetHost.ENetMultiplayerPeerA MultiplayerPeer implementation using the ENet library.ENetPacketPeerA wrapper class for an ENetPeer.EngineProvides access to engine properties.EngineDebuggerExposes the internal debugger.EngineProfilerBase class for creating custom profilers.EnvironmentResource for environment nodes (like ) that define multiple rendering options.ExpressionA class that stores an expression you can execute.ExternalTextureTexture which displays the content of an external buffer.
F
FABRIK3DPosition based forward and backward reaching inverse kinematics solver.FastNoiseLiteGenerates noise using the FastNoiseLite library.FBXDocumentHandles FBX documents.FBXStateFileAccessProvides methods for file reading and writing operations.FileDialogA dialog for selecting files or directories in the filesystem.FileSystemDockRedot editor's dock for managing files in the project.floatA built-in type for floating-point numbers.FlowContainerA container that arranges its child controls horizontally or vertically and wraps them around at the borders.FogMaterialA material that controls how volumetric fog is rendered, to be assigned to a .FogVolumeA region that contributes to the default volumetric fog from the world environment.FoldableContainerA container that can be expanded/collapsed.FoldableGroupA group of foldable containers that doesn't allow more than one container to be expanded at a time.FontAbstract base class for fonts and font variations.FontFileHolds font source data and prerendered glyph cache, imported from a dynamic or a bitmap font.FontVariationA variation of a font with additional settings.FramebufferCacheRDFramebuffer cache manager for Rendering Device based renderers.
H
HashingContextProvides functionality for computing cryptographic hashes chunk by chunk.HBoxContainerA container that arranges its child controls horizontally.HeightMapShape3DA 3D height map shape used for physics collision.HFlowContainerA container that arranges its child controls horizontally and wraps them around at the borders.HingeJoint3DA physics joint that restricts the rotation of a 3D physics body around an axis relative to another physics body.HMACContextUsed to create an HMAC for a message using a key.HScrollBarA horizontal scrollbar that goes from left (min) to right (max).HSeparatorA horizontal line used for separating other controls.HSliderA horizontal slider that goes from left (min) to right (max).HSplitContainerA container that splits two child controls horizontally and provides a grabber for adjusting the split ratio.HTTPClientLow-level hyper-text transfer protocol client.HTTPRequestA node with the ability to send HTTP(S) requests.
I
IKModifier3DA node for inverse kinematics which may modify more than one bone.ImageImage datatype.ImageFormatLoaderBase class to add support for specific image formats.ImageFormatLoaderExtensionBase class for creating extensions (adding support for extra image formats).ImageFramesA container for sequence of s.ImageFramesFormatLoaderBase class to add support for specific image sequence formats.ImageFramesFormatLoaderExtensionBase class for creating extensions (adding support for extra image sequence formats).ImageTextureA based on an .ImageTexture3DTexture with 3 dimensions.ImageTextureLayeredBase class for texture types which contain the data of multiple s.ImmediateMeshMesh optimized for creating geometry manually.ImporterMeshA that contains vertex array-based geometry during the import process.ImporterMeshInstance3DInputA singleton for handling inputs.InputEventAbstract base class for input events.InputEventActionAn input event type for actions.InputEventFromWindowAbstract base class for -based input events.InputEventGestureAbstract base class for touch gestures.InputEventJoypadButtonRepresents a gamepad button being pressed or released.InputEventJoypadMotionRepresents axis motions (such as joystick or analog triggers) from a gamepad.InputEventKeyRepresents a key on a keyboard being pressed or released.InputEventMagnifyGestureRepresents a magnifying touch gesture.InputEventMIDIRepresents a MIDI message from a MIDI device, such as a musical keyboard.InputEventMouseBase input event type for mouse events.InputEventMouseButtonRepresents a mouse button being pressed or released.InputEventMouseMotionRepresents a mouse or a pen movement.InputEventPanGestureRepresents a panning touch gesture.InputEventScreenDragRepresents a screen drag event.InputEventScreenTouchRepresents a screen touch event.InputEventShortcutRepresents a triggered keyboard .InputEventWithModifiersAbstract base class for input events affected by modifier keys like Shift and Alt.InputMapA singleton that manages all s.InstancePlaceholderPlaceholder for the root of a .intA built-in type for integers.IntervalTweenerCreates an idle interval in a animation.IPInternet protocol (IP) support functions such as DNS resolution.ItemListA vertical list of selectable items with one or multiple columns.IterateIK3DA to approach the goal by repeating small rotations.
J
JacobianIK3DJacobian transpose based inverse kinematics solver.JavaClassRepresents a class from the Java Native Interface.JavaClassWrapperProvides access to the Java Native Interface.JavaObjectRepresents an object from the Java Native Interface.JavaScriptBridgeSingleton that connects the engine with the browser's JavaScript context in Web export.JavaScriptObjectA wrapper class for web native JavaScript objects.JNISingletonSingleton that connects the engine with Android plugins to interface with native Android code.Joint2DAbstract base class for all 2D physics joints.Joint3DAbstract base class for all 3D physics joints.JointLimitation3DA base class of the limitation that interacts with .JointLimitationCone3DA cone shape limitation that interacts with .JSONHelper class for creating and parsing JSON data.JSONRPCA helper to handle dictionaries which look like JSONRPC documents.
K
KinematicCollision2DHolds collision data from the movement of a .KinematicCollision3DHolds collision data from the movement of a .
L
LabelA control for displaying plain text.Label3DA node for displaying plain text in 3D space.LabelSettingsProvides common settings to customize the text in a .Light2DCasts light in a 2D environment.Light3DProvides a base class for different kinds of light nodes.LightmapGIComputes and stores baked lightmaps for fast global illumination.LightmapGIDataContains baked lightmap and dynamic object probe data for .LightmapperAbstract class extended by lightmappers, for use in .LightmapperRDThe built-in GPU-based lightmapper for use with .LightmapProbeRepresents a single manually placed probe for dynamic object lighting with .LightOccluder2DOccludes light cast by a Light2D, casting shadows.LimitAngularVelocityModifier3DLimit bone rotation angular velocity.Line2DA 2D polyline that can optionally be textured.LineEditAn input field for single-line text.LinkButtonA button that represents a link.LoggerCustom logger to receive messages from the internal error/warning stream.LookAtModifier3DThe rotates a bone to look at a target.
M
MainLoopAbstract base class for the game's main loop.MarginContainerA container that keeps a margin around its child controls.Marker2DGeneric 2D position hint for editing.Marker3DGeneric 3D position hint for editing.MarshallsData transformation (marshaling) and encoding helpers.MaterialVirtual base class for applying visual properties to an object, such as color and roughness.MCPBridgeMCPProtocolMCPServerMenuBarA horizontal menu bar that creates a menu for each child.MenuButtonA button that brings up a when clicked.MeshA that contains vertex array-based geometry.MeshConvexDecompositionSettingsParameters to be used with a convex decomposition operation.MeshDataToolHelper tool to access and edit data.MeshInstance2DNode used for displaying a in 2D.MeshInstance3DNode that instances meshes into a scenario.MeshLibraryLibrary of meshes.MeshTextureSimple texture that uses a mesh to draw itself.MethodTweenerInterpolates an abstract value and supplies it to a method called over time.MissingNodeAn internal editor class intended for keeping the data of unrecognized nodes.MissingResourceAn internal editor class intended for keeping the data of unrecognized resources.MobileVRInterfaceGeneric mobile VR implementation.ModifierBoneTarget3DА node that dynamically copies the 3D transform of a bone in its parent .MovieWriterAbstract class for non-real-time video recording encoders.MultiMeshProvides high-performance drawing of a mesh multiple times using GPU instancing.MultiMeshInstance2DNode that instances a in 2D.MultiMeshInstance3DNode that instances a .MultiplayerAPIHigh-level multiplayer API interface.MultiplayerAPIExtensionBase class used for extending the .MultiplayerPeerAbstract class for specialized s used by the .MultiplayerPeerExtensionClass that can be inherited to implement custom multiplayer API networking layers via GDExtension.MultiplayerSpawnerAutomatically replicates spawnable nodes from the authority to other multiplayer peers.MultiplayerSynchronizerSynchronizes properties from the multiplayer authority to the remote peers.MutexA binary for synchronization of multiple s.
N
NativeMenuA server interface for OS native menus.NavigationAgent2DA 2D agent used to pathfind to a position while avoiding obstacles.NavigationAgent3DA 3D agent used to pathfind to a position while avoiding obstacles.NavigationLink2DA link between two positions on s that agents can be routed through.NavigationLink3DA link between two positions on s that agents can be routed through.NavigationMeshA navigation mesh that defines traversable areas and obstacles.NavigationMeshGeneratorHelper class for creating and clearing navigation meshes.NavigationMeshSourceGeometryData2DContainer for parsed source geometry data used in navigation mesh baking.NavigationMeshSourceGeometryData3DContainer for parsed source geometry data used in navigation mesh baking.NavigationObstacle2D2D obstacle used to affect navigation mesh baking or constrain velocities of avoidance controlled agents.NavigationObstacle3D3D obstacle used to affect navigation mesh baking or constrain velocities of avoidance controlled agents.NavigationPathQueryParameters2DProvides parameters for 2D navigation path queries.NavigationPathQueryParameters3DProvides parameters for 3D navigation path queries.NavigationPathQueryResult2DRepresents the result of a 2D pathfinding query.NavigationPathQueryResult3DRepresents the result of a 3D pathfinding query.NavigationPolygonA 2D navigation mesh that describes a traversable surface for pathfinding.NavigationRegion2DA traversable 2D region that s can use for pathfinding.NavigationRegion3DA traversable 3D region that s can use for pathfinding.NavigationServer2DA server interface for low-level 2D navigation access.NavigationServer3DA server interface for low-level 3D navigation access.NinePatchRectA control that displays a texture by keeping its corners intact, but tiling its edges and center.NodeBase class for all scene objects.Node2DA 2D game object, inherited by all 2D-related nodes.Node3DBase object in 3D space, inherited by all 3D nodes.Node3DGizmoAbstract class to expose editor gizmos for .NodePathA pre-parsed scene tree path.NoiseAbstract base class for noise generators.NoiseTexture2DA 2D texture filled with noise generated by a object.NoiseTexture3DA 3D texture filled with noise generated by a object.
O
ObjectBase class for all other classes in the engine.Occluder3DOccluder shape resource for use with occlusion culling in .OccluderInstance3DProvides occlusion culling for 3D nodes, which improves performance in closed areas.OccluderPolygon2DDefines a 2D polygon for LightOccluder2D.OfflineMultiplayerPeerA which is always connected and acts as a server.OggPacketSequenceA sequence of Ogg packets.OggPacketSequencePlaybackOmniLight3DOmnidirectional light, such as a light bulb or a candle.OpenXRActionAn OpenXR action.OpenXRActionBindingModifierBinding modifier that applies on individual actions related to an interaction profile.OpenXRActionMapCollection of and resources for the OpenXR module.OpenXRActionSetCollection of resources that make up an action set.OpenXRAnalogThresholdModifierThe analog threshold binding modifier can modify a float input to a boolean input with specified thresholds.OpenXRAPIExtensionMakes the OpenXR API available for GDExtension.OpenXRBindingModifierBinding modifier base class.OpenXRBindingModifierEditorBinding modifier editor.OpenXRCompositionLayerThe parent class of all OpenXR composition layer nodes.OpenXRCompositionLayerCylinderAn OpenXR composition layer that is rendered as an internal slice of a cylinder.OpenXRCompositionLayerEquirectAn OpenXR composition layer that is rendered as an internal slice of a sphere.OpenXRCompositionLayerQuadAn OpenXR composition layer that is rendered as a quad.OpenXRDpadBindingModifierThe DPad binding modifier converts an axis input to a dpad output.OpenXRExtensionWrapperAllows implementing OpenXR extensions with GDExtension.OpenXRExtensionWrapperExtensionAllows implementing OpenXR extensions with GDExtension.OpenXRFutureExtensionThe OpenXR Future extension allows for asynchronous APIs to be used.OpenXRFutureResultResult object tracking the asynchronous result of an OpenXR Future object.OpenXRHandNode supporting hand and finger tracking in OpenXR.OpenXRHapticBaseOpenXR Haptic feedback base class.OpenXRHapticVibrationVibration haptic feedback.OpenXRInteractionProfileSuggested bindings object for OpenXR.OpenXRInteractionProfileEditorDefault OpenXR interaction profile editor.OpenXRInteractionProfileEditorBaseBase class for editing interaction profiles.OpenXRInteractionProfileMetadataMeta class registering supported devices in OpenXR.OpenXRInterfaceOur OpenXR interface.OpenXRIPBindingDefines a binding between an and an XR input or output.OpenXRIPBindingModifierBinding modifier that applies directly on an interaction profile.OpenXRRenderModelThis node will display an OpenXR render model.OpenXRRenderModelExtensionThis class implements the OpenXR Render Model Extension.OpenXRRenderModelManagerHelper node that will automatically manage displaying render models.OpenXRVisibilityMaskDraws a stereo correct visibility mask.OptimizedTranslationAn optimized translation, used by default for CSV Translations.OptionButtonA button that brings up a dropdown with selectable options when pressed.ORMMaterial3DA PBR (Physically Based Rendering) material to be used on 3D objects.OSProvides access to common operating system functionalities.
P
PackedByteArrayA packed array of bytes.PackedColorArrayA packed array of s.PackedDataContainerEfficiently packs and serializes or .PackedDataContainerRefAn internal class used by to pack nested arrays and dictionaries.PackedFloat32ArrayA packed array of 32-bit floating-point values.PackedFloat64ArrayA packed array of 64-bit floating-point values.PackedInt32ArrayA packed array of 32-bit integers.PackedInt64ArrayA packed array of 64-bit integers.PackedSceneAn abstraction of a serialized scene.PackedStringArrayA packed array of s.PackedVector2ArrayA packed array of s.PackedVector3ArrayA packed array of s.PackedVector4ArrayA packed array of s.PacketPeerAbstraction and base class for packet-based protocols.PacketPeerDTLSDTLS packet peer.PacketPeerExtensionPacketPeerStreamWrapper to use a PacketPeer over a StreamPeer.PacketPeerUDPUDP packet peer.PanelA GUI control that displays a .PanelContainerA container that keeps its child controls within the area of a .PanoramaSkyMaterialA material that provides a special texture to a , usually an HDR panorama.Parallax2DA node used to create a parallax scrolling background.ParallaxBackgroundA node used to create a parallax scrolling background.ParallaxLayerA parallax scrolling layer to be used with .ParticleProcessMaterialHolds a particle configuration for or nodes.Path2DContains a path for nodes to follow.Path3DContains a path for nodes to follow.PathFollow2DPoint sampler for a .PathFollow3DPoint sampler for a .PCKPackerCreates packages that can be loaded into a running project.PerformanceExposes performance-related data.PhysicalBone2DA -derived node used to make s in a react to physics.PhysicalBone3DA physics body used to make bones in a react to physics.PhysicalBoneSimulator3DNode that can be the parent of and can apply the simulation results to .PhysicalSkyMaterialA material that defines a sky for a resource by a set of physical properties.PhysicsBody2DAbstract base class for 2D game objects affected by physics.PhysicsBody3DAbstract base class for 3D game objects affected by physics.PhysicsDirectBodyState2DProvides direct access to a physics body in the .PhysicsDirectBodyState2DExtensionProvides virtual methods that can be overridden to create custom implementations.PhysicsDirectBodyState3DProvides direct access to a physics body in the .PhysicsDirectBodyState3DExtensionProvides virtual methods that can be overridden to create custom implementations.PhysicsDirectSpaceState2DProvides direct access to a physics space in the .PhysicsDirectSpaceState2DExtensionProvides virtual methods that can be overridden to create custom implementations.PhysicsDirectSpaceState3DProvides direct access to a physics space in the .PhysicsDirectSpaceState3DExtensionProvides virtual methods that can be overridden to create custom implementations.PhysicsMaterialHolds physics-related properties of a surface, namely its roughness and bounciness.PhysicsPointQueryParameters2DProvides parameters for .PhysicsPointQueryParameters3DProvides parameters for .PhysicsRayQueryParameters2DProvides parameters for .PhysicsRayQueryParameters3DProvides parameters for .PhysicsServer2DA server interface for low-level 2D physics access.PhysicsServer2DExtensionProvides virtual methods that can be overridden to create custom implementations.PhysicsServer2DManagerA singleton for managing implementations.PhysicsServer3DA server interface for low-level 3D physics access.PhysicsServer3DExtensionProvides virtual methods that can be overridden to create custom implementations.PhysicsServer3DManagerA singleton for managing implementations.PhysicsServer3DRenderingServerHandlerA class used to provide with a rendering handler for soft bodies.PhysicsShapeQueryParameters2DProvides parameters for 's methods.PhysicsShapeQueryParameters3DProvides parameters for 's methods.PhysicsTestMotionParameters2DProvides parameters for .PhysicsTestMotionParameters3DProvides parameters for .PhysicsTestMotionResult2DDescribes the motion and collision result from .PhysicsTestMotionResult3DDescribes the motion and collision result from .PinJoint2DA physics joint that attaches two 2D physics bodies at a single point, allowing them to freely rotate.PinJoint3DA physics joint that attaches two 3D physics bodies at a single point, allowing them to freely rotate.PlaceholderCubemapA without image data.PlaceholderCubemapArrayA without image data.PlaceholderMaterialPlaceholder class for a material.PlaceholderMeshPlaceholder class for a mesh.PlaceholderTexture2DPlaceholder class for a 2-dimensional texture.PlaceholderTexture2DArrayPlaceholder class for a 2-dimensional texture array.PlaceholderTexture3DPlaceholder class for a 3-dimensional texture.PlaceholderTextureLayeredPlaceholder class for a 2-dimensional texture array.PlaneA plane in Hessian normal form.PlaneMeshClass representing a planar .PointLight2DPositional 2D light source.PointMeshMesh with a single point primitive.Polygon2DA 2D polygon.PolygonOccluder3DFlat 2D polygon shape for use with occlusion culling in .PolygonPathFinderPopupBase class for contextual windows and panels with fixed position.PopupMenuA modal window used to display a list of options.PopupPanelA popup with a panel background.PortableCompressedTexture2DProvides a compressed texture for disk and/or VRAM in a way that is portable.PrimitiveMeshBase class for all primitive meshes.PrismMeshClass representing a prism-shaped .ProceduralSkyMaterialA material that defines a simple sky for a resource.ProgressBarA control used for visual representation of a percentage.ProjectionA 4×4 matrix for 3D projective transformations.ProjectSettingsStores globally-accessible variables.PropertyTweenerInterpolates an 's property over time.
Q
QuadMeshClass representing a square mesh facing the camera.QuadOccluder3DFlat plane shape for use with occlusion culling in .QuaternionA unit quaternion used for representing 3D rotations.
R
RandomNumberGeneratorProvides methods for generating pseudo-random numbers.RangeAbstract base class for controls that represent a number within a range.RayCast2DA ray in 2D space, used to find the first collision object it intersects.RayCast3DA ray in 3D space, used to find the first collision object it intersects.RDAttachmentFormatAttachment format (used by ).RDFramebufferPassFramebuffer pass attachment description (used by ).RDPipelineColorBlendStatePipeline color blend state (used by ).RDPipelineColorBlendStateAttachmentPipeline color blend state attachment (used by ).RDPipelineDepthStencilStatePipeline depth/stencil state (used by ).RDPipelineMultisampleStatePipeline multisample state (used by ).RDPipelineRasterizationStatePipeline rasterization state (used by ).RDPipelineSpecializationConstantPipeline specialization constant (used by ).RDSamplerStateSampler state (used by ).RDShaderFileCompiled shader file in SPIR-V form (used by ).RDShaderSourceShader source code (used by ).RDShaderSPIRVSPIR-V intermediate representation as part of an (used by ).RDTextureFormatTexture format (used by ).RDTextureViewTexture view (used by ).RDUniformShader uniform (used by ).RDVertexAttributeVertex attribute (used by ).Rect2A 2D axis-aligned bounding box using floating-point coordinates.Rect2iA 2D axis-aligned bounding box using integer coordinates.RectangleShape2DA 2D rectangle shape used for physics collision.RefCountedBase class for reference-counted objects.ReferenceRectA rectangular box for designing UIs.ReflectionProbeCaptures its surroundings to create fast, accurate reflections from a given point.RegExClass for searching text for patterns using regular expressions.RegExMatchContains the results of a search.RemoteTransform2DRemoteTransform2D pushes its own to another derived node in the scene.RemoteTransform3DRemoteTransform3D pushes its own to another derived Node in the scene.RenderDataAbstract render data object, holds frame data related to rendering a single frame of a viewport.RenderDataExtensionThis class allows for a RenderData implementation to be made in GDExtension.RenderDataRDRender data implementation for the RenderingDevice based renderers.RenderingDeviceAbstraction for working with modern low-level graphics APIs.RenderingServerServer for anything visible.RenderSceneBuffersAbstract scene buffers object, created for each viewport for which 3D rendering is done.RenderSceneBuffersConfigurationConfiguration object used to setup a object.RenderSceneBuffersExtensionThis class allows for a RenderSceneBuffer implementation to be made in GDExtension.RenderSceneBuffersRDRender scene buffer implementation for the RenderingDevice based renderers.RenderSceneDataAbstract render data object, holds scene data related to rendering a single frame of a viewport.RenderSceneDataExtensionThis class allows for a RenderSceneData implementation to be made in GDExtension.RenderSceneDataRDRender scene data implementation for the RenderingDevice based renderers.ResourceBase class for serializable objects.ResourceFormatLoaderLoads a specific resource type from a file.ResourceFormatSaverSaves a specific resource type to a file.ResourceImporterBase class for resource importers.ResourceImporterAnimatedTextureImports an animated image for use in 2D rendering.ResourceImporterBitMapImports a resource (2D array of boolean values).ResourceImporterBMFontImports a bitmap font in the BMFont (.fnt) format.ResourceImporterCSVTranslationImports comma-separated valuesResourceImporterDynamicFontImports a TTF, TTC, OTF, OTC, WOFF or WOFF2 font file for font rendering that adapts to any size.ResourceImporterImageImports an image for use in scripting, with no rendering capabilities.ResourceImporterImageFontImports a bitmap font where all glyphs have the same width and height.ResourceImporterImageFramesImports an image sequence for use in scripting, with no rendering capabilities.ResourceImporterLayeredTextureImports a 3-dimensional texture (), a , a or a .ResourceImporterMP3Imports an MP3 audio file for playback.ResourceImporterOBJImports an OBJ 3D model as an independent or scene.ResourceImporterOggVorbisImports an Ogg Vorbis audio file for playback.ResourceImporterSceneImports a glTF, FBX, COLLADA, or Blender 3D scene.ResourceImporterShaderFileImports native GLSL shaders (not Godot Shaders) as an .ResourceImporterSpriteFramesResourceImporterSVGImports an SVG file as an automatically scalable texture for use in UI elements and 2D rendering.ResourceImporterTextureImports an image for use in 2D or 3D rendering.ResourceImporterTextureAtlasImports a collection of textures from a PNG image into an optimized for 2D rendering.ResourceImporterWAVImports a WAV audio file for playback.ResourceLoaderA singleton for loading resource files.ResourcePreloaderA node used to preload sub-resources inside a scene.ResourceSaverA singleton for saving s to the filesystem.ResourceUIDA singleton that manages the unique identifiers of all resources within a project.RetargetModifier3DA modifier to transfer parent skeleton poses (or global poses) to child skeletons in model space with different rests.RibbonTrailMeshRepresents a straight ribbon-shaped with variable width.RichTextEffectA custom effect for a .RichTextLabelA control for displaying text that can contain different font styles, images, and basic formatting.RIDA handle for a 's unique identifier.RigidBody2DA 2D physics body that is moved by a physics simulation.RigidBody3DA 3D physics body that is moved by a physics simulation.RootMotionViewEditor-only helper for setting up root motion in .
S
SceneMultiplayerHigh-level multiplayer API implementation.SceneReplicationConfigConfiguration for properties to synchronize with a .SceneStateProvides access to a scene file's information.SceneTreeManages the game loop via a hierarchy of nodes.SceneTreeTimerOne-shot timer.ScriptA class stored as a resource.ScriptBacktraceA captured backtrace of a specific script language.ScriptCreateDialogRedot editor's popup dialog for creating new files.ScriptEditorRedot editor's script editor.ScriptEditorBaseBase editor for editing scripts in the .ScriptExtensionScriptLanguageScriptLanguageExtensionScrollBarAbstract base class for scrollbars.ScrollContainerA container used to provide scrollbars to a child control when needed.SegmentShape2DA 2D line segment shape used for physics collision.SemaphoreA synchronization mechanism used to control access to a shared resource by s.SeparationRayShape2DA 2D ray shape used for physics collision that tries to separate itself from any collider.SeparationRayShape3DA 3D ray shape used for physics collision that tries to separate itself from any collider.SeparatorAbstract base class for separators.ShaderA shader implemented in the Redot shading language.ShaderGlobalsOverrideA node used to override global shader parameters' values in a scene.ShaderIncludeA snippet of shader code to be included in a with #include.ShaderIncludeDBInternal database of built in shader include files.ShaderMaterialA material defined by a custom program and the values of its shader parameters.Shape2DAbstract base class for 2D shapes used for physics collision.Shape3DAbstract base class for 3D shapes used for physics collision.ShapeCast2DA 2D shape that sweeps a region of space to detect s.ShapeCast3DA 3D shape that sweeps a region of space to detect s.ShortcutA shortcut for binding input.SignalA built-in type representing a signal of an .Skeleton2DThe parent of a hierarchy of s, used to create a 2D skeletal animation.Skeleton3DA node containing a bone hierarchy, used to create a 3D skeletal animation.SkeletonIK3DA node used to rotate all bones of a bone chain a way that places the end bone at a desired 3D position.SkeletonModification2DBase class for resources that operate on s in a .SkeletonModification2DCCDIKA modification that uses CCDIK to manipulate a series of bones to reach a target in 2D.SkeletonModification2DFABRIKA modification that uses FABRIK to manipulate a series of nodes to reach a target.SkeletonModification2DJiggleA modification that jiggles nodes as they move towards a target.SkeletonModification2DLookAtA modification that rotates a node to look at a target.SkeletonModification2DPhysicalBonesA modification that applies the transforms of nodes to nodes.SkeletonModification2DStackHolderA modification that holds and executes a .SkeletonModification2DTwoBoneIKA modification that rotates two bones using the law of cosines to reach the target.SkeletonModificationStack2DA resource that holds a stack of s.SkeletonModifier3DA node that may modify a Skeleton3D's bones.SkeletonProfileBase class for a profile of a virtual skeleton used as a target for retargeting.SkeletonProfileHumanoidA humanoid preset.SkinSkinReferenceA reference-counted holder object for a skeleton RID used in the .SkyDefines a 3D environment's background by using a .SliderAbstract base class for sliders.SliderJoint3DA physics joint that restricts the movement of a 3D physics body along an axis relative to another physics body.SoftBody3DA deformable 3D physics mesh.SoundSmithPerforms time-stretching and pitch-shifting on raw audio buffers using Soundsmith.SphereMeshClass representing a spherical .SphereOccluder3DSpherical shape for use with occlusion culling in .SphereShape3DA 3D sphere shape used for physics collision.SpinBoxAn input field for numbers.SplineIK3DA for aligning bones along a .SplitContainerA container that splits two child controls horizontally or vertically and provides a grabber for adjusting the split ratio.SpotLight3DA spotlight, such as a reflector spotlight or a lantern.SpringArm3DA 3D raycast that dynamically moves its children near the collision point.SpringBoneCollision3DA base class of the collision that interacts with .SpringBoneCollisionCapsule3DA capsule shape collision that interacts with .SpringBoneCollisionPlane3DAn infinite plane collision that interacts with .SpringBoneCollisionSphere3DA sphere shape collision that interacts with .SpringBoneSimulator3DA to apply inertial wavering to bone chains.Sprite2DGeneral-purpose sprite node.Sprite3D2D sprite node in a 3D world.SpriteBase3D2D sprite node in 3D environment.SpriteFramesSprite frame library for AnimatedSprite2D and AnimatedSprite3D.StandardMaterial3DA PBR (Physically Based Rendering) material to be used on 3D objects.StaticBody2DA 2D physics body that can't be moved by external forces.StaticBody3DA 3D physics body that can't be moved by external forces.StatusIndicatorApplication status indicator (aka notification area icon).StreamPeerAbstract base class for interacting with streams.StreamPeerBufferA stream peer used to handle binary data streams.StreamPeerExtensionStreamPeerGZIPA stream peer that handles GZIP and deflate compression/decompression.StreamPeerTCPA stream peer that handles TCP connections.StreamPeerTLSA stream peer that handles TLS connections.StringA built-in type for strings.StringNameA built-in type for unique strings.StyleBoxAbstract base class for defining stylized boxes for UI elements.StyleBoxEmptyAn empty (does not display anything).StyleBoxFlatA customizable that doesn't use a texture.StyleBoxLineA that displays a single line of a given color and thickness.StyleBoxTextureA texture-based nine-patch .SubtweenTweenerRuns a nested within another .SubViewportAn interface to a game world that doesn't create a window or draw to the screen directly.SubViewportContainerA container used for displaying the contents of a .SurfaceToolHelper tool to create geometry.SyntaxHighlighterBase class for syntax highlighters.SystemFontA font loaded from a system font.
T
TabBarA control that provides a horizontal bar with tabs.TabContainerA container that creates a tab for each child control, displaying only the active tab's control.TCPServerA TCP server.TextEditA multiline text editor.TextLineHolds a line of text.TextMeshGenerate a from the text.TextParagraphHolds a paragraph of text.TextServerA server interface for font management and text rendering.TextServerAdvancedAn advanced text server with support for BiDi, complex text layout, and contextual OpenType features.TextServerDummyA dummy text server that can't render text or manage fonts.TextServerExtensionBase class for custom implementations (plugins).TextServerFallbackA fallback implementation of Redot's text server, without support for BiDi and complex text layout.TextServerManagerA singleton for managing implementations.TextureBase class for all texture types.Texture2DTexture for 2D and 3D.Texture2DArrayA single texture resource which consists of multiple, separate images.Texture2DArrayRDTexture Array for 2D that is bound to a texture created on the .Texture2DRDTexture for 2D that is bound to a texture created on the .Texture3DBase class for 3-dimensional textures.Texture3DRDTexture for 3D that is bound to a texture created on the .TextureButtonTexture-based button.TextureCubemapArrayRDTexture Array for Cubemaps that is bound to a texture created on the .TextureCubemapRDTexture for Cubemap that is bound to a texture created on the .TextureLayeredBase class for texture types which contain the data of multiple s.TextureLayeredRDAbstract base class for layered texture RD types.TextureProgressBarTexture-based progress bar.TextureRectA control that displays a texture.ThemeA resource used for styling/skinning s and s.ThemeDBA singleton that provides access to static information about resources used by the engine and by your project.ThreadA unit of execution in a process.TileDataSettings for a single tile in a .TileMapNode for 2D tile-based maps.TileMapLayerNode for 2D tile-based maps.TileMapPatternHolds a pattern to be copied from or pasted into s.TileSetTile library for tilemaps.TileSetAtlasSourceExposes a 2D atlas texture as a set of tiles for a resource.TileSetScenesCollectionSourceExposes a set of scenes as tiles for a resource.TileSetSourceExposes a set of tiles for a resource.TimeA singleton for working with time data.TimerA countdown timer.TLSOptionsTLS configuration for clients and servers.TorusMeshClass representing a torus .TouchScreenButtonButton for touch screen devices for gameplay use.Transform2DA 2×3 matrix representing a 2D transformation.Transform3DA 3×4 matrix representing a 3D transformation.TranslationA language translation that maps a collection of strings to their individual translations.TranslationDomainA self-contained collection of resources.TranslationServerThe server responsible for language translations.TreeA control used to show a set of internal s in a hierarchical structure.TreeItemAn internal control for a single item inside .TriangleMeshTriangle geometry for efficient, physicsless intersection queries.TubeTrailMeshRepresents a straight tube-shaped with variable width.TweenLightweight object used for general-purpose animation via script, using s.TweenerAbstract class for all Tweeners used by .TwoBoneIK3DRotation based intersection of two circles inverse kinematics solver.
U
UDPServerHelper class to implement a UDP server.UndoRedoProvides a high-level interface for implementing undo and redo operations.UniformSetCacheRDUniform set cache manager for Rendering Device based renderers.UPNPUniversal Plug and Play (UPnP) functions for network device discovery, querying and port forwarding.UPNPDeviceUniversal Plug and Play (UPnP) device.
V
VariantThe most important data type in Redot.VBoxContainerA container that arranges its child controls vertically.Vector2A 2D vector using floating-point coordinates.Vector2iA 2D vector using integer coordinates.Vector3A 3D vector using floating-point coordinates.Vector3iA 3D vector using integer coordinates.Vector4A 4D vector using floating-point coordinates.Vector4iA 4D vector using integer coordinates.VehicleBody3DA 3D physics body that simulates the behavior of a car.VehicleWheel3DA 3D physics body for a that simulates the behavior of a wheel.VFlowContainerA container that arranges its child controls vertically and wraps them around at the borders.VideoStreamBase resource for video streams.VideoStreamPlaybackInternal class used by to manage playback state when played from a .VideoStreamPlayerA control used for video playback.VideoStreamTheoraresource for Ogg Theora videos.ViewportAbstract base class for viewports.ViewportTextureProvides the content of a as a dynamic texture.VisibleOnScreenEnabler2DA rectangular region of 2D space that, when visible on screen, enables a target node.VisibleOnScreenEnabler3DA box-shaped region of 3D space that, when visible on screen, enables a target node.VisibleOnScreenNotifier2DA rectangular region of 2D space that detects whether it is visible on screen.VisibleOnScreenNotifier3DA box-shaped region of 3D space that detects whether it is visible on screen.VisualInstance3DParent of all visual 3D nodes.VisualShaderA custom shader program with a visual editor.VisualShaderNodeBase class for nodes.VisualShaderNodeBillboardA node that controls how the object faces the camera to be used within the visual shader graph.VisualShaderNodeBooleanConstantA boolean constant to be used within the visual shader graph.VisualShaderNodeBooleanParameterA boolean parameter to be used within the visual shader graph.VisualShaderNodeClampClamps a value within the visual shader graph.VisualShaderNodeColorConstantA constant to be used within the visual shader graph.VisualShaderNodeColorFuncA function to be used within the visual shader graph.VisualShaderNodeColorOpA operator to be used within the visual shader graph.VisualShaderNodeColorParameterA parameter to be used within the visual shader graph.VisualShaderNodeCommentOnly exists for compatibility.VisualShaderNodeCompareA comparison function for common types within the visual shader graph.VisualShaderNodeConstantA base type for the constants within the visual shader graph.VisualShaderNodeCubemapA sampling node to be used within the visual shader graph.VisualShaderNodeCubemapParameterA parameter node to be used within the visual shader graph.VisualShaderNodeCurveTexturePerforms a lookup within the visual shader graph.VisualShaderNodeCurveXYZTexturePerforms a lookup within the visual shader graph.VisualShaderNodeCustomVirtual class to define custom s for use in the Visual Shader Editor.VisualShaderNodeDerivativeFuncCalculates a derivative within the visual shader graph.VisualShaderNodeDeterminantCalculates the determinant of a within the visual shader graph.VisualShaderNodeDistanceFadeA visual shader node representing distance fade effect.VisualShaderNodeDotProductCalculates a dot product of two vectors within the visual shader graph.VisualShaderNodeExpressionA custom visual shader graph expression written in Redot Shading Language.VisualShaderNodeFaceForwardReturns the vector that points in the same direction as a reference vector within the visual shader graph.VisualShaderNodeFloatConstantA scalar floating-point constant to be used within the visual shader graph.VisualShaderNodeFloatFuncA scalar floating-point function to be used within the visual shader graph.VisualShaderNodeFloatOpA floating-point scalar operator to be used within the visual shader graph.VisualShaderNodeFloatParameterA scalar float parameter to be used within the visual shader graph.VisualShaderNodeFrameA frame other visual shader nodes can be attached to for better organization.VisualShaderNodeFresnelA Fresnel effect to be used within the visual shader graph.VisualShaderNodeGlobalExpressionA custom global visual shader graph expression written in Redot Shading Language.VisualShaderNodeGroupBaseBase class for a family of nodes with variable number of input and output ports within the visual shader graph.VisualShaderNodeIfOutputs a 3D vector based on the result of a floating-point comparison within the visual shader graph.VisualShaderNodeInputRepresents the input shader parameter within the visual shader graph.VisualShaderNodeIntConstantA scalar integer constant to be used within the visual shader graph.VisualShaderNodeIntFuncA scalar integer function to be used within the visual shader graph.VisualShaderNodeIntOpAn integer scalar operator to be used within the visual shader graph.VisualShaderNodeIntParameterA visual shader node for shader parameter (uniform) of type .VisualShaderNodeIsA boolean comparison operator to be used within the visual shader graph.VisualShaderNodeLinearSceneDepthA visual shader node that returns the depth value of the DEPTH_TEXTURE node in a linear space.VisualShaderNodeMixLinearly interpolates between two values within the visual shader graph.VisualShaderNodeMultiplyAddPerforms a fused multiply-add operation within the visual shader graph.VisualShaderNodeOuterProductCalculates an outer product of two vectors within the visual shader graph.VisualShaderNodeOutputRepresents the output shader parameters within the visual shader graph.VisualShaderNodeParameterA base type for the parameters within the visual shader graph.VisualShaderNodeParameterRefA reference to an existing .VisualShaderNodeParticleAcceleratorA visual shader node that accelerates particles.VisualShaderNodeParticleBoxEmitterA visual shader node that makes particles emitted in a box shape.VisualShaderNodeParticleConeVelocityA visual shader node that makes particles move in a cone shape.VisualShaderNodeParticleEmitA visual shader node that forces to emit a particle from a sub-emitter.VisualShaderNodeParticleEmitterA base class for particle emitters.VisualShaderNodeParticleMeshEmitterA visual shader node that makes particles emitted in a shape defined by a .VisualShaderNodeParticleMultiplyByAxisAngleA visual shader helper node for multiplying position and rotation of particles.VisualShaderNodeParticleOutputVisual shader node that defines output values for particle emitting.VisualShaderNodeParticleRandomnessVisual shader node for randomizing particle values.VisualShaderNodeParticleRingEmitterA visual shader node that makes particles emitted in a ring shape.VisualShaderNodeParticleSphereEmitterA visual shader node that makes particles emitted in a sphere shape.VisualShaderNodeProximityFadeA visual shader node representing proximity fade effect.VisualShaderNodeRandomRangeA visual shader node that generates a pseudo-random scalar.VisualShaderNodeRemapA visual shader node for remap function.VisualShaderNodeRerouteA node that allows rerouting a connection within the visual shader graph.VisualShaderNodeResizableBaseBase class for resizable nodes in a visual shader graph.VisualShaderNodeRotationByAxisA visual shader node that modifies the rotation of the object using a rotation matrix.VisualShaderNodeSample3DA base node for nodes which samples 3D textures in the visual shader graph.VisualShaderNodeScreenNormalWorldSpaceA visual shader node that unpacks the screen normal texture in World Space.VisualShaderNodeScreenUVToSDFA function to convert screen UV to an SDF (signed-distance field), to be used within the visual shader graph.VisualShaderNodeSDFRaymarchSDF raymarching algorithm to be used within the visual shader graph.VisualShaderNodeSDFToScreenUVA function to convert an SDF (signed-distance field) to screen UV, to be used within the visual shader graph.VisualShaderNodeSmoothStepCalculates a SmoothStep function within the visual shader graph.VisualShaderNodeStepCalculates a Step function within the visual shader graph.VisualShaderNodeSwitchA selector function for use within the visual shader graph.VisualShaderNodeTexturePerforms a 2D texture lookup within the visual shader graph.VisualShaderNodeTexture2DArrayA 2D texture uniform array to be used within the visual shader graph.VisualShaderNodeTexture2DArrayParameterA visual shader node for shader parameter (uniform) of type .VisualShaderNodeTexture2DParameterProvides a 2D texture parameter within the visual shader graph.VisualShaderNodeTexture3DPerforms a 3D texture lookup within the visual shader graph.VisualShaderNodeTexture3DParameterProvides a 3D texture parameter within the visual shader graph.VisualShaderNodeTextureParameterPerforms a uniform texture lookup within the visual shader graph.VisualShaderNodeTextureParameterTriplanarPerforms a uniform texture lookup with triplanar within the visual shader graph.VisualShaderNodeTextureSDFPerforms an SDF (signed-distance field) texture lookup within the visual shader graph.VisualShaderNodeTextureSDFNormalPerforms an SDF (signed-distance field) normal texture lookup within the visual shader graph.VisualShaderNodeTransformComposeComposes a from four s within the visual shader graph.VisualShaderNodeTransformConstantA constant for use within the visual shader graph.VisualShaderNodeTransformDecomposeDecomposes a into four s within the visual shader graph.VisualShaderNodeTransformFuncComputes a function within the visual shader graph.VisualShaderNodeTransformOpA operator to be used within the visual shader graph.VisualShaderNodeTransformParameterA parameter for use within the visual shader graph.VisualShaderNodeTransformVecMultMultiplies a and a within the visual shader graph.VisualShaderNodeUIntConstantAn unsigned scalar integer constant to be used within the visual shader graph.VisualShaderNodeUIntFuncAn unsigned scalar integer function to be used within the visual shader graph.VisualShaderNodeUIntOpAn unsigned integer scalar operator to be used within the visual shader graph.VisualShaderNodeUIntParameterA visual shader node for shader parameter (uniform) of type unsigned .VisualShaderNodeUVFuncContains functions to modify texture coordinates (uv) to be used within the visual shader graph.VisualShaderNodeUVPolarCoordA visual shader node that modifies the texture UV using polar coordinates.VisualShaderNodeVaryingA visual shader node that represents a "varying" shader value.VisualShaderNodeVaryingGetterA visual shader node that gets a value of a varying.VisualShaderNodeVaryingSetterA visual shader node that sets a value of a varying.VisualShaderNodeVec2ConstantA constant to be used within the visual shader graph.VisualShaderNodeVec2ParameterA parameter to be used within the visual shader graph.VisualShaderNodeVec3ConstantA constant to be used within the visual shader graph.VisualShaderNodeVec3ParameterA parameter to be used within the visual shader graph.VisualShaderNodeVec4ConstantA 4D vector constant to be used within the visual shader graph.VisualShaderNodeVec4ParameterA 4D vector parameter to be used within the visual shader graph.VisualShaderNodeVectorBaseA base type for the nodes that perform vector operations within the visual shader graph.VisualShaderNodeVectorComposeComposes a , or 4D vector (represented as a ) from scalars within the visual shader graph.VisualShaderNodeVectorDecomposeDecomposes a , or 4D vector (represented as a ) into scalars within the visual shader graph.VisualShaderNodeVectorDistanceReturns the distance between two points.VisualShaderNodeVectorFuncA vector function to be used within the visual shader graph.VisualShaderNodeVectorLenReturns the length of a within the visual shader graph.VisualShaderNodeVectorOpA vector operator to be used within the visual shader graph.VisualShaderNodeVectorRefractReturns the vector that points in the direction of refraction.VisualShaderNodeWorldPositionFromDepthA visual shader node that calculates the position of the pixel in world space using the depth texture.VoxelGIReal-time global illumination (GI) probe.VoxelGIDataContains baked voxel global illumination data for use in a node.VScrollBarA vertical scrollbar that goes from top (min) to bottom (max).VSeparatorA vertical line used for separating other controls.VSliderA vertical slider that goes from bottom (min) to top (max).VSplitContainerA container that splits two child controls vertically and provides a grabber for adjusting the split ratio.
W
WeakRefHolds an .WebRTCDataChannelWebRTCDataChannelExtensionWebRTCMultiplayerPeerA simple interface to create a peer-to-peer mesh network composed of that is compatible with the .WebRTCPeerConnectionInterface to a WebRTC peer connection.WebRTCPeerConnectionExtensionWebSocketMultiplayerPeerBase class for WebSocket server and client.WebSocketPeerA WebSocket connection.WebXRInterfaceXR interface using WebXR.WindowBase class for all windows, dialogs, and popups.WorkerThreadPoolA singleton that allocates some s on startup, used to offload tasks to these threads.World2DA resource that holds all components of a 2D world, such as a canvas and a physics space.World3DA resource that holds all components of a 3D world, such as a visual scenario and a physics space.WorldBoundaryShape2DA 2D world boundary (half-plane) shape used for physics collision.WorldBoundaryShape3DA 3D world boundary (half-space) shape used for physics collision.WorldEnvironmentDefault environment properties for the entire scene (post-processing effects, lighting and background settings).
X
X509CertificateAn X509 certificate (e.g.XMLParserProvides a low-level interface for creating parsers for XML files.XRAnchor3DAn anchor point in AR space.XRBodyModifier3DA node for driving body meshes from data.XRBodyTrackerA tracked body in XR.XRCamera3DA camera node with a few overrules for AR/VR applied, such as location tracking.XRController3DA 3D node representing a spatially-tracked controller.XRControllerTrackerA tracked controller.XRFaceModifier3DA node for driving standard face meshes from weights.XRFaceTrackerA tracked face.XRHandModifier3DA node for driving hand meshes from data.XRHandTrackerA tracked hand in XR.XRInterfaceBase class for an XR interface implementation.XRInterfaceExtensionBase class for XR interface extensions (plugins).XRNode3DA 3D node that has its position automatically updated by the .XROrigin3DThe origin point in AR/VR.XRPoseThis object contains all data related to a pose on a tracked object.XRPositionalTrackerA tracked object.XRServerServer for AR and VR features.XRTrackerA tracked object.XRVRSHelper class for XR interfaces that generates VRS images.