godot

Modules

acceptdialog
module godot.acceptdialog

Base dialog for user notification.

animatedsprite
module godot.animatedsprite

Sprite node that can use multiple textures for animation.

animatedsprite3d
module godot.animatedsprite3d

2D sprite node in 3D world, that can use multiple 2D textures for animation.

animatedtexture
module godot.animatedtexture
animation
module godot.animation

Contains data used to animate everything in the engine.

animationnode
module godot.animationnode
animationnodeadd2
module godot.animationnodeadd2
animationnodeadd3
module godot.animationnodeadd3
animationnodeanimation
module godot.animationnodeanimation
animationnodeblend2
module godot.animationnodeblend2
animationnodeblend3
module godot.animationnodeblend3
animationnodeblendspace1d
module godot.animationnodeblendspace1d
animationnodeblendspace2d
module godot.animationnodeblendspace2d
animationnodeblendtree
module godot.animationnodeblendtree
animationnodeoneshot
module godot.animationnodeoneshot
animationnodeoutput
module godot.animationnodeoutput
animationnodestatemachine
module godot.animationnodestatemachine
animationnodestatemachineplayback
module godot.animationnodestatemachineplayback
animationnodestatemachinetransition
module godot.animationnodestatemachinetransition
animationnodetimescale
module godot.animationnodetimescale
animationnodetimeseek
module godot.animationnodetimeseek
animationnodetransition
module godot.animationnodetransition
animationplayer
module godot.animationplayer

Container and player of Animation resources.

animationrootnode
module godot.animationrootnode
animationtrackeditplugin
module godot.animationtrackeditplugin
animationtree
module godot.animationtree
animationtreeplayer
module godot.animationtreeplayer

Animation Player that uses a node graph for blending Animations.

area
module godot.area

General purpose area node for detection and 3D physics influence.

area2d
module godot.area2d

2D area for detection and 2D physics influence.

arraymesh
module godot.arraymesh
arvranchor
module godot.arvranchor

Anchor point in AR Space.

arvrcamera
module godot.arvrcamera

A camera node with a few overrules for AR/VR applied such as location tracking.

arvrcontroller
module godot.arvrcontroller

A spatial node representing a spatially tracked controller.

arvrinterface
module godot.arvrinterface

Base class for ARVR interface implementation.

arvrinterfacegdnative
module godot.arvrinterfacegdnative

GDNative wrapper for an ARVR interface

arvrorigin
module godot.arvrorigin

Our origin point in AR/VR.

arvrpositionaltracker
module godot.arvrpositionaltracker

A tracked object

arvrserver
module godot.arvrserver

This is our AR/VR Server.

astar
module godot.astar

AStar class representation that uses vectors as edges.

atlastexture
module godot.atlastexture

Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.

audiobuslayout
module godot.audiobuslayout

Stores information about the audiobusses.

audioeffect
module godot.audioeffect

Audio Effect For Audio.

audioeffectamplify
module godot.audioeffectamplify

Adds a Amplify audio effect to an Audio bus. Increases or decreases the volume of the selected audio bus.

audioeffectbandlimitfilter
module godot.audioeffectbandlimitfilter

Adds a band limit filter to the Audio Bus.

audioeffectbandpassfilter
module godot.audioeffectbandpassfilter

Adds a band pass filter to the Audio Bus.

audioeffectchorus
module godot.audioeffectchorus

Adds a chorus audio effect.

audioeffectcompressor
module godot.audioeffectcompressor

Adds a Compressor audio effect to an Audio bus. Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume.

audioeffectdelay
module godot.audioeffectdelay

Adds a Delay audio effect to an Audio bus. Plays input signal back after a period of time. Two tap delay and feedback options.

audioeffectdistortion
module godot.audioeffectdistortion

Adds a Distortion audio effect to an Audio bus. Modify the sound to make it dirty.

audioeffecteq
module godot.audioeffecteq

Base class for audio equalizers. Gives you control over frequencies. Use it to create a custom equalizer if AudioEffectEQ6, AudioEffectEQ10 or AudioEffectEQ21 don't fit your needs.

audioeffecteq10
module godot.audioeffecteq10

Adds a 10-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 31 Hz to 16000 Hz. Each frequency can be modulated between -60/+24 dB.

audioeffecteq21
module godot.audioeffecteq21

Adds a 21-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 22 Hz to 22000 Hz. Each frequency can be modulated between -60/+24 dB.

audioeffecteq6
module godot.audioeffecteq6

Adds a 6-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 32 Hz to 10000 Hz. Each frequency can be modulated between -60/+24 dB.

audioeffectfilter
module godot.audioeffectfilter

Adds a filter to the Audio Bus.

audioeffecthighpassfilter
module godot.audioeffecthighpassfilter

Adds a high pass filter to the Audio Bus.

audioeffecthighshelffilter
module godot.audioeffecthighshelffilter
audioeffectlimiter
module godot.audioeffectlimiter

Adds a soft clip Limiter audio effect to an Audio bus.

audioeffectlowpassfilter
module godot.audioeffectlowpassfilter

Adds a low pass filter to the Audio Bus.

audioeffectlowshelffilter
module godot.audioeffectlowshelffilter
audioeffectnotchfilter
module godot.audioeffectnotchfilter

Adds a notch filter to the Audio Bus.

