2.1
General
About
Introduction
About Godot Engine
About the documentation
Organisation of the documentation
Frequently asked questions
GDScript? Why your own scripting language? Why not Lua, Javascript, C#, etc.?
I don’t believe you. What are the technical reasons for the item above?
Why is FBX not supported for import?
Will [Insert closed SDK such as PhysX, GameWorks, etc.] be supported in Godot?
How should assets be created to handle multiple resolutions and aspect ratios?
I have a great idea that will make Godot better, What do you think?
Learning
Step by step
Scenes and nodes
Introduction
Nodes
Scenes
Creating a new project
Editor
Configuring the project
To be continued...
Instancing
Rationale
Instancing, step by step
A little more
Editing instances
Conclusion
Instancing (continued)
Recap
Design language
Information overload!
Scripting
Introduction
GDScript
Scripting a scene
Scene setup
Adding a script
The role of the script
Handling a signal
Scripting (continued)
Processing
Groups
Notifications
Overrideable functions
Creating nodes
Instancing scenes
Simple 2D game
Pong
Assets
Scene setup
Input actions setup
Script
GUI tutorial
Introduction
Control
Input and drawing
Custom control mini tutorial
UI complexity
Simplified UI controls
Complex UI controls
Splash screen
Tutorial
Setting up
Animations
Introduction
Creating the animation
Editing the animation
Making the logo appear
Resources
Nodes and resources
External vs built-in
Loading resources from code
Loading scenes
Freeing resources
Scripting
File system
Introduction
Implementation
engine.cfg
Path delimiter
Resource path
User path
Host file system
Drawbacks
SceneTree
Introduction
MainLoop
SceneTree
Root viewport
Scene tree
Tree order
“Becoming active” by entering the
Scene Tree
Changing current scene
Singletons (AutoLoad)
Introduction
AutoLoad
Custom scene switcher
global.gd
Editor manual
2D and 3D keybindings
2D viewport
3D viewport
From Unity3D to Godot Engine
Differences
The editor
The scene system
Project organization
Where are my prefabs?
Glossary correspondance
Scripting : From C# to GDScript
Design
Connections : groups and signals
Using Godot in C++
Command line tutorial
Path
Creating a project
Running the editor
Erasing a scene
Running the game
Debugging
Exporting
Running a script
Engine features
Math
Vector math
Introduction
Coordinate systems (2D)
Vectors in Godot
Perpendicular vectors
Unit vectors
Dot product
Siding with unit vectors
Planes
Area of a triangle
Plane of the triangle
Collision detection in 3D
Matrices and transforms
Introduction
Oriented coordinate system (OCS)
Basis
Transforms in Godot
Matrix32
Identity
Operations
Rotation
Translation
Scale
Transform
Inverse transform
Orthonormal matrices
Affine inverse
Matrix multiplication
Multiplication by inverse
Multiplication by identity
Matrix tips
Matrices & transforms in 3D
Matrix3
Rotation in 3D
Transform
2D
Viewport and canvas transforms
Introduction
Canvas transform
Global canvas transform
Stretch transform
Transform order
Transform functions
Feeding custom input events
Canvas layers
Viewport and Canvas items
Not enough...
CanvasLayers
Performance
Using tilemaps
Introduction
Making a tileset
TileSet scene
Collision
Exporting a TileSet
Using the TileSet in a TileMap
Painting your world
Offset and scaling artifacts
Custom drawing in 2D
Why?
But...
OK, how?
Updating
An example: drawing circular arcs
Tools
Particle Systems (2D)
Intro
Physics variables
Direction
Spread
Linear velocity
Spin velocity
Orbit velocity
Gravity direction & strength
Radial acceleration
Tangential acceleration
Damping
Initial angle
Initial & final size
Color phases
Global parameters
Lifetime
Timescale
Preprocess
Emit timeout
Offset
Half extents
Local space
Explosiveness
Randomness
3D
Introduction to 3D
Spatial node
3D content
Environment
3D viewport
3D performance and limitations
Introduction
Rendering
Importing 3D meshes
Introduction
Importing
Options
Usage
Importing 3D scenes
Introduction
Exporting DAE files
The import process
Materials
Introduction
Flags
Parameters
Fixed materials
Introduction
Options
Fixed flags
Parameters
Textures
High dynamic range
Introduction
Linear color space
Linear color space & asset pipeline
Parameters of HDR
Using gridmaps
Introduction
Creating a MeshLibrary
Collisions
Exporting the MeshLibrary
Using the MeshLibrary in a GridMap
Reminder
GUI
GUI skinning
Oh beautiful GUI!
Theme
Theme options
Customizing a control
Creating a theme
Example: theming a button
Custom GUI controls
So many controls...
Drawing
Sizing
Input
Size and anchors
BBCode in RichTextLabel
Introduction
Setting up
Reference
Physics
Physics introduction
Shapes
When problems begin
Introducing... Godot’s physics engine!
CollisionObject2D
Contact reporting
Physics global variables
Fixed process callback
Casting rays and motion queries
Ray-casting
Introduction
Space
Accessing space
Raycast query
Collision exceptions
3D ray casting from screen
Kinematic Character (2D)
Introduction
Fixed process
Scene setup
Moving the Kinematic character
Problem?
Solution!
Viewports
Viewports
Introduction
Input
Listener
Cameras (2D & 3D)
Scale & stretching
Worlds
Capture
Sub-viewport
Render target
Multiple resolutions
Base resolution
Resizing
Stretch settings
Stretch mode
Stretch aspect
Inputs
InputEvent
What is it?
How does it work?
Anatomy of an InputEvent
Actions
InputMap
Mouse and input coordinates
About
Hardware display coordinates
Viewport display coordinates
Animation
Introduction to the 2D animation features
Overview
Create an AnimationPlayer node
Computer animation relies on keyframes
Tutorial: Creating a simple animation
Keyframes for other properties
Edit keyframes
Advanced: Call Func tracks
References
Cutout animation
What is it?
Cutout in Godot
Making of GBot!
Setting up the rig
Adjusting the pivot
RemoteTransform2D node
Completing the skeleton
Skeletons
IK chains
Animation
Rest pose
Rotation
Keyframing IK
Moving sprites above and behind others.
Batch setting transition curves
Lighting
Lighting
Introduction
Light nodes
Ambient light
Baked light
Shadow mapping
Introduction
Shadows by light type
Shadows parameters
Shading
Shading language
Introduction
Language
Built-in functions
Built-in variables
Examples
Notes
Shader materials
Introduction
Creating a ShaderMaterial
Screen-reading shaders
Introduction
TexScreen shader instruction
TexScreen example
Behind the scenes
Back-buffer logic
Networking
HTTP client class
SSL certificates
Introduction
Approach 1: self signed cert
Approach 2: CA cert
Platform-specific
Android in-app purchases
Getting the product details
Check if user purchased an item
Simple Purchase
Consumables and Non-Consumables
Testing
Services for iOS
Asynchronous methods
Store Kit
Game Center
Multi-platform games
Miscellaneous
Background loading
ResourceInteractiveLoader
Usage
Example
Using multiple threads
Example class
Data paths
Path separators
Resource path
Userdata path (persistent data)
Saving games
Introduction
Identify persistent objects
Serializing
Saving and reading data
Some notes
Encrypting save games
Why?
How?
Handling quit requests
Quitting
Handling the notification
Pausing games
Pause?
How pausing works
White-listing nodes
Example
Internationalizing games
Introduction
Configuring the imported translation
Localizing resources
Converting keys to text
Making controls resizeable
TranslationServer
Command line
Translating the project name
Locales
Binary serialization API
Introduction
Packet specification
Scripting
GDScript
GDScript
Introduction
Language
Built-in types
Data
GDScript more efficiently
About
Dynamic nature
Arrays
Dictionaries
For & while
While
Duck typing
GDScript format strings
Usage in GDScript
Multiple placeholders
Format specifiers
Padding
Escape sequence
Project workflow
Project setup
Project organization
Introduction
Organization
Importing & game folder
Scene organization
Cache files
Assets workflow
Import process
What is it for?
Does it always work?
Importing assets
Managing image files
Image loader
Image loader options
Fixing PNGs iCCP chunk
Importing textures
Do NOT import them in most cases
OK, you
might
want to import them
Lack of MipMaps
Unwanted MipMaps
Blending artifacts
Texture flags
Texture compression
Atlases
Artists use PSD
Texture importer
Importing audio samples
Why importing?
Importing audio samples
Importing fonts
What is a font?
Converting fonts
Importing a font
Internationalization
Importing translations
Games and internationalization
Translation format
Import dialog
Exporting images
Image export options
Image group export options
Export
Exporting projects
Why exporting?
Export dialog
Exporting for PC
Exporting for iOS
Requirements
Add your project data
Loading files from a host
Services for iOS
Exporting for Universal Windows Platform
Limitations on Xbox One
Creating a signing certificate
Signing the package
Installing the package
Exporting for Android
Download the Android SDK
Install OpenJDK or Oracle JDK
Create a debug.keystore
Make sure you have adb
Setting it up in Godot
Exporting for the Web
Serving the files
Export options
Web export limitations
One-click deploy
Sounds good, what is it?
Steps for one-click deploy
Development
Editor plugins
Making Plugins
About Plugins
Creating a plugin
The script file
A custom node
A custom dock
Checking the results
Going beyond
Compiling
Introduction to the buildsystem
Scons
Platform selection
Resulting binary
Tools
Target
Bits
Export templates
Compiling for Windows
Requirements
Setting up SCons
Setting up Pywin32
Installing Visual Studio caveats
Downloading Godot’s source
Compiling
About the Developer/Tools Command Prompts and the Visual C++ compiler
Running SCons
How the prompts actually work
How to run an automated build of Godot
Development in Visual Studio or other IDEs
Cross-compiling for Windows from other operating systems
Creating Windows export templates
Compiling for X11 (Linux, *BSD)
Requirements
Known issues with GCC 6
Distro-specific oneliners
Compiling
Building export templates
Compiling for OSX
Requirements
Compiling
Cross-compiling
Compiling for Android
Note
Requirements
Setting up the buildsystem
Toolchain
Building the export templates
Adding support for x86 devices
Using the export templates
Installing the templates
Troubleshooting
Application not installed
Application exits immediately
Compiling for iOS
Requirements
Compiling
Run
Cross-compiling for iOS on Linux
Disclaimer
Requirements
Configuring the environment
darling-dmg
Preparing the SDK
Toolchain
Compiling Godot for iPhone
Producing fat binaries
Compiling for Universal Windows Platform
Requirements
Compiling
Creating UWP export templates
Running UWP apps with Visual Studio
Compiling for the Web
Requirements
Compiling
Building export templates
Customizing the HTML page
Batch building templates
Packaging Godot
Default behaviour
Global template path (Unix only)
Self contained mode
Developing in C++
Introduction to Godot development
Architecture diagram
Debugging the editor with gdb
Configuring an IDE
Kdevelop
Eclipse
QtCreator
Importing the project
Build and run
Xcode
Project Setup
Scheme Setup
Other editors (vim, emacs, Atom...)
Core types
Definitions
References:
Memory model
Allocating memory
References:
Containers
References:
String
References:
StringName
References:
Math types
References:
NodePath
References:
RID
References:
Variant class
About
References:
Dictionary and Array
References:
Object class
General definition
References:
Registering an Object
References:
Constants
Properties (set/get)
Binding properties using
_set
/
_get
/
_get_property_list
Dynamic casting
Signals
References
References:
Resources:
References:
Resource loading
References:
Resource saving
References:
Inheritance class tree
Object
Reference
Control
Node2D
Spatial
Custom modules in C++
Modules
What for?
Creating a new module
Using the module
Improving the build system for development
Summing up
Creating Android modules
Introduction
Maybe REST?
Android module
config.py
Java singleton
AndroidManifest
Resources
SDK library
SDK project
Building
Using the module
Troubleshooting
Godot crashes upon load
Future
Community
Contributing
Ways to contribute
Contributing code
Testing and reporting issues
Testing development versions
Filing an issue on GitHub
Contributing to the documentation
Pull request workflow
Git source repository
Forking and cloning
Branching
Updating your branch
Making changes
Pushing changes to a remote
Issuing a pull request
Modifying a pull request
Mastering the PR workflow: the rebase
Code style guidelines
C++ and Objective-C
Using clang-format locally
Java
Python
Bug triage guidelines
Issues management
Labels
Milestones
Documentation guidelines
How to contribute
What makes good documentation?
Titles
Translating existing pages
Licence
Updating the class reference
Workflow for updating the class reference
Getting started with GitHub
Fork Godot Engine
Keeping your local clone up-to-date
Updating the documentation template
Push and request a pull of your changes
Editing the doc/base/classes.xml file
Formatting of the XML file
Tags available for improved formatting
I don’t know what this method does!
Tutorials
3D
Mesh generation with heightmap and shaders
Introduction
The heightmap
The plane mesh
Shader magic
Working with 3D skeletons
Skeleton node
Skeleton class
Using 3D “bones” for mesh control
Using 3D “bones” to implement Inverse Kinematics
Using 3D “bones” to implement ragdoll-like physics
Inverse kinematics
Initial problem
Implementation
Class reference
Godot API
@GDScript
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
@Global Scope
Brief Description
Member Variables
Numeric Constants
Description
AABB
Brief Description
Member Functions
Member Variables
Description
Member Function Description
AcceptDialog
Brief Description
Member Functions
Signals
Description
Member Function Description
AnimatedSprite
Brief Description
Member Functions
Signals
Description
Member Function Description
AnimatedSprite3D
Brief Description
Member Functions
Signals
Member Function Description
Animation
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
AnimationPlayer
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
AnimationTreePlayer
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Area
Brief Description
Member Functions
Signals
Description
Member Function Description
Area2D
Brief Description
Member Functions
Signals
Description
Member Function Description
Array
Brief Description
Member Functions
Description
Member Function Description
AStar
Brief Description
Member Functions
Member Function Description
AtlasTexture
Brief Description
Member Functions
Signals
Member Function Description
AudioServer
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
AudioServerSW
Brief Description
Description
AudioStream
Brief Description
Description
AudioStreamMPC
Brief Description
Description
AudioStreamOGGVorbis
Brief Description
Description
AudioStreamOpus
Brief Description
Description
AudioStreamPlayback
Brief Description
Member Functions
Member Function Description
AudioStreamSpeex
Brief Description
Description
BackBufferCopy
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
BakedLight
Brief Description
Member Functions
Numeric Constants
Member Function Description
BakedLightInstance
Brief Description
Member Functions
Signals
Member Function Description
BakedLightSampler
Brief Description
Member Functions
Numeric Constants
Member Function Description
BaseButton
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
BitMap
Brief Description
Member Functions
Member Function Description
BitmapFont
Brief Description
Member Functions
Member Function Description
BoneAttachment
Brief Description
Member Functions
Description
Member Function Description
bool
Brief Description
Member Functions
Description
Member Function Description
BoxContainer
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
BoxShape
Brief Description
Member Functions
Description
Member Function Description
Button
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
ButtonArray
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
ButtonGroup
Brief Description
Member Functions
Signals
Description
Member Function Description
Camera
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Camera2D
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
CanvasItem
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
CanvasItemMaterial
Brief Description
Member Functions
Numeric Constants
Member Function Description
CanvasItemShader
Brief Description
CanvasItemShaderGraph
Brief Description
CanvasLayer
Brief Description
Member Functions
Description
Member Function Description
CanvasModulate
Brief Description
Member Functions
Description
Member Function Description
CapsuleShape
Brief Description
Member Functions
Description
Member Function Description
CapsuleShape2D
Brief Description
Member Functions
Description
Member Function Description
CenterContainer
Brief Description
Member Functions
Description
Member Function Description
CheckBox
Brief Description
Description
CheckButton
Brief Description
Description
CircleShape2D
Brief Description
Member Functions
Description
Member Function Description
CollisionObject
Brief Description
Member Functions
Signals
Member Function Description
CollisionObject2D
Brief Description
Member Functions
Signals
Description
Member Function Description
CollisionPolygon
Brief Description
Member Functions
Member Function Description
CollisionPolygon2D
Brief Description
Member Functions
Description
Member Function Description
CollisionShape
Brief Description
Member Functions
Member Function Description
CollisionShape2D
Brief Description
Member Functions
Description
Member Function Description
Color
Brief Description
Member Functions
Member Variables
Description
Member Function Description
ColorArray
Brief Description
Member Functions
Description
Member Function Description
ColorFrame
Brief Description
Member Functions
Member Function Description
ColorPicker
Brief Description
Member Functions
Signals
Description
Member Function Description
ColorPickerButton
Brief Description
Member Functions
Signals
Description
Member Function Description
ColorRamp
Brief Description
Member Functions
Description
Member Function Description
ConcavePolygonShape
Brief Description
Member Functions
Description
Member Function Description
ConcavePolygonShape2D
Brief Description
Member Functions
Description
Member Function Description
ConeTwistJoint
Brief Description
Member Functions
Numeric Constants
Member Function Description
ConfigFile
Brief Description
Member Functions
Description
Member Function Description
ConfirmationDialog
Brief Description
Member Functions
Description
Member Function Description
Container
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
Control
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
ConvexPolygonShape
Brief Description
Member Functions
Description
Member Function Description
ConvexPolygonShape2D
Brief Description
Member Functions
Description
Member Function Description
CubeMap
Brief Description
Member Functions
Numeric Constants
Member Function Description
Curve2D
Brief Description
Member Functions
Description
Member Function Description
Curve3D
Brief Description
Member Functions
Description
Member Function Description
DampedSpringJoint2D
Brief Description
Member Functions
Description
Member Function Description
Dictionary
Brief Description
Member Functions
Description
Member Function Description
DirectionalLight
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Directory
Brief Description
Member Functions
Description
Member Function Description
DynamicFont
Brief Description
Member Functions
Numeric Constants
Member Function Description
DynamicFontData
Brief Description
Member Functions
Member Function Description
EditorExportPlugin
Brief Description
Member Functions
Description
Member Function Description
EditorFileDialog
Brief Description
Member Functions
Signals
Numeric Constants
Member Function Description
EditorImportPlugin
Brief Description
Member Functions
Description
Member Function Description
EditorPlugin
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
EditorScenePostImport
Brief Description
Member Functions
Description
Member Function Description
EditorScript
Brief Description
Member Functions
Description
Member Function Description
EditorSelection
Brief Description
Member Functions
Signals
Description
Member Function Description
EditorSettings
Brief Description
Member Functions
Signals
Description
Member Function Description
EditorSpatialGizmo
Brief Description
Member Functions
Description
Member Function Description
Environment
Brief Description
Member Functions
Numeric Constants
Member Function Description
EventPlayer
Brief Description
Member Functions
Description
Member Function Description
EventStream
Brief Description
Description
EventStreamChibi
Brief Description
Description
File
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
FileDialog
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
FixedMaterial
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
float
Brief Description
Member Functions
Description
Member Function Description
Font
Brief Description
Member Functions
Description
Member Function Description
FuncRef
Brief Description
Member Functions
Description
Member Function Description
GDFunctionState
Brief Description
Member Functions
Description
Member Function Description
GDNativeClass
Brief Description
Member Functions
Member Function Description
GDScript
Brief Description
Member Functions
Member Function Description
Generic6DOFJoint
Brief Description
Member Functions
Numeric Constants
Member Function Description
Geometry
Brief Description
Member Functions
Member Function Description
GeometryInstance
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Globals
Brief Description
Member Functions
Description
Member Function Description
GraphEdit
Brief Description
Member Functions
Signals
Description
Member Function Description
GraphNode
Brief Description
Member Functions
Signals
Description
Member Function Description
GridContainer
Brief Description
Member Functions
Description
Member Function Description
GridMap
Brief Description
Member Functions
Numeric Constants
Member Function Description
GrooveJoint2D
Brief Description
Member Functions
Description
Member Function Description
HBoxContainer
Brief Description
Description
HButtonArray
Brief Description
Description
HingeJoint
Brief Description
Member Functions
Numeric Constants
Member Function Description
HScrollBar
Brief Description
Description
HSeparator
Brief Description
Description
HSlider
Brief Description
Description
HSplitContainer
Brief Description
Description
HTTPClient
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
HTTPRequest
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
Image
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
ImageTexture
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
ImmediateGeometry
Brief Description
Member Functions
Member Function Description
Input
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
InputDefault
Brief Description
Description
InputEvent
Brief Description
Member Functions
Member Variables
Numeric Constants
Description
Member Function Description
InputEventAction
Brief Description
Member Functions
Member Variables
Numeric Constants
Description
Member Function Description
InputEventJoystickButton
Brief Description
Member Functions
Member Variables
Numeric Constants
Description
Member Function Description
InputEventJoystickMotion
Brief Description
Member Functions
Member Variables
Numeric Constants
Description
Member Function Description
InputEventKey
Brief Description
Member Functions
Member Variables
Numeric Constants
Description
Member Function Description
InputEventMouseButton
Brief Description
Member Functions
Member Variables
Numeric Constants
Description
Member Function Description
InputEventMouseMotion
Brief Description
Member Functions
Member Variables
Numeric Constants
Description
Member Function Description
InputEventScreenDrag
Brief Description
Member Functions
Member Variables
Numeric Constants
Description
Member Function Description
InputEventScreenTouch
Brief Description
Member Functions
Member Variables
Numeric Constants
Description
Member Function Description
InputMap
Brief Description
Member Functions
Description
Member Function Description
InstancePlaceholder
Brief Description
Member Functions
Description
Member Function Description
int
Brief Description
Member Functions
Description
Member Function Description
IntArray
Brief Description
Member Functions
Description
Member Function Description
InterpolatedCamera
Brief Description
Member Functions
Member Function Description
InverseKinematics
Brief Description
Member Functions
Member Function Description
IP
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
IP_Unix
Brief Description
ItemList
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
Joint
Brief Description
Member Functions
Member Function Description
Joint2D
Brief Description
Member Functions
Description
Member Function Description
KinematicBody
Brief Description
Member Functions
Description
Member Function Description
KinematicBody2D
Brief Description
Member Functions
Description
Member Function Description
Label
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
LargeTexture
Brief Description
Member Functions
Description
Member Function Description
Light
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Light2D
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
LightOccluder2D
Brief Description
Member Functions
Description
Member Function Description
LineEdit
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
LineShape2D
Brief Description
Member Functions
Description
Member Function Description
LinkButton
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Listener
Brief Description
Member Functions
Member Function Description
MainLoop
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
MarginContainer
Brief Description
Description
Marshalls
Brief Description
Member Functions
Member Function Description
Material
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
MaterialShader
Brief Description
MaterialShaderGraph
Brief Description
Matrix3
Brief Description
Member Functions
Member Variables
Description
Member Function Description
Matrix32
Brief Description
Member Functions
Member Variables
Description
Member Function Description
MenuButton
Brief Description
Member Functions
Signals
Description
Member Function Description
Mesh
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
MeshDataTool
Brief Description
Member Functions
Member Function Description
MeshInstance
Brief Description
Member Functions
Description
Member Function Description
MeshLibrary
Brief Description
Member Functions
Description
Member Function Description
MultiMesh
Brief Description
Member Functions
Description
Member Function Description
MultiMeshInstance
Brief Description
Member Functions
Description
Member Function Description
Mutex
Brief Description
Member Functions
Description
Member Function Description
Navigation
Brief Description
Member Functions
Member Function Description
Navigation2D
Brief Description
Member Functions
Member Function Description
NavigationMesh
Brief Description
Member Functions
Member Function Description
NavigationMeshInstance
Brief Description
Member Functions
Member Function Description
NavigationPolygon
Brief Description
Member Functions
Member Function Description
NavigationPolygonInstance
Brief Description
Member Functions
Member Function Description
Nil
Brief Description
Member Functions
Member Function Description
Node
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
Node2D
Brief Description
Member Functions
Description
Member Function Description
NodePath
Brief Description
Member Functions
Description
Member Function Description
Object
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
OccluderPolygon2D
Brief Description
Member Functions
Numeric Constants
Member Function Description
OmniLight
Brief Description
Description
OptionButton
Brief Description
Member Functions
Signals
Description
Member Function Description
OS
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
PackedDataContainer
Brief Description
Member Functions
Member Function Description
PackedDataContainerRef
Brief Description
Member Functions
Member Function Description
PackedScene
Brief Description
Member Functions
Description
Member Function Description
PacketPeer
Brief Description
Member Functions
Description
Member Function Description
PacketPeerStream
Brief Description
Member Functions
Description
Member Function Description
PacketPeerUDP
Brief Description
Member Functions
Description
Member Function Description
Panel
Brief Description
Description
PanelContainer
Brief Description
Description
ParallaxBackground
Brief Description
Member Functions
Description
Member Function Description
ParallaxLayer
Brief Description
Member Functions
Description
Member Function Description
ParticleAttractor2D
Brief Description
Member Functions
Member Function Description
Particles
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Particles2D
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Patch9Frame
Brief Description
Member Functions
Signals
Member Function Description
Path
Brief Description
Member Functions
Description
Member Function Description
Path2D
Brief Description
Member Functions
Description
Member Function Description
PathFollow
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
PathFollow2D
Brief Description
Member Functions
Description
Member Function Description
PathRemap
Brief Description
Member Functions
Description
Member Function Description
PCKPacker
Brief Description
Member Functions
Member Function Description
Performance
Brief Description
Member Functions
Numeric Constants
Member Function Description
PHashTranslation
Brief Description
Member Functions
Description
Member Function Description
Physics2DDirectBodyState
Brief Description
Member Functions
Description
Member Function Description
Physics2DDirectBodyStateSW
Brief Description
Description
Physics2DDirectSpaceState
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Physics2DServer
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Physics2DServerSW
Brief Description
Description
Physics2DShapeQueryParameters
Brief Description
Member Functions
Description
Member Function Description
Physics2DShapeQueryResult
Brief Description
Member Functions
Member Function Description
Physics2DTestMotionResult
Brief Description
Member Functions
Member Function Description
PhysicsBody
Brief Description
Member Functions
Description
Member Function Description
PhysicsBody2D
Brief Description
Member Functions
Description
Member Function Description
PhysicsDirectBodyState
Brief Description
Member Functions
Member Function Description
PhysicsDirectBodyStateSW
Brief Description
PhysicsDirectSpaceState
Brief Description
Member Functions
Numeric Constants
Member Function Description
PhysicsServer
Brief Description
Member Functions
Numeric Constants
Member Function Description
PhysicsServerSW
Brief Description
PhysicsShapeQueryParameters
Brief Description
Member Functions
Member Function Description
PhysicsShapeQueryResult
Brief Description
Member Functions
Member Function Description
PinJoint
Brief Description
Member Functions
Numeric Constants
Member Function Description
PinJoint2D
Brief Description
Member Functions
Description
Member Function Description
Plane
Brief Description
Member Functions
Member Variables
Description
Member Function Description
PlaneShape
Brief Description
Member Functions
Member Function Description
Polygon2D
Brief Description
Member Functions
Description
Member Function Description
PolygonPathFinder
Brief Description
Member Functions
Member Function Description
Popup
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
PopupDialog
Brief Description
Description
PopupMenu
Brief Description
Member Functions
Signals
Description
Member Function Description
PopupPanel
Brief Description
Description
Portal
Brief Description
Member Functions
Description
Member Function Description
Position2D
Brief Description
Description
Position3D
Brief Description
Description
ProgressBar
Brief Description
Member Functions
Description
Member Function Description
ProximityGroup
Brief Description
Member Functions
Signals
Description
Member Function Description
Quad
Brief Description
Member Functions
Member Function Description
Quat
Brief Description
Member Functions
Member Variables
Description
Member Function Description
Range
Brief Description
Member Functions
Signals
Description
Member Function Description
RawArray
Brief Description
Member Functions
Description
Member Function Description
RayCast
Brief Description
Member Functions
Description
Member Function Description
RayCast2D
Brief Description
Member Functions
Description
Member Function Description
RayShape
Brief Description
Member Functions
Member Function Description
RayShape2D
Brief Description
Member Functions
Description
Member Function Description
RealArray
Brief Description
Member Functions
Description
Member Function Description
Rect2
Brief Description
Member Functions
Member Variables
Description
Member Function Description
RectangleShape2D
Brief Description
Member Functions
Description
Member Function Description
Reference
Brief Description
Member Functions
Description
Member Function Description
ReferenceFrame
Brief Description
Description
RegEx
Brief Description
Member Functions
Description
Member Function Description
RemoteTransform2D
Brief Description
Member Functions
Member Function Description
RenderTargetTexture
Brief Description
Resource
Brief Description
Member Functions
Signals
Description
Member Function Description
ResourceImportMetadata
Brief Description
Member Functions
Member Function Description
ResourceInteractiveLoader
Brief Description
Member Functions
Description
Member Function Description
ResourceLoader
Brief Description
Member Functions
Description
Member Function Description
ResourcePreloader
Brief Description
Member Functions
Description
Member Function Description
ResourceSaver
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
RichTextLabel
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
RID
Brief Description
Member Functions
Description
Member Function Description
RigidBody
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
RigidBody2D
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
Room
Brief Description
Member Functions
Description
Member Function Description
RoomBounds
Brief Description
Member Functions
Member Function Description
Sample
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
SampleLibrary
Brief Description
Member Functions
Description
Member Function Description
SamplePlayer
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
SamplePlayer2D
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
SceneState
Brief Description
Member Functions
Member Function Description
SceneTree
Brief Description
Member Functions
Signals
Numeric Constants
Member Function Description
Script
Brief Description
Member Functions
Description
Member Function Description
ScrollBar
Brief Description
Member Functions
Description
Member Function Description
ScrollContainer
Brief Description
Member Functions
Description
Member Function Description
SegmentShape2D
Brief Description
Member Functions
Description
Member Function Description
Semaphore
Brief Description
Member Functions
Description
Member Function Description
Separator
Brief Description
Description
Shader
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
ShaderGraph
Brief Description
Member Functions
Signals
Numeric Constants
Member Function Description
ShaderMaterial
Brief Description
Member Functions
Member Function Description
Shape
Brief Description
Shape2D
Brief Description
Member Functions
Description
Member Function Description
ShortCut
Brief Description
Member Functions
Member Function Description
Skeleton
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Slider
Brief Description
Member Functions
Description
Member Function Description
SliderJoint
Brief Description
Member Functions
Numeric Constants
Member Function Description
SoundPlayer2D
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
SoundRoomParams
Brief Description
Member Functions
Member Function Description
Spatial
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
SpatialGizmo
Brief Description
SpatialPlayer
Brief Description
Member Functions
Numeric Constants
Member Function Description
SpatialSamplePlayer
Brief Description
Member Functions
Numeric Constants
Member Function Description
SpatialSound2DServer
Brief Description
Description
SpatialSound2DServerSW
Brief Description
SpatialSoundServer
Brief Description
SpatialSoundServerSW
Brief Description
SpatialStreamPlayer
Brief Description
Member Functions
Member Function Description
SphereShape
Brief Description
Member Functions
Member Function Description
SpinBox
Brief Description
Member Functions
Description
Member Function Description
SplitContainer
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
SpotLight
Brief Description
Description
Sprite
Brief Description
Member Functions
Signals
Description
Member Function Description
Sprite3D
Brief Description
Member Functions
Signals
Member Function Description
SpriteBase3D
Brief Description
Member Functions
Numeric Constants
Member Function Description
SpriteFrames
Brief Description
Member Functions
Description
Member Function Description
StaticBody
Brief Description
Member Functions
Description
Member Function Description
StaticBody2D
Brief Description
Member Functions
Description
Member Function Description
StreamPeer
Brief Description
Member Functions
Description
Member Function Description
StreamPeerBuffer
Brief Description
Member Functions
Member Function Description
StreamPeerSSL
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
StreamPeerTCP
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
StreamPlayer
Brief Description
Member Functions
Signals
Description
Member Function Description
String
Brief Description
Member Functions
Description
Member Function Description
StringArray
Brief Description
Member Functions
Description
Member Function Description
StyleBox
Brief Description
Member Functions
Description
Member Function Description
StyleBoxEmpty
Brief Description
Description
StyleBoxFlat
Brief Description
Member Functions
Description
Member Function Description
StyleBoxImageMask
Brief Description
Member Functions
Description
Member Function Description
StyleBoxTexture
Brief Description
Member Functions
Signals
Description
Member Function Description
SurfaceTool
Brief Description
Member Functions
Description
Member Function Description
TabContainer
Brief Description
Member Functions
Signals
Description
Member Function Description
Tabs
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
TCP_Server
Brief Description
Member Functions
Description
Member Function Description
TestCube
Brief Description
Description
TextEdit
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
Texture
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
TextureButton
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
TextureFrame
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
TextureProgress
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Theme
Brief Description
Member Functions
Description
Member Function Description
Thread
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
TileMap
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
TileSet
Brief Description
Member Functions
Description
Member Function Description
Timer
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
ToolButton
Brief Description
TouchScreenButton
Brief Description
Member Functions
Signals
Member Function Description
Transform
Brief Description
Member Functions
Member Variables
Description
Member Function Description
Translation
Brief Description
Member Functions
Description
Member Function Description
TranslationServer
Brief Description
Member Functions
Member Function Description
Tree
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
TreeItem
Brief Description
Member Functions
Numeric Constants
Member Function Description
Tween
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
UndoRedo
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
Variant
Brief Description
VBoxContainer
Brief Description
Description
VButtonArray
Brief Description
Description
Vector2
Brief Description
Member Functions
Member Variables
Description
Member Function Description
Vector2Array
Brief Description
Member Functions
Description
Member Function Description
Vector3
Brief Description
Member Functions
Member Variables
Numeric Constants
Description
Member Function Description
Vector3Array
Brief Description
Member Functions
Description
Member Function Description
VehicleBody
Brief Description
Member Functions
Member Function Description
VehicleWheel
Brief Description
Member Functions
Member Function Description
VideoPlayer
Brief Description
Member Functions
Description
Member Function Description
VideoStream
Brief Description
VideoStreamTheora
Brief Description
Viewport
Brief Description
Member Functions
Signals
Numeric Constants
Description
Member Function Description
ViewportSprite
Brief Description
Member Functions
Description
Member Function Description
VisibilityEnabler
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
VisibilityEnabler2D
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
VisibilityNotifier
Brief Description
Member Functions
Signals
Description
Member Function Description
VisibilityNotifier2D
Brief Description
Member Functions
Signals
Description
Member Function Description
VisualInstance
Brief Description
Member Functions
Member Function Description
VisualServer
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
VScrollBar
Brief Description
VSeparator
Brief Description
Description
VSlider
Brief Description
Description
VSplitContainer
Brief Description
Description
WeakRef
Brief Description
Member Functions
Description
Member Function Description
WindowDialog
Brief Description
Member Functions
Description
Member Function Description
World
Brief Description
Member Functions
Description
Member Function Description
World2D
Brief Description
Member Functions
Description
Member Function Description
WorldEnvironment
Brief Description
Member Functions
Description
Member Function Description
XMLParser
Brief Description
Member Functions
Numeric Constants
Description
Member Function Description
YSort
Brief Description
Member Functions
Description
Member Function Description
Godot Engine
Docs
»
Project workflow
»
Project setup
Edit on GitHub
Project setup
ΒΆ
Project organization
Read the Docs
v: 2.1
Versions
latest
stable
3.1
3.0
2.1
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.