audioeffectpanner
module godot.audioeffectpanner

Adds a Panner audio effect to an Audio bus. Pans sound left or right.

audioeffectphaser
module godot.audioeffectphaser

Adds a Phaser audio effect to an Audio bus. Combines the original signal with a copy that is slightly out of phase with the original.

audioeffectpitchshift
module godot.audioeffectpitchshift

Adds a Pitch shift audio effect to an Audio bus. Raises or lowers the pitch of original sound.

audioeffectrecord
module godot.audioeffectrecord
audioeffectreverb
module godot.audioeffectreverb

Adds a Reverb audio effect to an Audio bus. Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.

audioeffectstereoenhance
module godot.audioeffectstereoenhance
audioserver
module godot.audioserver

Server interface for low level audio access.

audiostream
module godot.audiostream

Base class for audio streams.

audiostreammicrophone
module godot.audiostreammicrophone
audiostreamoggvorbis
module godot.audiostreamoggvorbis

OGG Vorbis audio stream driver.

audiostreamplayback
module godot.audiostreamplayback

Meta class for playing back audio.

audiostreamplayer
module godot.audiostreamplayer

Plays back audio.

audiostreamplayer2d
module godot.audiostreamplayer2d

Plays audio in 2D.

audiostreamplayer3d
module godot.audiostreamplayer3d

Plays 3D sound in 3D space.

audiostreamrandompitch
module godot.audiostreamrandompitch

Plays audio with random pitch tweaking.

audiostreamsample
module godot.audiostreamsample

Plays audio.

backbuffercopy
module godot.backbuffercopy

Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with SCREEN_TEXTURE in the texture() function.

bakedlightmap
module godot.bakedlightmap

Prerendered indirect light map for a scene.

bakedlightmapdata
module godot.bakedlightmapdata
basebutton
module godot.basebutton

Base class for different kinds of buttons.

bitmap
module godot.bitmap

Boolean matrix.

bitmapfont
module godot.bitmapfont

Renders text using *.fnt fonts.

bone2d
module godot.bone2d
boneattachment
module godot.boneattachment

A node that will attach to a bone.

boxcontainer
module godot.boxcontainer

Base class for box containers.

boxshape
module godot.boxshape

Box shape resource.

bulletphysicsdirectbodystate
module godot.bulletphysicsdirectbodystate
bulletphysicsserver
module godot.bulletphysicsserver
button
module godot.button

Standard themed Button.

buttongroup
module godot.buttongroup

Group of Buttons.

c
module godot.c
camera
module godot.camera

Camera node, displays from a point of view.

camera2d
module godot.camera2d

Camera node for 2D scenes.

canvasitem
module godot.canvasitem

Base class of anything 2D.

canvasitemmaterial
module godot.canvasitemmaterial

A material for CanvasItems.

canvaslayer
module godot.canvaslayer

Canvas drawing layer.

canvasmodulate
module godot.canvasmodulate

Tint the entire canvas.

capsulemesh
module godot.capsulemesh

Class representing a capsule-shaped PrimitiveMesh.

capsuleshape
module godot.capsuleshape

Capsule shape for collisions.

capsuleshape2d
module godot.capsuleshape2d

Capsule shape for 2D collisions.

centercontainer
module godot.centercontainer

Keeps children controls centered.

checkbox
module godot.checkbox

Binary choice user interface widget.

checkbutton
module godot.checkbutton

Checkable button.

circleshape2d
module godot.circleshape2d

Circular shape for 2D collisions.

classdb
module godot.classdb

Class information repository.

clippedcamera
module godot.clippedcamera
collisionobject
module godot.collisionobject

Base node for collision objects.

collisionobject2d
module godot.collisionobject2d

Base node for 2D collision objects.

collisionpolygon
module godot.collisionpolygon

Editor-only class for defining a collision polygon in 3D space.

collisionpolygon2d
module godot.collisionpolygon2d

Defines a 2D collision polygon.

collisionshape
module godot.collisionshape

Node that represents collision shape data in 3D space.

collisionshape2d
module godot.collisionshape2d

Node that represents collision shape data in 2D space.

colorpicker
module godot.colorpicker

Color picker control.

colorpickerbutton
module godot.colorpickerbutton

Button that pops out a ColorPicker.

colorrect
module godot.colorrect

Colored rectangle.

concavepolygonshape
module godot.concavepolygonshape

Concave polygon shape.

concavepolygonshape2d
module godot.concavepolygonshape2d

Concave polygon 2D shape resource for physics.

conetwistjoint
module godot.conetwistjoint

A twist joint between two 3D bodies.

configfile
module godot.configfile

Helper class to handle INI-style files.

confirmationdialog
module godot.confirmationdialog

Dialog for confirmation of actions.

container
module godot.container

Base node for containers.

control
module godot.control

All User Interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent.

convexpolygonshape
module godot.convexpolygonshape

Convex polygon shape for 3D physics.

convexpolygonshape2d
module godot.convexpolygonshape2d

Convex Polygon Shape for 2D physics.

core
module godot.core

Public import for all core types

cpuparticles
module godot.cpuparticles
cpuparticles2d
module godot.cpuparticles2d
csgbox
module godot.csgbox

A CSG Box shape.

csgcombiner
module godot.csgcombiner

A CSG node that allows you to combine other CSG modifiers.

csgcylinder
module godot.csgcylinder

A CSG Cylinder shape.

csgmesh
module godot.csgmesh

A CSG Mesh shape that uses a mesh resource.

csgpolygon
module godot.csgpolygon

Extrudes a 2D polygon shape to create a 3D mesh.

csgprimitive
module godot.csgprimitive

Base class for CSG primitives.

csgshape
module godot.csgshape

The CSG base class.

csgsphere
module godot.csgsphere

A CSG Sphere shape.

csgtorus
module godot.csgtorus

A CSG Torus shape.

cubemap
module godot.cubemap

A CubeMap is a 6 sided 3D texture.

cubemesh
module godot.cubemesh

Generate an axis-aligned cuboid PrimitiveMesh.

curve
module godot.curve

A mathematic curve.

curve2d
module godot.curve2d

Describes a Bezier curve in 2D space.

curve3d
module godot.curve3d

Describes a Bezier curve in 3D space.

curvetexture
module godot.curvetexture

A texture that shows a curve.

cylindermesh
module godot.cylindermesh

Class representing a cylindrical PrimitiveMesh.

cylindershape
module godot.cylindershape

Cylinder shape for collisions.

d
module godot.d

Utilities needed for communication between Godot and D.

dampedspringjoint2d
module godot.dampedspringjoint2d

Damped spring constraint for 2D physics.

directionallight
module godot.directionallight

Directional light from a distance, as from the Sun.

directory
module godot.directory

Type used to handle the filesystem.

docs
module godot.docs
dynamicfont
module godot.dynamicfont

DynamicFont renders vector font files at runtime.

dynamicfontdata
module godot.dynamicfontdata

Used with DynamicFont to describe the location of a font file.

editorexportplugin
module godot.editorexportplugin
editorfiledialog
module godot.editorfiledialog
editorfilesystem
module godot.editorfilesystem

Resource filesystem, as the editor sees it.

editorfilesystemdirectory
module godot.editorfilesystemdirectory

A directory for the resource filesystem.

editorimportplugin
module godot.editorimportplugin

Registers a custom resource importer in the editor. Use the class to parse any file and import it as a new resource type.

editorinspector
module godot.editorinspector
editorinspectorplugin
module godot.editorinspectorplugin
editorinterface
module godot.editorinterface

Godot editor's interface.

editorplugin
module godot.editorplugin

Used by the editor to extend its functionality.

editorproperty
module godot.editorproperty
editorresourceconversionplugin
module godot.editorresourceconversionplugin
editorresourcepreview
module godot.editorresourcepreview

Helper to generate previews of resources or files.

editorresourcepreviewgenerator
module godot.editorresourcepreviewgenerator

Custom generator of previews.

editorsceneimporter
module godot.editorsceneimporter
editorscenepostimport
module godot.editorscenepostimport

Post process scenes after import

editorscript
module godot.editorscript

Base script that can be used to add extension functions to the editor.

editorselection
module godot.editorselection

Manages the SceneTree selection in the editor.

editorsettings
module godot.editorsettings

Object that holds the project-independent editor settings.

editorspatialgizmo
module godot.editorspatialgizmo

Custom gizmo for editing Spatial objects.

encodedobjectasid
module godot.encodedobjectasid
engine
module godot.engine

Access to basic engine properties.

environment
module godot.environment

Resource for environment nodes (like WorldEnvironment) that define multiple rendering options.

expression
module godot.expression
file
module godot.file

Type to handle file reading and writing operations.

filedialog
module godot.filedialog

Dialog for selecting files or directories in the filesystem.

font
module godot.font

Internationalized font and text drawing support.

funcref
module godot.funcref

Reference to a function in an object.

gdnative
module godot.gdnative
gdnativelibrary
module godot.gdnativelibrary
gdscript
module godot.gdscript

A script implemented in the GDScript programming language.

gdscriptfunctionstate
module godot.gdscriptfunctionstate

State of a function call after yielding.

generic6dofjoint
module godot.generic6dofjoint

The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation.

geometry
module godot.geometry
geometryinstance
module godot.geometryinstance

Base node for geometry based visual instances.

giprobe
module godot.giprobe
giprobedata
module godot.giprobedata
globalconstants
module godot.globalconstants
gradient
module godot.gradient

Color interpolator node.

gradienttexture
module godot.gradienttexture

Gradient filled texture.

graphedit
module godot.graphedit

GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them.

graphnode
module godot.graphnode

A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types.

gridcontainer
module godot.gridcontainer

Grid container used to arrange elements in a grid like layout.

gridmap
module godot.gridmap

Node for 3D tile-based maps.

groovejoint2d
module godot.groovejoint2d

Groove constraint for 2D physics.

hboxcontainer
module godot.hboxcontainer

Horizontal box container.

hingejoint
module godot.hingejoint

A hinge between two 3D bodies.

hscrollbar
module godot.hscrollbar

Horizontal scroll bar.

hseparator
module godot.hseparator

Horizontal separator.

hslider
module godot.hslider

Horizontal slider.

hsplitcontainer
module godot.hsplitcontainer

Horizontal split container.

httpclient
module godot.httpclient

Hyper-text transfer protocol client.

httprequest
module godot.httprequest

A node with the ability to send HTTP requests.

image
module godot.image

Image datatype.

imagetexture
module godot.imagetexture

A Texture based on an Image.

immediategeometry
module godot.immediategeometry

Draws simple geometry from code.

input
module godot.input

A Singleton that deals with inputs.

inputdefault
module godot.inputdefault

Default implementation of the Input class.

inputevent
module godot.inputevent

Generic input event

inputeventaction
module godot.inputeventaction

Input event type for actions.

inputeventgesture
module godot.inputeventgesture
inputeventjoypadbutton
module godot.inputeventjoypadbutton

Input event for gamepad buttons.

inputeventjoypadmotion
module godot.inputeventjoypadmotion

Input event type for gamepad joysticks and other motions. For buttons see InputEventJoypadButton.

inputeventkey
module godot.inputeventkey

Input event type for keyboard events.

inputeventmagnifygesture
module godot.inputeventmagnifygesture
inputeventmouse
module godot.inputeventmouse

Base input event type for mouse events.

inputeventmousebutton
module godot.inputeventmousebutton

Input event type for mouse button events.

inputeventmousemotion
module godot.inputeventmousemotion

Input event type for mouse motion events.

inputeventpangesture
module godot.inputeventpangesture
inputeventscreendrag
module godot.inputeventscreendrag

Input event type for screen drag events. (only available on mobile devices)

inputeventscreentouch
module godot.inputeventscreentouch

Input event type for screen touch events. (only available on mobile devices)

inputeventwithmodifiers
module godot.inputeventwithmodifiers

Base class for keys events with modifiers.

inputmap
module godot.inputmap

Singleton that manages InputEventAction.

instanceplaceholder
module godot.instanceplaceholder

Placeholder for the root Node of a PackedScene.

interpolatedcamera
module godot.interpolatedcamera

Camera which moves toward another node.

ip
module godot.ip

Internet protocol (IP) support functions like DNS resolution.

ip_unix
module godot.ip_unix

Unix IP support. See IP.

itemlist
module godot.itemlist

Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns.

javascript
module godot.javascript

Singleton that connects the engine with the browser's JavaScript context in HTML5 export.

joint
module godot.joint

Base class for all 3D joints

joint2d
module godot.joint2d

Base node for all joint constraints in 2D physics.

json
module godot.json

Helper class for parsing JSON data.

jsonparseresult
module godot.jsonparseresult

Data class wrapper for decoded JSON.

kinematicbody
module godot.kinematicbody

Kinematic body 3D node.

kinematicbody2d
module godot.kinematicbody2d

Kinematic body 2D node.

kinematiccollision
module godot.kinematiccollision

Collision data for KinematicBody collisions.

kinematiccollision2d
module godot.kinematiccollision2d

Collision data for KinematicBody2D collisions.

label
module godot.label

Displays plain text in a line or wrapped inside a rectangle. For formatted text, use RichTextLabel.

largetexture
module godot.largetexture

A Texture capable of storing many smaller Textures with offsets.

light
module godot.light

Provides a base class for different kinds of light nodes.

light2d
module godot.light2d

Casts light in a 2D environment.

lightoccluder2d
module godot.lightoccluder2d

Occludes light cast by a Light2D, casting shadows.

line2d
module godot.line2d

A 2D line.

lineedit
module godot.lineedit

Control that provides single line string editing.

lineshape2d
module godot.lineshape2d

Line shape for 2D collisions.

linkbutton
module godot.linkbutton

Simple button used to represent a link to some resource.

listener
module godot.listener
mainloop
module godot.mainloop

Main loop is the abstract main loop base class.

margincontainer
module godot.margincontainer

Simple margin container.

marshalls
module godot.marshalls

Data transformation (marshalling) and encoding helpers.

material
module godot.material

Abstract base Resource for coloring and shading geometry.

menubutton
module godot.menubutton

Special button that brings up a PopupMenu when clicked.

mesh
module godot.mesh

A Resource that contains vertex-array based geometry.

meshdatatool
module godot.meshdatatool

Helper tool to access and edit Mesh data.

meshinstance
module godot.meshinstance

Node that instances meshes into a scenario.

meshinstance2d
module godot.meshinstance2d
meshlibrary
module godot.meshlibrary

Library of meshes.

mobilevrinterface
module godot.mobilevrinterface

Generic mobile VR implementation

multimesh
module godot.multimesh

Provides high performance mesh instancing.

multimeshinstance
module godot.multimeshinstance

Node that instances a MultiMesh.

multiplayerapi
module godot.multiplayerapi

High Level Multiplayer API.

multiplayerpeergdnative
module godot.multiplayerpeergdnative
mutex
module godot.mutex

A synchronization Mutex.

nativescript
module godot.nativescript
navigation
module godot.navigation

Mesh-based navigation and pathfinding node.

navigation2d
module godot.navigation2d

2D navigation and pathfinding node.

navigationmesh
module godot.navigationmesh
navigationmeshinstance
module godot.navigationmeshinstance
navigationpolygon
module godot.navigationpolygon

A node that has methods to draw outlines or use indices of vertices to create navigation polygons.

navigationpolygoninstance
module godot.navigationpolygoninstance
networkedmultiplayerenet
module godot.networkedmultiplayerenet

PacketPeer implementation using the ENet library.

networkedmultiplayerpeer
module godot.networkedmultiplayerpeer

A high-level network interface to simplify multiplayer interactions.

ninepatchrect
module godot.ninepatchrect

Scalable texture-based frame that tiles the texture's centers and sides, but keeps the corners' original size. Perfect for panels and dialog boxes.

node
module godot.node

Base class for all scene objects.

node2d
module godot.node2d

A 2D game object, parent of all 2D related nodes. Has a position, rotation, scale and Z-index.

noisetexture
module godot.noisetexture

OpenSimplexNoise filled texture.

object
module godot.object

Base class for all non built-in types.

occluderpolygon2d
module godot.occluderpolygon2d

Defines a 2D polygon for LightOccluder2D.

omnilight
module godot.omnilight

Omnidirectional light, such as a light bulb or a candle.

opensimplexnoise
module godot.opensimplexnoise

Noise generator based on Open Simplex.

optionbutton
module godot.optionbutton

Button control that provides selectable options when pressed.

orientedpathfollow
module godot.orientedpathfollow

Oriented point sampler for a Path.

os
module godot.os

Operating System functions.

packeddatacontainer
module godot.packeddatacontainer
packeddatacontainerref
module godot.packeddatacontainerref
packedscene
module godot.packedscene

An abstraction of a serialized scene.

packetpeer
module godot.packetpeer

Abstraction and base class for packet-based protocols.

packetpeergdnative
module godot.packetpeergdnative
packetpeerstream
module godot.packetpeerstream

Wrapper to use a PacketPeer over a StreamPeer.

packetpeerudp
module godot.packetpeerudp

UDP packet peer.

panel
module godot.panel

Provides an opaque background for Control children.

panelcontainer
module godot.panelcontainer

Panel container type.

panoramasky
module godot.panoramasky

A type of Sky used to draw a background texture.

parallaxbackground
module godot.parallaxbackground

A node used to create a parallax scrolling background.

parallaxlayer
module godot.parallaxlayer

A parallax scrolling layer to be used with ParallaxBackground.

particles
module godot.particles

3D particle emitter.

particles2d
module godot.particles2d

2D particle emitter.

particlesmaterial
module godot.particlesmaterial

Particle properties for Particles and Particles2D nodes.

path
module godot.path

Container for a Curve3D.

path2d
module godot.path2d

Contains a Curve2D path for PathFollow2D nodes to follow.

pathfollow
module godot.pathfollow

Point sampler for a Path.

pathfollow2d
module godot.pathfollow2d

Point sampler for a Path2D.

pckpacker
module godot.pckpacker
performance
module godot.performance

Exposes performance related data.

phashtranslation
module godot.phashtranslation

Optimized translation.

physicalbone
module godot.physicalbone
physics2ddirectbodystate
module godot.physics2ddirectbodystate

Direct access object to a physics body in the Physics2DServer.

physics2ddirectbodystatesw
module godot.physics2ddirectbodystatesw

Software implementation of Physics2DDirectBodyState.

physics2ddirectspacestate
module godot.physics2ddirectspacestate

Direct access object to a space in the Physics2DServer.

physics2dserver
module godot.physics2dserver

Physics 2D Server.

physics2dserversw
module godot.physics2dserversw

Software implementation of Physics2DServer.

physics2dshapequeryparameters
module godot.physics2dshapequeryparameters

Parameters to be sent to a 2D shape physics query.

physics2dshapequeryresult
module godot.physics2dshapequeryresult
physics2dtestmotionresult
module godot.physics2dtestmotionresult
physicsbody
module godot.physicsbody

Base class for all objects affected by physics in 3D space.

physicsbody2d
module godot.physicsbody2d

Base class for all objects affected by physics in 2D space.

physicsdirectbodystate
module godot.physicsdirectbodystate
physicsdirectspacestate
module godot.physicsdirectspacestate

Direct access object to a space in the PhysicsServer.

physicsmaterial
module godot.physicsmaterial

A material for physics properties.

physicsserver
module godot.physicsserver

Server interface for low level physics access.

physicsshapequeryparameters
module godot.physicsshapequeryparameters
physicsshapequeryresult
module godot.physicsshapequeryresult

Result of a shape query in Physics2DServer.

pinjoint
module godot.pinjoint

Pin Joint for 3D Shapes.

pinjoint2d
module godot.pinjoint2d

Pin Joint for 2D Shapes.

planemesh
module godot.planemesh

Class representing a planar PrimitiveMesh.

planeshape
module godot.planeshape
pluginscript
module godot.pluginscript
polygon2d
module godot.polygon2d

A 2D polygon.

polygonpathfinder
module godot.polygonpathfinder
popup
module godot.popup

Base container control for popups and dialogs.

popupdialog
module godot.popupdialog

Base class for Popup Dialogs.

popupmenu
module godot.popupmenu

PopupMenu displays a list of options.

popuppanel
module godot.popuppanel

Class for displaying popups with a panel background.

position2d
module godot.position2d

Generic 2D Position hint for editing.

position3d
module godot.position3d

Generic 3D Position hint for editing.

primitivemesh
module godot.primitivemesh

Base class for all primitive meshes. Handles applying a Material to a primitive mesh.

prismmesh
module godot.prismmesh

Class representing a prism-shaped PrimitiveMesh.

proceduralsky
module godot.proceduralsky

Type of Sky that is generated procedurally based on user input parameters.

progressbar
module godot.progressbar

General purpose progress bar.

projectsettings
module godot.projectsettings

Contains global variables accessible from everywhere.

proximitygroup
module godot.proximitygroup

General purpose proximity-detection node.

proxytexture
module godot.proxytexture
quadmesh
module godot.quadmesh

Class representing a square mesh.

range
module godot.range

Abstract base class for range-based controls.

raycast
module godot.raycast

Query the closest object intersecting a ray.

raycast2d
module godot.raycast2d

Query the closest object intersecting a ray.

rayshape
module godot.rayshape

Ray shape for 3D collisions.

rayshape2d
module godot.rayshape2d

Ray shape for 2D collisions.

rectangleshape2d
module godot.rectangleshape2d

Rectangle shape for 2D collisions.

reference
module godot.reference

Base class for anything that keeps a reference count.

referencerect
module godot.referencerect

Reference frame for GUI.

reflectionprobe
module godot.reflectionprobe
regex
module godot.regex

Class for searching text for patterns using regular expressions.

regexmatch
module godot.regexmatch

Contains the results of a regex search.

remotetransform
module godot.remotetransform

RemoteTransform pushes its own Transform to another Spatial derived Node in the scene.

remotetransform2d
module godot.remotetransform2d

RemoteTransform2D pushes its own Transform2D to another CanvasItem derived Node in the scene.

resource
module godot.resource

Base class for all resources.

resourceimporter
module godot.resourceimporter
resourceimporteroggvorbis
module godot.resourceimporteroggvorbis
resourceinteractiveloader
module godot.resourceinteractiveloader

Interactive Resource Loader.

resourceloader
module godot.resourceloader

Resource Loader.

resourcepreloader
module godot.resourcepreloader

Resource Preloader Node.

resourcesaver
module godot.resourcesaver

Resource saving interface.

richtextlabel
module godot.richtextlabel

Label that displays rich text.

rigidbody
module godot.rigidbody

Physics Body whose position is determined through physics simulation in 3D space.

rigidbody2d
module godot.rigidbody2d

A body that is controlled by the 2D physics engine.

rootmotionview
module godot.rootmotionview
scenestate
module godot.scenestate

A script interface to a scene file's data.

scenetree
module godot.scenetree

SceneTree manages a hierarchy of nodes.

scenetreetimer
module godot.scenetreetimer
script
module godot.script

A class stored as a resource.

scriptcreatedialog
module godot.scriptcreatedialog

The Editor's popup dialog for creating new Script files.

scripteditor
module godot.scripteditor
scrollbar
module godot.scrollbar

Base class for scroll bars.

scrollcontainer
module godot.scrollcontainer

A helper node for displaying scrollable elements (e.g. lists).

segmentshape2d
module godot.segmentshape2d

Segment shape for 2D collisions.

semaphore
module godot.semaphore

A synchronization Semaphore.

separator
module godot.separator

Base class for separators.

shader
module godot.shader

A custom shader program.

shadermaterial
module godot.shadermaterial

A material that uses a custom Shader program.

shape
module godot.shape

Base class for all 3D shape resources.

shape2d
module godot.shape2d

Base class for all 2D Shapes.

shortcut
module godot.shortcut

A shortcut for binding input.

skeleton
module godot.skeleton

Skeleton for characters and animated objects.

skeleton2d
module godot.skeleton2d
skeletonik
module godot.skeletonik
sky
module godot.sky

The base class for PanoramaSky and ProceduralSky.

slider
module godot.slider

Base class for GUI Sliders.

sliderjoint
module godot.sliderjoint

Piston kind of slider between two bodies in 3D.

softbody
module godot.softbody

A soft mesh physics body.

spatial
module godot.spatial

Most basic 3D game object, parent of all 3D related nodes.

spatialgizmo
module godot.spatialgizmo
spatialmaterial
module godot.spatialmaterial

Default 3D rendering material.

spatialvelocitytracker
module godot.spatialvelocitytracker
spheremesh
module godot.spheremesh

Class representing a spherical PrimitiveMesh.

sphereshape
module godot.sphereshape

Sphere shape for 3D collisions.

spinbox
module godot.spinbox

Numerical input text field.

splitcontainer
module godot.splitcontainer

Container for splitting and adjusting.

spotlight
module godot.spotlight

Spotlight Light, such as a reflector spotlight or a lantern.

springarm
module godot.springarm
sprite
module godot.sprite

General purpose Sprite node.

sprite3d
module godot.sprite3d

2D Sprite node in 3D world.

spritebase3d
module godot.spritebase3d

2D Sprite node in 3D environment.

spriteframes
module godot.spriteframes

Sprite frame library for AnimatedSprite.

staticbody
module godot.staticbody

Static body for 3D Physics.

staticbody2d
module godot.staticbody2d

Static body for 2D Physics.

streampeer
module godot.streampeer

Abstraction and base class for stream-based protocols.

streampeerbuffer
module godot.streampeerbuffer
streampeergdnative
module godot.streampeergdnative
streampeerssl
module godot.streampeerssl

SSL Stream peer.

streampeertcp
module godot.streampeertcp

TCP Stream peer.

streamtexture
module godot.streamtexture

A .stex texture.

stylebox
module godot.stylebox

Base class for drawing stylized boxes for the UI.

styleboxempty
module godot.styleboxempty

Empty stylebox (does not display anything).

styleboxflat
module godot.styleboxflat

Customizable Stylebox with a given set of parameters. (no texture required)

styleboxline
module godot.styleboxline
styleboxtexture
module godot.styleboxtexture

Texture Based 3x3 scale style.

surfacetool
module godot.surfacetool

Helper tool to create geometry.

tabcontainer
module godot.tabcontainer

Tabbed Container.

tabs
module godot.tabs

Tabs Control.

tcp_server
module godot.tcp_server

TCP Server.

textedit
module godot.textedit

Multiline text editing control.

textfile
module godot.textfile
texture
module godot.texture

Texture for 2D and 3D.

texture3d
module godot.texture3d
texturearray
module godot.texturearray
texturebutton
module godot.texturebutton

Texture-based button. Supports Pressed, Hover, Disabled and Focused states.

texturelayered
module godot.texturelayered
textureprogress
module godot.textureprogress

Texture-based progress bar. Useful for loading screens and life or stamina bars.

texturerect
module godot.texturerect

Control for drawing textures.

theme
module godot.theme

Theme for controls.

thread
module godot.thread

A unit of execution in a process.

tilemap
module godot.tilemap

Node for 2D tile-based maps.

tileset
module godot.tileset

Tile library for tilemaps.

timer
module godot.timer

A countdown timer.

toolbutton
module godot.toolbutton

Flat button helper class.

touchscreenbutton
module godot.touchscreenbutton

Button for touch screen devices.

translation
module godot.translation

Language Translation.

translationserver
module godot.translationserver

Server that manages all translations. Translations can be set to it and removed from it.

tree
module godot.tree

Control to show a tree of items.

treeitem
module godot.treeitem

Control for a single item inside a Tree.

trianglemesh
module godot.trianglemesh
tween
module godot.tween

Smoothly animates a node's properties over time.

undoredo
module godot.undoredo

Helper to manage UndoRedo in the editor or custom tools.

upnp
module godot.upnp

UPNP network functions.

upnpdevice
module godot.upnpdevice

UPNP device.

vboxcontainer
module godot.vboxcontainer

Vertical box container.

vehiclebody
module godot.vehiclebody

Physics body that simulates the behaviour of a car.

vehiclewheel
module godot.vehiclewheel

Physics object that simulates the behaviour of a wheel.

videoplayer
module godot.videoplayer

Control for playing video streams.

videostream
module godot.videostream

Base resource for video streams.

videostreamtheora
module godot.videostreamtheora
videostreamwebm
module godot.videostreamwebm
viewport
module godot.viewport

Creates a sub-view into the screen.

viewportcontainer
module godot.viewportcontainer

Control for holding Viewports.

viewporttexture
module godot.viewporttexture

Texture which displays the content of a Viewport.

visibilityenabler
module godot.visibilityenabler

Enable certain nodes only when visible.

visibilityenabler2d
module godot.visibilityenabler2d

Enable certain nodes only when visible.

visibilitynotifier
module godot.visibilitynotifier

Detects when the node is visible on screen.

visibilitynotifier2d
module godot.visibilitynotifier2d

Detects when the node is visible on screen.

visualinstance
module godot.visualinstance
visualscript
module godot.visualscript

A script implemented in the Visual Script programming environment.

visualscriptbasictypeconstant
module godot.visualscriptbasictypeconstant

A Visual Script node representing a constant from the base types.

visualscriptbuiltinfunc
module godot.visualscriptbuiltinfunc

A Visual Script node used to call built-in functions.

visualscriptclassconstant
module godot.visualscriptclassconstant

Gets a constant from a given class.

visualscriptcomment
module godot.visualscriptcomment

A Visual Script node used to annotate the script.

visualscriptcondition
module godot.visualscriptcondition

A Visual Script node which branches the flow.

visualscriptconstant
module godot.visualscriptconstant

Gets a contant's value.

visualscriptconstructor
module godot.visualscriptconstructor

A Visual Script node which calls a base type constructor.

visualscriptcustomnode
module godot.visualscriptcustomnode

A scripted Visual Script node.

visualscriptdeconstruct
module godot.visualscriptdeconstruct

A Visual Script node which deconstructs a base type instance into its parts.

visualscripteditor
module godot.visualscripteditor
visualscriptemitsignal
module godot.visualscriptemitsignal

Emits a specified signal.

visualscriptenginesingleton
module godot.visualscriptenginesingleton

A Visual Script node returning a singleton from @GlobalScope

visualscriptexpression
module godot.visualscriptexpression
visualscriptfunction
module godot.visualscriptfunction
visualscriptfunctioncall
module godot.visualscriptfunctioncall
visualscriptfunctionstate
module godot.visualscriptfunctionstate
visualscriptglobalconstant
module godot.visualscriptglobalconstant
visualscriptindexget
module godot.visualscriptindexget
visualscriptindexset
module godot.visualscriptindexset
visualscriptinputaction
module godot.visualscriptinputaction
visualscriptiterator
module godot.visualscriptiterator

Steps through items in a given input.

visualscriptlocalvar
module godot.visualscriptlocalvar

Gets a local variable's value.

visualscriptlocalvarset
module godot.visualscriptlocalvarset

Changes a local variable's value.

visualscriptmathconstant
module godot.visualscriptmathconstant

Commonly used mathematical constants.

visualscriptnode
module godot.visualscriptnode

A node which is part of a VisualScript.

visualscriptoperator
module godot.visualscriptoperator
visualscriptpreload
module godot.visualscriptpreload

Creates a new Resource or loads one from the filesystem.

visualscriptpropertyget
module godot.visualscriptpropertyget
visualscriptpropertyset
module godot.visualscriptpropertyset
visualscriptresourcepath
module godot.visualscriptresourcepath
visualscriptreturn
module godot.visualscriptreturn

Exits a function and returns an optional value.

visualscriptscenenode
module godot.visualscriptscenenode

Node reference.

visualscriptscenetree
module godot.visualscriptscenetree
visualscriptselect
module godot.visualscriptselect

Chooses between two input values.

visualscriptself
module godot.visualscriptself

Outputs a reference to the current instance.

visualscriptsequence
module godot.visualscriptsequence

Executes a series of Sequence ports.

visualscriptsubcall
module godot.visualscriptsubcall
visualscriptswitch
module godot.visualscriptswitch

Branches program flow based on a given input's value.

visualscripttypecast
module godot.visualscripttypecast
visualscriptvariableget
module godot.visualscriptvariableget

Gets a variable's value.

visualscriptvariableset
module godot.visualscriptvariableset

Changes a variable's value.

visualscriptwhile
module godot.visualscriptwhile

Conditional loop.

visualscriptyield
module godot.visualscriptyield
visualscriptyieldsignal
module godot.visualscriptyieldsignal
visualserver
module godot.visualserver

Server for anything visible.

visualshader
module godot.visualshader
visualshadernode
module godot.visualshadernode
visualshadernodecolorconstant
module godot.visualshadernodecolorconstant
visualshadernodecolorop
module godot.visualshadernodecolorop
visualshadernodecoloruniform
module godot.visualshadernodecoloruniform
visualshadernodecubemap
module godot.visualshadernodecubemap
visualshadernodecubemapuniform
module godot.visualshadernodecubemapuniform
visualshadernodedotproduct
module godot.visualshadernodedotproduct
visualshadernodeinput
module godot.visualshadernodeinput
visualshadernodeoutput
module godot.visualshadernodeoutput
visualshadernodescalarconstant
module godot.visualshadernodescalarconstant
visualshadernodescalarfunc
module godot.visualshadernodescalarfunc
visualshadernodescalarinterp
module godot.visualshadernodescalarinterp
visualshadernodescalarop
module godot.visualshadernodescalarop
visualshadernodescalaruniform
module godot.visualshadernodescalaruniform
visualshadernodetexture
module godot.visualshadernodetexture
visualshadernodetextureuniform
module godot.visualshadernodetextureuniform
visualshadernodetransformcompose
module godot.visualshadernodetransformcompose
visualshadernodetransformconstant
module godot.visualshadernodetransformconstant
visualshadernodetransformdecompose
module godot.visualshadernodetransformdecompose
visualshadernodetransformmult
module godot.visualshadernodetransformmult
visualshadernodetransformuniform
module godot.visualshadernodetransformuniform
visualshadernodetransformvecmult
module godot.visualshadernodetransformvecmult
visualshadernodeuniform
module godot.visualshadernodeuniform
visualshadernodevec3constant
module godot.visualshadernodevec3constant
visualshadernodevec3uniform
module godot.visualshadernodevec3uniform
visualshadernodevectorcompose
module godot.visualshadernodevectorcompose
visualshadernodevectordecompose
module godot.visualshadernodevectordecompose
visualshadernodevectorfunc
module godot.visualshadernodevectorfunc
visualshadernodevectorinterp
module godot.visualshadernodevectorinterp
visualshadernodevectorlen
module godot.visualshadernodevectorlen
visualshadernodevectorop
module godot.visualshadernodevectorop
vscrollbar
module godot.vscrollbar

Vertical version of ScrollBar, which goes from left (min) to right (max).

vseparator
module godot.vseparator

Vertical version of Separator.

vslider
module godot.vslider

Vertical slider.

vsplitcontainer
module godot.vsplitcontainer

Vertical split container.

weakref
module godot.weakref

Holds an GodotObject, but does not contribute to the reference count if the object is a reference.

websocketclient
module godot.websocketclient

A WebSocket client implementation

websocketmultiplayerpeer
module godot.websocketmultiplayerpeer

Base class for WebSocket server and client.

websocketpeer
module godot.websocketpeer

A class representing a specific WebSocket connection.

websocketserver
module godot.websocketserver

A WebSocket server implementation

windowdialog
module godot.windowdialog

Base class for window dialogs.

world
module godot.world

Class that has everything pertaining to a world.

world2d
module godot.world2d

Class that has everything pertaining to a 2D world.

worldenvironment
module godot.worldenvironment

Default environment properties for the entire scene (post-processing effects, lightning and background settings).

xmlparser
module godot.xmlparser

Low-level class for creating parsers for XML files.

ysort
module godot.ysort

Sort all child nodes based on their Y positions.

Public Imports

godot.core
public import godot.core;
Undocumented in source.
godot.d
public import godot.d;
Undocumented in source.

Members

Imports

GDNativeVersion (from godot.c.api)
public import godot.c.api : GDNativeVersion;
Undocumented in source.

Meta