Logo
latest

General

  • About
    • Introduction
      • Before you start
      • About Godot Engine
      • About the documentation
      • Organization of the documentation
    • Frequently asked questions
      • What can I do with Godot? How much does it cost? What are the license terms?
      • Which platforms are supported by Godot?
      • Which programming languages are supported in Godot?
      • What is GDScript and why should I use it?
      • What were the motivations behind creating GDScript?
      • What type of 3D model formats does Godot support?
      • Will [insert closed SDK such as FMOD, GameWorks, etc.] be supported in Godot?
      • How should assets be created to handle multiple resolutions and aspect ratios?
      • How can I extend Godot?
      • I would like to contribute! How can I get started?
      • I have a great idea for Godot. How can I share it?
      • Is it possible to use Godot as a library?
      • Why does Godot not use STL (Standard Template Library)
      • Why does Godot not use exceptions?
      • Why does Godot not enforce RTTI?
      • Why does Godot not force users to implement DoD (Data oriented Design)?
      • How can I support Godot development or contribute?
      • Who is working on Godot? How can I contact you?
    • List of features
      • Features
        • Platforms
        • Editor
        • 2D graphics
        • 2D tools
        • 2D physics
        • 3D graphics
        • 3D tools
        • 3D physics
        • Shaders
        • Scripting
        • Audio
        • Import
        • Input
        • Navigation
        • Networking
        • Internationalization
        • Windowing and OS integration
        • Mobile
        • XR support (AR and VR)
        • GUI system
        • Animation
        • Formats
        • Miscellaneous
    • Documentation changelog
      • New tutorials since version 3.1
        • Project workflow
        • 2D
        • Audio
        • Math
        • Inputs
        • Internationalization
        • Shading
        • Networking
        • VR
        • Plugins
        • Multi-threading
        • Creating content
        • Optimization
        • Legal
      • New tutorials since version 3.0
        • Step by step
        • Scripting
        • Project workflow
        • 2D
        • 3D
        • Physics
        • Animation
        • GUI
        • Viewports
        • Shading
        • Plugins
        • Platform-specific
        • Multi-threading
        • Creating content
        • Miscellaneous
        • Compiling
        • Engine development
    • Godot release policy
      • Godot versioning
      • Release support timeline
      • When is the next release out?

Getting started

  • Step by step
    • Introduction to Godot's editor
      • Project manager
        • Create or import a project
      • Your first look at Godot's editor
      • The workspaces
      • Modify the interface
        • Move and resize docks
    • Scenes and nodes
      • Introduction
      • Nodes
      • Scenes
      • Editor
      • Configuring the project
      • To be continued...
    • Instancing
      • Introduction
      • Instancing by example
      • Multiple instances
      • Editing instances
      • Conclusion
    • Instancing (continued)
      • Recap
      • Design language
      • Information overload!
    • Scripting
      • Introduction
        • GDScript
        • VisualScript
        • .NET / C#
        • GDNative / C++
      • Scripting a scene
        • Scene setup
        • Adding a script
        • The role of the script
        • Handling a signal
    • Scripting (continued)
      • Processing
      • Groups
      • Notifications
      • Overridable functions
      • Creating nodes
      • Instancing scenes
      • Register scripts as classes
    • Signals
      • Introduction
      • Timer example
        • Connecting signals in code
      • Custom signals
      • Conclusion
    • Your first game
      • Overview
      • Project setup
        • Organizing the project
      • Player scene
        • Node structure
        • Sprite animation
        • Moving the player
        • Choosing animations
        • Preparing for collisions
      • Enemy scene
        • Node setup
        • Enemy script
      • Main scene
        • Spawning mobs
        • Main script
        • Testing the scene
      • HUD
        • ScoreLabel
        • Message
        • StartButton
        • Connecting HUD to Main
        • Removing old creeps
      • Finishing up
        • Background
        • Sound effects
        • Keyboard shortcut
      • Project files
    • Exporting
      • Overview
      • Preparing the project
      • Setting a main scene
      • Export templates
      • Export presets
      • Exporting by platform
        • PC (Linux/macOS/Windows)
        • Android
        • iOS
        • HTML5 (web)
    • Godot's design philosophy
      • Object-oriented design and composition
      • All-inclusive package
      • Open source
      • Community-driven
      • The Godot editor is a Godot game
      • Separate 2D and 3D engines
    • Design interfaces with the Control nodes
      • The 5 most common UI elements
        • TextureRect
        • TextureButton
        • TextureProgress
        • Label
        • NinePatchRect
      • There are two workflows to build responsive UIs
      • Place UI elements precisely with anchors
        • How to change the anchor
        • Anchors are relative to the parent container
        • Margins change with the anchor
        • Use size tags to change how UI elements fill the available space
      • Arrange control nodes automatically with containers
        • The 5 most useful containers
    • Design a title screen
      • How to design your game UI
      • Design the main menu
        • Break down the UI mockup
        • Prepare the Main Menu scene
        • Add the UI sprites
        • Add containers to place UI elements automatically
        • Break down the UI mockup
    • Design the GUI
      • Breaking down the UI
      • Create the base GUI
        • Create the bars' base
        • Replace the Label's font
        • Add the progress bar
      • Design the bomb and emerald counters
      • Turn the bar and counter into reusable UI components
      • Use scene inheritance to create the remaining elements
        • Inherit the Bar Scene to build the LifeBar
        • Design the EnergyBar
        • Prepare the bomb and emerald counters
      • Add the UI components to the final GUI
      • Place the GUI onto the game's mockup
    • Control the game's UI with code
      • Intro
      • Download and explore the start project
      • Set up the Lifebar with the Player's max_health
      • Update health with a signal when the player takes a hit
      • Animate the loss of life with the Tween node
      • Assign the animated_health to the LifeBar
      • Fade the bar when the Player dies
    • Splash screen
      • Tutorial
      • Setting up
    • Animations
      • Introduction
      • Add an animation player
      • Creating the animation
      • Editing the animation
    • Resources
      • Nodes and resources
      • External vs built-in
      • Loading resources from code
      • Loading scenes
      • Freeing resources
      • Creating your own resources
    • File system
      • Introduction
      • Implementation
      • project.godot
      • 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
    • From Unity to Godot Engine
      • Differences
      • The editor
      • The scene system
      • Project organization
      • Where are my prefabs?
      • Glossary correspondence
      • Scripting: GDScript, C# and Visual Script
        • Design
        • Connections: groups and signals
        • Script serialization
      • Using Godot in C++
    • Command line tutorial
      • Command line reference
      • Path
      • Setting the project path
      • Creating a project
      • Running the editor
      • Erasing a scene
      • Running the game
      • Debugging
      • Exporting
      • Running a script
    • Using an external text editor
    • Default editor shortcuts
      • General Editor Actions
      • 2D / Canvas Item Editor
      • 3D / Spatial Editor
      • Text Editor
      • Script Editor
      • Visual Script Editor
      • Editor Output
      • Debugger
      • File Dialog
      • FileSystem Dock
      • Scene Tree Dock
      • Animation Track Editor
      • Tile Map Editor
      • Tileset Editor
  • Scripting
    • GDScript
      • GDScript basics
        • Introduction
        • Language
        • Built-in types
        • Data
      • GDScript: An introduction to dynamic languages
        • About
        • Dynamic nature
        • Arrays
        • Dictionaries
        • For & while
        • While
        • Custom iterators
        • Duck typing
      • GDScript exports
        • Introduction to exports
        • Examples
        • Exporting bit flags
        • Exporting arrays
        • Setting exported variables from a tool script
        • Advanced exports
      • GDScript style guide
        • Formatting
        • Naming conventions
        • Code order
        • Static typing
      • Static typing in GDScript
        • A brief look at static typing
        • How to use static typing
        • Typed or dynamic: stick to one style
        • Warning system
        • Cases where you can't specify types
        • Summary
      • GDScript warning system
      • GDScript format strings
        • Usage in GDScript
        • Multiple placeholders
        • Format specifiers
        • Padding
        • Escape sequence
        • Format method examples
    • VisualScript
      • What is Visual Scripting
      • Getting started with Visual Scripting
        • Creating a script
        • Adding a function
      • Nodes and terminology
        • Node properties
        • Ports and connections
        • Adding nodes
        • Adding more nodes
      • Custom VisualScript nodes
        • Creating a custom node
        • Using a custom node
    • C#
      • C# basics
        • Introduction
        • Setting up C# for Godot
        • Configuring an external editor
        • Creating a C# script
        • Project setup and workflow
        • Example
        • General differences between C# and GDScript
        • Current gotchas and known issues
        • Performance of C# in Godot
        • Using NuGet packages in Godot
        • Profiling your C# code
        • Configuring VS 2019 for debugging
        • Configuring Visual Studio Code for debugging
      • C# features
        • Type conversion and casting
        • C# signals
        • Preprocessor defines
      • C# API differences to GDScript
        • General differences
        • Global scope
        • Export keyword
        • Signal keyword
        • Singletons
        • String
        • Basis
        • Transform2D
        • Plane
        • Rect2
        • Quat
        • Array
        • Dictionary
        • Variant
        • Communicating with other scripting languages
        • Yield
        • Other differences
      • C# style guide
        • Language specification
        • Formatting
        • Naming conventions
        • Member variables
        • Local variables
        • Implicitly typed local variables
        • Other considerations
    • Cross-language scripting
      • Instantiating nodes
        • Instantiating C# nodes from GDScript
        • Instantiating GDScript nodes from C#
      • Accessing fields
        • Accessing C# fields from GDScript
        • Accessing GDScript fields from C#
      • Calling methods
        • Calling C# methods from GDScript
        • Calling GDScript methods from C#
      • Inheritance
    • Creating script templates
      • Locating the templates
        • Editor-defined templates
        • Project-defined templates
      • Language support and overriding behavior
      • Default template
      • List of template placeholders
        • Base placeholders
        • Type placeholders
  • Project workflow
    • Project setup
      • Project organization
        • Introduction
        • Organization
        • Style guide
        • Importing
        • Case sensitivity
      • Version Control Systems
        • Introduction
        • Official Git plugin
        • Files to exclude from VCS
    • Assets workflow
      • Import process
        • Importing assets in Godot 3.0+
        • Changing import parameters
        • Automatic reimport
        • Files generated
        • Changing import resource type
        • Changing default import parameters
        • Simplicity is key!
      • Importing images
        • Why import them?
        • Importing textures
        • Supported image formats
        • Compression
        • Flags
        • Process
      • Importing audio samples
        • Why import?
        • Best practices
      • Importing translations
        • Games and internationalization
        • Translation format
        • CSV importer
      • Importing 3D scenes
        • Godot scene importer
        • Import workflows
        • Import options
        • Animation options
        • Scene inheritance
        • Import hints
      • Blender ESCN exporter
        • Details on exporting
        • Disabling specific objects
        • Build pipeline integration
    • Export
      • Exporting projects
        • Why export?
        • Export menu
        • Exporting from the command line
      • Exporting packs, patches, and mods
        • Use cases
        • Overview of PCK files
        • Generating PCK files
        • Opening PCK files at runtime
        • Summary
      • Feature tags
        • Introduction
        • Default features
        • Custom features
        • Overriding project settings
        • Default overrides
        • Customizing the build
      • Exporting for PC
      • Exporting for iOS
        • Requirements
        • Export a Godot project to Xcode
        • Active development considerations
        • Services for iOS
      • Exporting for Universal Windows Platform
        • Limitations on Xbox One
        • Creating a signing certificate
        • Setting up automatic signing
        • Installing the package
      • Exporting for Android
        • Download the Android SDK
        • Install OpenJDK 8
        • Create a debug.keystore
        • Make sure you have adb
        • Setting it up in Godot
        • Providing launcher icons
        • Exporting for Google Play Store
        • Optimizing the APK size
      • Exporting for the Web
        • WebGL 2
        • Limitations
        • Serving the files
        • Export options
        • Calling JavaScript from script
      • Exporting for dedicated servers
        • Platform support
        • "Headless" versus "server" binaries
        • Exporting a PCK file
        • Preparing the server distribution
        • Next steps
      • One-click deploy
        • Sounds good, what is it?
        • Steps for one-click deploy
      • Custom builds for Android
        • Set up the custom build environment
        • Install the Android SDK (command-line version)
        • Install the Android SDK (Android Studio)
        • Enabling the custom build and exporting
      • Changing application icon for Windows
        • Changing the taskbar icon
        • Changing the file icon
        • Testing the result
        • ICO file requirements
    • Best practices
      • Introduction
      • Godot scenes and scripts are classes
        • Making sense of classes in Godot
        • Scripting performances and PackedScene
        • Scenes and scripts are objects
      • Scene organization
        • How to build relationships effectively
        • Choosing a node tree structure
      • When to use scenes versus scripts
        • Anonymous types
        • Named types
        • Conclusion
      • Autoloads versus regular nodes
        • The cutting audio issue
        • Managing shared functionality or data
        • When you should use an Autoload
      • When and how to avoid using nodes for everything
      • Godot interfaces
        • Acquiring object references
        • Accessing data or logic from an object
      • Godot notifications
        • _process vs. _physics_process vs. *_input
        • _init vs. initialization vs. export
        • _ready vs. _enter_tree vs. NOTIFICATION_PARENTED
      • Data preferences
        • Array vs. Dictionary vs. Object
        • Enumerations: int vs. string
        • AnimatedTexture vs. AnimatedSprite vs. AnimationPlayer vs. AnimationTree
      • Logic preferences
        • Loading vs. preloading
        • Large levels: static vs. dynamic

Tutorials

  • 2D
    • Canvas layers
      • Viewport and Canvas items
      • CanvasLayers
    • Viewport and canvas transforms
      • Introduction
      • Canvas transform
      • Global canvas transform
      • Stretch transform
      • Transform order
      • Transform functions
      • Feeding custom input events
    • Using tilemaps
      • Introduction
      • Project setup
      • TileMap node
      • Creating a TileSet
      • Collision shapes
      • Atlas tiles
        • Random tile priorities
      • Autotiles
        • 2x2
        • 3x3 (minimal)
        • 3x3
        • Disabling autotile
        • Autotile binding
      • Tips and tricks
    • Particle systems (2D)
      • Intro
        • Particle nodes
        • ParticlesMaterial
        • Texture
      • Time parameters
        • Lifetime
        • One Shot
        • Preprocess
        • Speed Scale
        • Explosiveness
        • Randomness
        • Fixed FPS
        • Fract Delta
      • Drawing parameters
        • Visibility Rect
        • Local Coords
        • Draw Order
      • ParticlesMaterial settings
        • Spread
        • Gravity
        • Initial Velocity
        • Angular Velocity
        • Spin Velocity
        • Orbit Velocity
        • Linear Acceleration
        • Radial Acceleration
        • Tangential Acceleration
        • Damping
        • Angle
        • Scale
        • Color
        • Hue variation
      • Emission Shapes
        • Emission Mask
        • Emission Colors
    • 2D movement overview
      • Introduction
      • Setup
      • 8-way movement
      • Rotation + movement
      • Rotation + movement (mouse)
      • Click-and-move
      • Summary
    • 2D lights and shadows
      • Introduction
      • Setup
      • Nodes
      • Lights
      • Shadows
      • Step by step
    • 2D meshes
      • Introduction
      • Optimizing pixels drawn
      • Converting Sprites to 2D meshes
    • Custom drawing in 2D
      • Why?
      • But...
      • OK, how?
      • Updating
      • An example: drawing circular arcs
        • Arc function
        • Draw the arc on the screen
        • Arc polygon function
        • Dynamic custom drawing
      • Tools
    • 2D Sprite animation
      • Introduction
      • Individual images with AnimatedSprite
        • Controlling the animation
      • Sprite sheet with AnimatedSprite
      • Sprite sheet with AnimationPlayer
        • Controlling an AnimationPlayer animation
      • Summary
  • 3D
    • Introduction to 3D
      • Spatial node
      • 3D content
        • DCC-created models
        • Generated geometry
        • Immediate geometry
        • 2D in 3D
      • Environment
      • 3D viewport
        • Coordinate system
        • Space and manipulation gizmos
        • View menu
        • Default environment
        • Cameras
        • Lights
    • Using 3D transforms
      • Introduction
      • Problems of Euler angles
        • Axis order
        • Interpolation
        • Say no to Euler angles
      • Introducing transforms
        • Manipulating transforms
        • Precision errors
        • Obtaining information
        • Setting information
        • Interpolating with quaternions
      • Transforms are your friend
    • Optimizing 3D performance
      • Introduction
      • Rendering
        • Reuse shaders and materials
        • Pixel cost vs vertex cost
        • Texture compression
        • Transparent objects
        • Level of detail (LOD)
        • Use instancing (MultiMesh)
        • Bake lighting
    • 3D rendering limitations
      • Introduction
      • Texture size limits
      • Color banding
      • Depth buffer precision
      • Transparency sorting
      • Multi-sample antialiasing
    • Standard Material 3D
      • Introduction
      • Flags
        • Transparent
        • Use Shadow to Opacity
        • Unshaded
        • Vertex Lighting
        • No Depth Test
        • Use Point Size
        • World Triplanar
        • Fixed Size
        • Do Not Receive Shadows
        • Disable Ambient Light
        • Ensure Correct Normals
      • Vertex Color
        • Use as Albedo
        • Is sRGB
      • Parameters
        • Diffuse Mode
        • Specular Mode
        • Blend Mode
        • Cull Mode
        • Depth Draw Mode
        • Line Width
        • Point Size
        • Billboard Mode
        • Billboard Keep Scale
        • Grow
        • Use Alpha Scissor
      • Material colors, maps and channels
        • Albedo
        • Metallic
        • Roughness
        • Emission
        • Normal map
        • Rim
        • Clearcoat
        • Anisotropy
        • Ambient Occlusion
        • Depth
        • Subsurface Scattering
        • Transmission
        • Refraction
        • Detail
        • UV1 and UV2
        • Triplanar Mapping
      • Proximity and distance fade
      • Render priority
    • 3D lights and shadows
      • Introduction
      • Light nodes
        • Shadow mapping
        • Directional shadow mapping
        • Omni shadow mapping
        • Spot shadow mapping
    • Reflection probes
      • Introduction
      • Setting up
      • Interior vs exterior
      • Blending
      • Reflection atlas
    • GI Probes
      • Introduction
      • Setting up
      • Adding lights
      • Reflections
      • Interior vs exterior
      • Tweaking
      • Quality
    • Baked lightmaps
      • Introduction
      • Visual comparison
      • Setting up
        • Unwrap from your 3D DCC
        • Unwrap from within Godot
        • Unwrap on scene import
        • Checking UV2
      • Setting up the scene
        • Configure bounds
        • Setting up meshes
        • Setting up lights
        • Baking quality
      • Baking
        • Configuring bake
      • Dynamic objects
    • Environment and post-processing
      • Environment
        • Camera node
        • WorldEnvironment node
        • Default environment
      • Environment options
        • Background
        • Ambient Light
        • Fog
        • Tonemap
        • Auto Exposure (HDR)
      • Mid- and post-processing effects
        • Screen-Space Reflections (SSR)
        • Screen-Space Ambient Occlusion (SSAO)
        • Depth of Field / Far Blur
        • Depth of Field / Near Blur
        • Glow
        • Adjustments
    • Light transport in game engines
      • Introduction
      • Computer displays
      • Scene linear & asset pipelines
        • sRGB transfer function to display linear ratios on image import
        • Hardware sRGB transfer function to display linear conversion
        • Scene linear to display referred nonlinear
      • Parameters of HDR
    • Using gridmaps
      • Introduction
      • Example project
      • Creating a MeshLibrary
      • Collisions
      • Materials
      • Exporting the MeshLibrary
      • Using GridMap
      • Using GridMap in code
    • Using MultiMeshInstance
      • Introduction
      • Setting up the nodes
      • MultiMesh settings
        • Target Surface
        • Source Mesh
        • Mesh Up Axis
        • Random Rotation
        • Random Tilt
        • Random Scale
        • Scale
        • Amount
    • CSG
      • Introduction to CSG nodes
        • CSG tools features
        • CSGPolygon
        • Custom meshes
        • CSGCombiner
        • Processing order
      • Prototyping a level
      • Using prototype textures
    • FPS tutorial
      • Part 1
        • Tutorial introduction
        • Part overview
        • Getting everything ready
        • Making the FPS movement logic
        • Giving the player a flash light and the option to sprint
        • Final notes
      • Part 2
        • Part overview
        • Making a system to handle animations
        • Getting the animations ready
        • Creating the bullet scene
        • Creating the first weapon
        • Creating the other two weapons
        • Making the weapons work
        • Creating some test subjects
        • Final notes
      • Part 3
        • Part overview
        • Changing levels
        • Adding ammo
        • Adding reloading to the weapons
        • Adding reloading to the player
        • Adding sounds
        • Final notes
      • Part 4
        • Part overview
        • Adding joypad input
        • Adding mouse scroll wheel input
        • Adding the health pickups
        • Adding the ammo pickups
        • Adding breakable targets
        • Final notes
      • Part 5
        • Part overview
        • Adding grenades
        • Adding grenades to the player
        • Adding the ability to grab and throw RigidBody nodes to the player
        • Adding a turret
        • Final notes
      • Part 6
        • Part overview
        • Adding the main menu
        • Making the Globals singleton
        • Adding the debug menu
        • Adding a pause menu
        • Starting the respawn system
        • Finishing the respawn system
        • Writing a sound system we can use anywhere
        • Final notes
    • Animating thousands of objects
      • Animating thousands of fish with MultiMeshInstance
        • Animating one Fish
        • Making a school of fish
        • Animating a school of fish
      • Controlling thousands of fish with Particles
  • Audio
    • Audio buses
      • Introduction
      • Decibel scale
      • Audio buses
      • Playback of audio through a bus
      • Adding effects
        • Amplify
        • BandLimit and BandPass
        • Chorus
        • Compressor
        • Delay
        • Distortion
        • EQ
        • EQ6, EQ10, EQ21
        • Filter
        • HighPassFilter, HighShelfFilter
        • Limiter
        • LowPassFilter, LowShelfFilter
        • NotchFilter
        • Panner
        • Phaser
        • PitchShift
        • Record
        • Reverb
        • SpectrumAnalyzer
        • StereoEnhance
      • Automatic bus disabling
      • Bus rearrangement
      • Default bus layout
    • Audio streams
      • Introduction
      • AudioStream
      • AudioStreamPlayer
      • AudioStreamPlayer2D
      • AudioStreamPlayer3D
        • Reverb buses
        • Doppler
    • Sync the gameplay with audio and music
      • Introduction
      • Using the system clock to sync
      • Using the sound hardware clock to sync
    • Recording with microphone
      • The structure of the demo
  • Physics
    • Physics introduction
      • Collision objects
        • Collision shapes
        • Physics process callback
        • Collision layers and masks
      • Area2D
      • StaticBody2D
      • RigidBody2D
        • Rigid body modes
        • Using RigidBody2D
        • Contact reporting
      • KinematicBody2D
        • Kinematic collision response
    • RigidBody
      • What is a rigid body?
      • How to control a rigid body
      • The "look at" method
    • Using Area2D
      • Introduction
      • What is an area?
      • Area properties
      • Overlap detection
      • Area influence
        • Point gravity
        • Examples
    • Using KinematicBody2D
      • Introduction
      • What is a kinematic body?
      • Movement and collision
        • move_and_collide
        • move_and_slide
        • move_and_slide_with_snap
      • Detecting collisions
      • Which movement method to use?
      • Examples
        • Movement and walls
        • Bouncing/reflecting
        • Platformer movement
    • Ray-casting
      • Introduction
      • Space
      • Accessing space
      • Raycast query
      • Collision exceptions
      • Collision Mask
      • 3D ray casting from screen
    • Ragdoll system
      • Introduction
      • Setting up the ragdoll
        • Creating physical bones
        • Cleaning up the skeleton
        • Collision shape adjustment
        • Joints adjustment
      • Simulating the ragdoll
        • Collision layer and mask
    • Kinematic character (2D)
      • Introduction
      • Physics process
      • Scene setup
      • Moving the kinematic character
    • SoftBody
      • Basic set-up
      • Cloak simulation
  • Math
    • Vector math
      • Introduction
      • Coordinate systems (2D)
      • Vector operations
        • Member access
        • Adding vectors
        • Scalar multiplication
      • Practical applications
        • Movement
        • Pointing toward a target
      • Unit vectors
        • Normalization
        • Reflection
      • Dot product
        • Facing
      • Cross product
        • Calculating normals
        • Pointing to a target
      • More information
    • Advanced vector math
      • Planes
        • Distance to plane
        • Away from the origin
        • Constructing a plane in 2D
        • Some examples of planes
      • Collision detection in 3D
      • More information
    • Matrices and transforms
      • Introduction
        • Matrix components and the Identity matrix
        • Scaling the transformation matrix
        • Rotating the transformation matrix
        • Basis of the transformation matrix
        • Translating the transformation matrix
        • Putting it all together
        • Shearing the transformation matrix (advanced)
      • Practical applications of transforms
        • Converting positions between transforms
        • Moving an object relative to itself
        • Applying transforms onto transforms
        • Inverting a transformation matrix
      • How does it all work in 3D?
        • Representing rotation in 3D (advanced)
    • Interpolation
      • Vector interpolation
      • Transform interpolation
      • Smoothing motion
    • Beziers, curves and paths
      • Quadratic Bezier
      • Cubic Bezier
      • Adding control points
      • Curve2D, Curve3D, Path and Path2D
      • Evaluating
      • Drawing
      • Traversal
  • Animation
    • Introduction to the 2D animation features
      • Overview
      • Create an AnimationPlayer node
      • Computer animation relies on keyframes
      • Tutorial: Creating a simple animation
        • Scene setup
        • Adding a track
        • The second keyframe
        • Run the animation
        • Back and forth
        • Track settings
      • Keyframes for other properties
      • Edit keyframes
      • Advanced: Call Method tracks
    • Cutout animation
      • What is it?
      • Cutout animation in Godot
      • Making of GBot
      • Setting up the rig
      • Adjusting the pivot
      • RemoteTransform2D node
      • Completing the skeleton
      • Skeletons
      • IK chains
      • Animation tips
        • Setting keyframes and excluding properties
      • Creating a rest pose
      • Modifying rotation only
      • Keyframing IK chains
      • Visually move a sprite behind its parent
      • Setting easing curves for multiple keys
      • 2D Skeletal deform
    • 2D skeletons
      • Introduction
      • Setup
      • Creating the polygons
      • Creating the skeleton
      • Deforming the polygons
      • Internal vertices
    • AnimationTree
      • Introduction
      • Creating an AnimationTree
      • Creating a tree
      • Blend tree
        • Blend2 / Blend3
        • OneShot
        • Seek
        • TimeScale
        • Transition
        • BlendSpace2D
        • BlendSpace1D
        • StateMachine
      • Root motion
      • Controlling from code
      • State machine travel
  • Inputs
    • InputEvent
      • What is it?
      • How does it work?
      • Anatomy of an InputEvent
      • Actions
      • InputMap
    • Input examples
      • Introduction
      • Events versus polling
      • Input events
      • InputMap
        • Capturing actions
      • Keyboard events
        • Keyboard modifiers
      • Mouse events
        • Mouse buttons
        • Mouse motion
      • Touch events
    • Mouse and input coordinates
      • About
      • Hardware display coordinates
      • Viewport display coordinates
    • Customizing the mouse cursor
      • Using project settings
      • Using a script
      • Demo project
      • Cursor list
  • I/O
    • Background loading
      • ResourceInteractiveLoader
      • Usage
        • Obtaining a ResourceInteractiveLoader
        • Polling
        • Load progress (optional)
        • Forcing completion (optional)
        • Obtaining the resource
      • Example
      • Using multiple threads
        • Use a semaphore
        • Not blocking main thread during the polling
      • Example class
        • Example:
    • Data paths
      • Path separators
      • Resource path
      • User path (persistent data)
      • Editor data paths
        • Self-contained mode
    • Saving games
      • Introduction
      • Identify persistent objects
      • Serializing
      • Saving and reading data
      • Some notes
    • Encrypting save games
      • Why?
      • How?
  • Internationalization
    • Internationalizing games
      • Introduction
      • Configuring the imported translation
      • Localizing resources
      • Converting keys to text
      • Making controls resizable
      • TranslationServer
      • Command line
      • Translating the project name
    • Localization using gettext
      • Advantages
      • Disadvantages
      • Caveats
      • Installing gettext tools
      • Creating the PO template (POT) manually
      • Creating the PO template (POT) using pybabel
      • Creating a messages file from a PO template
      • Loading a messages file in Godot
      • Updating message files to follow the PO template
      • Checking the validity of a PO file or template
    • Locales
  • 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
        • Checking control size
        • Checking focus
      • Sizing
      • Input
        • Input events
        • Notifications
    • Size and anchors
      • Centering a control
    • Containers
      • Container layout
      • Size flags
      • Container types
        • Box Containers
        • Grid Container
        • Margin Container
        • Tab Container
        • Split Container
        • PanelContainer
        • ScrollContainer
        • ViewportContainer
      • Creating custom Containers
    • BBCode in RichTextLabel
      • Introduction
      • Using BBCode
      • Reference
        • Built-in color names
        • Hexadecimal color codes
        • Image vertical offset
      • Animation effects
        • Wave
        • Tornado
        • Shake
        • Fade
        • Rainbow
      • Custom BBCode tags and text effects
        • _process_custom_fx
        • Ghost
        • Pulse
        • Matrix
  • Viewports
    • Viewports
      • Introduction
      • Input
      • Listener
      • Cameras (2D & 3D)
      • Scale & stretching
      • Worlds
      • Capture
      • Viewport Container
      • Rendering
      • Render target
    • Multiple resolutions
      • The problem of multiple resolutions
      • One size fits all
      • Base size
      • Resizing
      • Stretch settings
        • Stretch Mode
        • Stretch Aspect
        • Stretch Shrink
        • From scripts
      • Reducing aliasing on downsampling
      • Handling aspect ratios
      • Field of view scaling
      • Scaling 2D and 3D elements differently using Viewports
    • Using a Viewport as a texture
      • Introduction
      • Setting up the Viewport
      • Applying the texture
      • Making the planet texture
      • Coloring the planet
      • Making an ocean
    • Custom post-processing
      • Introduction
      • Single pass post-processing
      • Multi-pass post-processing
  • Shading
    • Shading reference
      • Shaders
        • Introduction
        • Shader types
        • Render modes
        • Processor functions
      • Shading language
        • Introduction
        • Data types
        • Arrays
        • Constants
        • Structs
        • Operators
        • Flow control
        • Discarding
        • Functions
        • Built-in functions
      • Spatial shaders
        • Render modes
        • Built-ins
        • Global built-ins
        • Vertex built-ins
        • Fragment built-ins
        • Light built-ins
      • CanvasItem shaders
        • Render modes
        • Built-ins
        • Global built-ins
        • Vertex built-ins
        • Fragment built-ins
        • Light built-ins
      • Particle shaders
        • Render modes
        • Built-ins
        • Global built-ins
        • Vertex built-ins
      • Sky shaders
        • Render modes
        • Built-ins
        • Global built-ins
        • Fragment built-ins
    • Your first shader
      • What are shaders?
        • Introduction
        • But what are they?
        • Structure of a shader
        • Technical overview
      • Your first CanvasItem shader
        • Introduction
        • Setup
        • Your first CanvasItem shader
        • Your first fragment function
        • Your first vertex function
        • Conclusion
      • Your first Spatial shader
        • Where to assign my material
        • Setting up
        • Shader magic
        • Noise heightmap
        • Uniforms
        • Interacting with light
      • Your first Spatial shader: part 2
        • Your first spatial fragment function
        • Animating with TIME
        • Advanced effects: waves
    • Shader materials
      • Introduction
      • Creating a ShaderMaterial
      • Converting to ShaderMaterial
    • VisualShaders
      • Creating a VisualShader
      • Using the Visual Shader Editor
      • Visual Shader nodes
        • Expression node
        • Fresnel node
        • Boolean node
        • If node
        • Switch node
    • Intro to shaders: 2D and 3D water
      • Watch the tutorials
      • Download the source code
    • Screen-reading shaders
      • Introduction
      • SCREEN_TEXTURE built-in texture
      • SCREEN_TEXTURE example
      • Behind the scenes
      • Back-buffer logic
      • DEPTH_TEXTURE
    • Migrating to Godot's shading language
      • Introduction
      • GLSL
        • Shader programs
        • Vertex attributes
        • gl_Position
        • Varyings
        • Main
        • Macros
        • Variables
        • Coordinates
        • Precision
      • Shadertoy
        • Types
        • mainImage
        • Variables
        • Coordinates
      • The Book of Shaders
        • Types
        • Main
        • Variables
        • Coordinates
    • Godot shader language style guide
      • Formatting
        • Encoding and special characters
        • Indentation
        • Line breaks and blank lines
        • Blank lines
        • Line length
        • One statement per line
        • Comment spacing
        • Whitespace
        • Floating-point numbers
      • Accessing vector members
      • Naming conventions
        • Functions and variables
        • Constants
      • Code order
        • Local variables
    • Advanced post-processing
      • Introduction
      • Full screen quad
      • Depth texture
      • An optimization
  • Networking
    • High-level multiplayer
      • High-level vs low-level API
      • Mid level abstraction
      • Initializing the network
      • Managing connections
      • RPC
      • Back to lobby
      • Starting the game
        • Player scenes
        • Synchronizing game start
      • Synchronizing the game
        • Network master
        • Master and puppet keywords
      • Exporting for dedicated servers
    • Making HTTP requests
      • Preparing scene
      • Scripting
      • Sending data to server
    • HTTP client class
    • SSL certificates
      • Introduction
      • Approach 1: self signed cert
      • Approach 2: CA cert
    • WebSocket
      • HTML5 and WebSocket
      • Using WebSocket in Godot
        • Minimal client example
        • Minimal server example
        • Advanced chat demo
    • WebRTC
      • HTML5, WebSocket, WebRTC
        • WebSocket
        • WebRTC
      • Using WebRTC in Godot
        • Minimal connection example
        • Local signaling example
        • Remote signaling with WebSocket
  • Asset Library
    • About the Asset Library
      • Types of assets
      • Frequently asked questions
        • Can paid assets be uploaded to the asset library?
    • Using the AssetLib
      • On the website
        • Overview
        • Searching
        • Breakdown of an asset
        • Registering and logging in
      • In the editor
    • Submitting to the Asset Library
      • Introduction
      • Submission guidelines
        • Requirements
        • Recommendations
      • Submitting
  • VR
    • AR/VR primer
      • AR/VR server
      • New AR/VR nodes
      • Official plugins and resources
      • Other things to consider
    • VR starter tutorial
      • VR starter tutorial part 1
        • Introduction
        • Getting everything ready
        • Starting VR
        • Creating the controllers
        • Creating a base class for interactable VR objects
        • Reducing motion sickness
        • Final notes
      • VR starter tutorial part 2
        • Introduction
        • Adding destroyable targets
        • Adding a pistol
        • Adding a shotgun
        • Adding a bomb
        • Adding a sword
        • Updating the target UI
        • Adding the final special RigidBody
        • Final notes
    • Developing for Oculus Quest
      • Introduction
      • Setting Up Godot
      • Setting Up Your Quest
  • Plugins
    • Editor plugins
      • Installing plugins
        • Finding plugins
        • Installing a plugin
        • Enabling a plugin
      • Making plugins
        • About plugins
        • Creating a plugin
        • A custom node
        • Going beyond
      • Making main screen plugins
        • What this tutorial covers
        • Initializing the plugin
        • Main screen scene
        • Update the plugin script
        • Try the plugin
      • Import plugins
        • Introduction
        • Configuration
        • The EditorImportPlugin class
        • Options and presets
        • The import method
        • Platform variants and generated files
        • Trying the plugin
      • Spatial gizmo plugins
        • Introduction
        • The EditorSpatialGizmoPlugin
        • Simple approach
        • Alternative approach
      • Inspector plugins
        • Setup
        • EditorInspectorPlugin
        • EditorProperty
      • Visual Shader plugins
    • GDNative
      • GDNative C example
        • Introduction
        • Prerequisites
        • Our C source
        • Compiling
        • Creating the GDNativeLibrary (.gdnlib) file
        • Creating the NativeScript (.gdns) file
      • GDNative C++ example
        • Introduction
        • Setting up the project
        • Building the C++ bindings
        • Creating a simple plugin
        • Compiling the plugin
        • Using the GDNative module
        • Adding properties
        • Signals
        • NativeScript 1.1 vs NativeScript 1.0
        • Next steps
    • Android plugins
      • Creating Android plugins
        • Introduction
        • Android plugin
        • Troubleshooting
  • Platform-specific
    • Android in-app purchases
      • Migrating from Godot 3.2.1 and lower (GodotPaymentsV3)
        • Changes
      • Usage
        • Getting started
        • Getting started
        • Querying available items
        • Purchase an item
        • Check if the user purchased an item
        • Consumables
        • Subscriptions
    • Services for iOS
      • Asynchronous methods
      • Store Kit
        • purchase
        • request_product_info
        • restore_purchases
      • Game Center
        • authenticate
        • post_score
        • award_achievement
        • reset_achievements
        • request_achievements
        • request_achievement_descriptions
        • show_game_center
      • Multi-platform games
    • HTML5
      • HTML5 shell class reference
        • Engine
      • Custom HTML page for Web export
        • Setup
        • Starting the project
        • Customizing the behavior
        • Customizing the presentation
        • Debugging
    • Console support in Godot
      • Console publishing process
      • Official support
      • Third-party support
  • Multi-threading
    • Using multiple threads
      • Threads
      • Creating a Thread
      • Mutexes
      • Semaphores
    • Thread-safe APIs
      • Threads
      • Global scope
      • Scene tree
      • GDScript arrays, dictionaries
      • Resources
  • Creating content
    • Procedural geometry
      • Using the ArrayMesh
        • ArrayMesh
        • Generating geometry
        • Saving
      • Using the MeshDataTool
      • Using the SurfaceTool
      • Using ImmediateGeometry
      • What is geometry?
      • What is a Mesh?
      • What a Mesh is
        • Surfaces
        • Surface array
      • Tools
        • ArrayMesh
        • MeshDataTool
        • SurfaceTool
        • ImmediateGeometry
      • Which one should I use?
    • Making trees
      • Start with a tree
      • Paint with vertex colors
      • Write a custom shader for the leaves
      • Improving the shader
  • Optimization
    • Optimization using Servers
      • Servers
      • RIDs
      • Creating a sprite
      • Instantiating a Mesh into 3D space
      • Creating a 2D RigidBody and moving a sprite with it
      • Getting data from the servers
    • Optimization using MultiMeshes
      • MultiMeshes
      • Multimesh example
  • Miscellaneous
    • Fixing jitter and stutter
      • What are jitter and stutter?
      • Distinguishing between them
      • Jitter
      • Stutter
        • Windows
        • Linux
        • macOS
        • Android
        • iOS
      • Reporting stutter or jitter problems
    • Handling quit requests
      • Quitting
      • Handling the notification
    • Pausing games
      • Pause?
      • How pausing works
      • White-listing nodes
      • Example
    • Binary serialization API
      • Introduction
      • Packet specification
        • 0: null
        • 1: bool
        • 2: int
        • 3: float
        • 4: String
        • 5: Vector2
        • 6: Rect2
        • 7: Vector3
        • 8: Transform2D
        • 9: Plane
        • 10: Quat
        • 11: AABB
        • 12: Basis
        • 13: Transform
        • 14: Color
        • 15: NodePath
        • 16: RID (unsupported)
        • 17: Object (unsupported)
        • 18: Dictionary
        • 19: Array
        • 20: PackedByteArray
        • 21: PackedInt32Array
        • 22: PackedInt64Array
        • 23: PackedFloat32Array
        • 24: PackedFloat64Array
        • 25: PackedStringArray
        • 26: PackedVector2Array
        • 27: PackedVector3Array
        • 28: PackedColorArray
    • Running code in the editor
      • What is tool?
      • How to use it
      • Try it out
      • Editing variables
      • Instancing scenes
    • Change scenes manually
    • Differences between GLES2 and GLES3
      • Particles
      • SCREEN_TEXTURE mip-maps
      • DEPTH_TEXTURE
      • Color space
      • HDR
      • StandardMaterial3D features
      • Environment features
      • GIProbes
      • Contact shadows
      • Light performance
      • Texture compression
      • Blend shapes
      • Shading language
        • textureSize() workaround
      • Built in variables and render modes
    • Instancing with signals
      • Shooting example
    • State design pattern
      • Introduction
      • Script setup
      • Project setup
  • Debug
    • Overview of debugging tools
      • Debugger Panel
      • Debug menu options
        • Deploy with Remote Debug
        • Small Deploy with Network FS
        • Visible Collision Shapes
        • Visible Navigation
        • Sync Scene Changes
        • Sync Script Changes
      • Script editor debug tools and options
      • Debug project settings
        • Settings
        • GDScript
        • Shapes
      • Remote in scene dock
    • Debugger panel
      • Debugger
      • Errors
      • Profiler
      • Network Profiler
      • Monitors
      • Video RAM
      • Misc
  • Legal
    • Complying with Licenses
      • What are licenses?
      • Requirements
      • Inclusion
        • Credits screen
        • Licenses screen
        • Output log
        • Accompanying file
        • Printed manual
      • Third Party licenses
        • FreeType
        • ENet
        • MBedTLS

Development

  • Compiling
    • Getting the source
      • Downloading the Godot source code
    • Introduction to the buildsystem
      • SCons
      • Setup
      • Platform selection
      • Resulting binary
      • Tools
      • Target
      • Bits
      • Custom modules
      • Cleaning generated files
      • Other build options
        • Overriding the build options
      • Export templates
    • Compiling for Windows
      • Requirements
      • Setting up Python
      • Setting up SCons
      • Installing Visual Studio caveats
      • Downloading Godot's source
      • Compiling
        • Selecting a compiler
        • Running SCons
      • Development in Visual Studio or other IDEs
      • Cross-compiling for Windows from other operating systems
        • Troubleshooting
      • Creating Windows export templates
    • Compiling for Linux, *BSD
      • Requirements
        • Distro-specific one-liners
      • Compiling
      • Compiling a headless/server build
      • Building export templates
      • Using Clang and LLD for faster development
    • Compiling for macOS
      • Requirements
      • Compiling
      • Compiling a headless/server build
      • Cross-compiling for macOS from Linux
    • Compiling for Android
      • Note
      • Requirements
      • Setting up the buildsystem
      • Building the export templates
        • Adding support for x86 devices
        • Cleaning the generated export templates
      • Using the export templates
        • Installing the templates
      • Troubleshooting
        • Platform doesn't appear in SCons
        • 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
      • Building export templates
      • Building per asm.js translation or LLVM backend
    • Compiling with Mono
      • Requirements
      • Environment variables
      • Enable the Mono module
      • Generate the glue
        • Notes
      • Rebuild with Mono glue
      • Examples
        • Example (Windows)
        • Example (Linux, *BSD)
      • Data directory
        • Export templates
        • Editor
      • Building the Mono runtime
      • Targeting Android
      • Targeting iOS
      • Targeting WebAssembly
      • Base Class Library
      • AOT cross-compilers
      • Command-line options
    • Optimizing a build for size
      • Rationale
      • Disabling 3D
      • Disabling advanced GUI nodes
      • Disabling unwanted modules
      • Optimizing for size instead of speed
      • Compiling with link-time optimization
      • Stripping binaries
      • Using UPX to compress binaries
    • Compiling with script encryption key
      • Step by step
      • Possible Errors
  • Engine development
    • Introduction to Godot development
      • Architecture diagram
      • Debugging the editor with gdb
    • Configuring an IDE
      • Android Studio
        • Importing the project
      • CLion
        • Importing the project
      • Code::Blocks
        • Creating a new project
        • Configuring the build
        • Configuring the run
        • Adding files to the project
        • Code style configuration
      • KDevelop
        • Importing the project
        • Debugging the project
      • Qt Creator
        • Importing the project
        • Debugging the project
        • Code style configuration
      • Visual Studio
        • Importing the project
        • Debugging the project
      • Visual Studio Code
        • Importing the project
        • Debugging the project
      • Xcode
        • Importing the project
        • Debugging the project
    • Common engine methods and macros
      • Print text
      • Format a string
      • Convert an integer or float to a string
      • Internationalize a string
      • Clamp a value
      • Microbenchmarking
      • Get project/editor settings
      • Error macros
    • 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:
      • Containers: 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
      • Compiling a module externally
      • Customizing module types initialization
      • Improving the build system for development
      • Writing custom documentation
      • Adding custom editor icons
      • Summing up
    • Binding to external libraries
      • Modules
      • Using the module
    • Custom resource format loaders
      • Introduction
        • References
      • What for?
      • What not?
        • References
      • Creating a ResourceFormatLoader
      • Creating a ResourceFormatSaver
      • Creating custom data types
        • Considerations
        • References
      • Registering the new file format
        • References
      • Loading it on GDScript
    • Custom AudioStreams
      • Introduction
        • References:
      • What for?
      • Create an AudioStream
        • References:
      • Create an AudioStreamPlayback
        • Resampling
        • References:
    • Custom Godot servers
      • Introduction
        • References
      • What for?
      • Creating a Godot server
      • Custom managed resource data
        • References
      • Registering the class in GDScript
        • Bind methods
      • MessageQueue
        • References:
      • Summing it up
        • Notes
  • Editor development
    • Editor icons
      • Creating icons
      • Color conversion for light editor themes
      • Icon optimization
      • Integrating and sharing the icons
      • Troubleshooting
      • References
    • Editor style guide
      • Introduction
      • Writing style
      • Button and menu texts
      • Inspector sections
      • Inspector performance hints
      • Tooltips
  • Godot file formats
    • GDScript grammar
    • TSCN file format
      • File structure
        • Entries inside the file
      • The scene tree
        • NodePath
        • Skeleton
        • BoneAttachment
        • AnimationPlayer
      • Resources
        • External resources
        • Internal resources
        • ArrayMesh
        • Animation

Community

  • Contributing
    • Ways to contribute
      • Contributing code
      • Testing and reporting issues
        • Testing development versions
        • Filing an issue on GitHub
      • Contributing to the documentation
      • Contributing translations
    • Best practices for engine contributors
      • Introduction
      • Language
      • Best Practices
        • #1: The problem always comes first
        • #2: The problem has to exist
        • #3: The problem has to be complex or frequent
        • #4: The solution must be discussed with others
        • #5: To each problem, its own solution
        • #6: Cater to common use cases, leave the door open for the rare ones
        • #7: Solutions must be local
        • #8: Don't use complex canned solutions for simple problems
    • 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
      • The interactive rebase
      • Deleting a Git branch
    • Bisecting regressions
      • What is bisecting?
      • Using official builds to speed up bisecting
      • The Git bisect command
    • Code style guidelines
      • C++ and Objective-C
        • Using clang-format locally
        • Header includes
      • Java
      • Python
    • Bug triage guidelines
      • Issues management
        • Labels
        • Milestones
    • Documentation guidelines
      • How to contribute
      • The 'Edit on GitHub' link
      • What makes good documentation?
      • Titles
      • Translating existing pages
      • License
    • Docs writing guidelines
      • 7 rules for clear English
        • Use the direct voice
        • Use precise action verbs
        • Avoid verbs that end in -ing
        • Remove unnecessary adverbs and adjectives
        • Ban these 8 words
        • Use explicit references
        • Use 's to show possession
        • Use the Oxford comma to enumerate anything
      • How to write methods and classes
        • Dynamic vs static typing
        • Use real-world code examples where appropriate
        • Give an overview of the node in the brief description
        • Mention what methods return if it's useful
        • Use "if true" to describe booleans
        • Use [code] around arguments
      • Common vocabulary to use in Godot's documentation
      • Keyboard shortcut guidelines
      • Image contribution guidelines
    • Contributing to the class reference
      • How to contribute
      • Get started with GitHub
        • Fork Godot
        • How to keep your local clone up-to-date
        • Updating the documentation template
        • Push and request a pull of your changes
      • How to edit class XML
        • How to write the class reference
        • Improve formatting with BBCode style tags
        • I don't know what this method does!
        • Localization
    • Editor and docs localization
      • Using Weblate for translations
        • Adding a new language
        • Translation interface
      • Locating original content
      • Respecting the markup syntax
        • Editor interface (C++)
        • Online documentation (RST)
        • Class reference (BBCode)
      • Offline translation and testing
      • Localizing documentation images
  • Community channels
    • Q&A
    • IRC on Freenode
    • Other chats
    • Language-based communities
    • Social networks
    • Forum
  • Tutorials and resources
    • Where to start
    • Video tutorials
    • Text tutorials
    • Devlogs
    • Resources

Class reference

  • Godot API
    • @C#
    • @GDScript
      • Description
      • Methods
      • Constants
      • Method Descriptions
    • @GlobalScope
      • Description
      • Properties
      • Enumerations
      • Constants
      • Property Descriptions
    • @NativeScript
    • @VisualScript
      • Description
    • AABB
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • AcceptDialog
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • AnimatedSprite
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • AnimatedSprite3D
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • AnimatedTexture
      • Description
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Animation
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AnimationNode
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AnimationNodeAdd2
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AnimationNodeAdd3
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AnimationNodeAnimation
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AnimationNodeBlend2
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AnimationNodeBlend3
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AnimationNodeBlendSpace1D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • AnimationNodeBlendSpace2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AnimationNodeBlendTree
      • Description
      • Tutorials
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • AnimationNodeOneShot
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AnimationNodeOutput
      • Tutorials
    • AnimationNodeStateMachine
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • AnimationNodeStateMachinePlayback
      • Description
      • Tutorials
      • Properties
      • Methods
      • Method Descriptions
    • AnimationNodeStateMachineTransition
      • Tutorials
      • Properties
      • Signals
      • Enumerations
      • Property Descriptions
    • AnimationNodeTimeScale
      • Description
      • Tutorials
    • AnimationNodeTimeSeek
      • Description
      • Tutorials
    • AnimationNodeTransition
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • AnimationPlayer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AnimationRootNode
    • AnimationTrackEditPlugin
    • AnimationTree
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Area
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Area2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Array
      • Description
      • Methods
      • Method Descriptions
    • ArrayMesh
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • ARVRAnchor
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • ARVRCamera
      • Description
      • Tutorials
    • ARVRController
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • ARVRInterface
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ARVRInterfaceGDNative
      • Description
    • ARVROrigin
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • ARVRPositionalTracker
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ARVRServer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AStar
      • Description
      • Methods
      • Method Descriptions
    • AStar2D
      • Description
      • Methods
      • Method Descriptions
    • AtlasTexture
      • Description
      • Properties
      • Property Descriptions
    • AudioBusLayout
      • Description
    • AudioEffect
      • Description
    • AudioEffectAmplify
      • Description
      • Properties
      • Property Descriptions
    • AudioEffectBandLimitFilter
      • Description
    • AudioEffectBandPassFilter
      • Description
    • AudioEffectChorus
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • AudioEffectCompressor
      • Description
      • Properties
      • Property Descriptions
    • AudioEffectDelay
      • Description
      • Properties
      • Property Descriptions
    • AudioEffectDistortion
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • AudioEffectEQ
      • Description
      • Methods
      • Method Descriptions
    • AudioEffectEQ10
      • Description
    • AudioEffectEQ21
      • Description
    • AudioEffectEQ6
      • Description
    • AudioEffectFilter
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • AudioEffectHighPassFilter
      • Description
    • AudioEffectHighShelfFilter
    • AudioEffectInstance
    • AudioEffectLimiter
      • Description
      • Properties
      • Property Descriptions
    • AudioEffectLowPassFilter
      • Description
    • AudioEffectLowShelfFilter
    • AudioEffectNotchFilter
      • Description
    • AudioEffectPanner
      • Description
      • Properties
      • Property Descriptions
    • AudioEffectPhaser
      • Description
      • Properties
      • Property Descriptions
    • AudioEffectPitchShift
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • AudioEffectRecord
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • AudioEffectReverb
      • Description
      • Properties
      • Property Descriptions
    • AudioEffectSpectrumAnalyzer
      • Properties
      • Enumerations
      • Property Descriptions
    • AudioEffectSpectrumAnalyzerInstance
      • Methods
      • Enumerations
      • Method Descriptions
    • AudioEffectStereoEnhance
      • Properties
      • Property Descriptions
    • AudioServer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AudioStream
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • AudioStreamGenerator
      • Tutorials
      • Properties
      • Property Descriptions
    • AudioStreamGeneratorPlayback
      • Tutorials
      • Methods
      • Method Descriptions
    • AudioStreamMicrophone
    • AudioStreamOGGVorbis
      • Description
      • Properties
      • Property Descriptions
    • AudioStreamPlayback
      • Description
    • AudioStreamPlaybackResampled
    • AudioStreamPlayer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AudioStreamPlayer2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • AudioStreamPlayer3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AudioStreamRandomPitch
      • Description
      • Properties
      • Property Descriptions
    • AudioStreamSample
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • BackBufferCopy
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • BaseButton
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • BaseMaterial3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Basis
      • Description
      • Tutorials
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • BitMap
      • Description
      • Methods
      • Method Descriptions
    • BitmapFont
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Bone2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • BoneAttachment
      • Description
      • Properties
      • Property Descriptions
    • bool
      • Description
      • Methods
      • Method Descriptions
    • BoxContainer
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • BoxShape
      • Description
      • Properties
      • Property Descriptions
    • BulletPhysicsDirectBodyState
    • BulletPhysicsServer
    • Button
      • Description
      • Properties
      • Theme Properties
      • Enumerations
      • Property Descriptions
    • ButtonGroup
      • Description
      • Properties
      • Methods
      • Method Descriptions
    • Callable
      • Description
      • Methods
      • Method Descriptions
    • Camera
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Camera2D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CameraEffects
      • Properties
      • Property Descriptions
    • CameraFeed
      • Description
    • CameraServer
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • CameraTexture
      • Description
      • Properties
      • Property Descriptions
    • CanvasItem
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • CanvasItemMaterial
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • CanvasLayer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • CanvasModulate
      • Description
      • Properties
      • Property Descriptions
    • CapsuleMesh
      • Description
      • Properties
      • Property Descriptions
    • CapsuleShape
      • Description
      • Properties
      • Property Descriptions
    • CapsuleShape2D
      • Description
      • Properties
      • Property Descriptions
    • CenterContainer
      • Description
      • Properties
      • Property Descriptions
    • CharFXTransform
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • CheckBox
      • Description
      • Properties
      • Theme Properties
    • CheckButton
      • Description
      • Properties
      • Theme Properties
    • CircleShape2D
      • Description
      • Properties
      • Property Descriptions
    • ClassDB
      • Description
      • Methods
      • Method Descriptions
    • ClippedCamera
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CollisionObject
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • CollisionObject2D
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • CollisionPolygon
      • Description
      • Properties
      • Property Descriptions
    • CollisionPolygon2D
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • CollisionShape
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • CollisionShape2D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • Color
      • Description
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • ColorPicker
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
    • ColorPickerButton
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
    • ColorRect
      • Description
      • Properties
      • Property Descriptions
    • ConcavePolygonShape
      • Description
      • Methods
      • Method Descriptions
    • ConcavePolygonShape2D
      • Description
      • Properties
      • Property Descriptions
    • ConeTwistJoint
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ConfigFile
      • Description
      • Methods
      • Method Descriptions
    • ConfirmationDialog
      • Description
      • Properties
      • Methods
      • Method Descriptions
    • Container
      • Description
      • Properties
      • Methods
      • Signals
      • Constants
      • Method Descriptions
    • Control
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • ConvexPolygonShape
      • Description
      • Properties
      • Property Descriptions
    • ConvexPolygonShape2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • CPUParticles
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CPUParticles2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Crypto
      • Description
      • Methods
      • Method Descriptions
    • CryptoKey
      • Description
      • Methods
      • Method Descriptions
    • CSGBox
      • Description
      • Properties
      • Property Descriptions
    • CSGCombiner
      • Description
    • CSGCylinder
      • Description
      • Properties
      • Property Descriptions
    • CSGMesh
      • Description
      • Properties
      • Property Descriptions
    • CSGPolygon
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • CSGPrimitive
      • Description
      • Properties
      • Property Descriptions
    • CSGShape
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CSGSphere
      • Description
      • Properties
      • Property Descriptions
    • CSGTorus
      • Description
      • Properties
      • Property Descriptions
    • CSharpScript
      • Methods
      • Method Descriptions
    • Cubemap
    • CubemapArray
    • CubeMesh
      • Description
      • Properties
      • Property Descriptions
    • Curve
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Curve2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Curve3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • CurveTexture
      • Description
      • Properties
      • Property Descriptions
    • CylinderMesh
      • Description
      • Properties
      • Property Descriptions
    • CylinderShape
      • Description
      • Properties
      • Property Descriptions
    • DampedSpringJoint2D
      • Description
      • Properties
      • Property Descriptions
    • Dictionary
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • DirectionalLight
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • Directory
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • DTLSServer
      • Description
      • Methods
      • Method Descriptions
    • DynamicFont
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • DynamicFontData
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • EditorExportPlugin
      • Methods
      • Method Descriptions
    • EditorFeatureProfile
      • Methods
      • Enumerations
      • Method Descriptions
    • EditorFileDialog
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • EditorFileSystem
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • EditorFileSystemDirectory
      • Description
      • Methods
      • Method Descriptions
    • EditorImportPlugin
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • EditorInspector
      • Description
      • Properties
      • Methods
      • Signals
      • Method Descriptions
    • EditorInspectorPlugin
      • Description
      • Methods
      • Method Descriptions
    • EditorInterface
      • Description
      • Methods
      • Method Descriptions
    • EditorPlugin
      • Description
      • Tutorials
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • EditorProperty
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • EditorResourceConversionPlugin
      • Methods
      • Method Descriptions
    • EditorResourcePreview
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • EditorResourcePreviewGenerator
      • Description
      • Methods
      • Method Descriptions
    • EditorSceneImporter
      • Methods
      • Constants
      • Method Descriptions
    • EditorSceneImporterAssimp
      • Description
    • EditorScenePostImport
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • EditorScript
      • Description
      • Methods
      • Method Descriptions
    • EditorSelection
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • EditorSettings
      • Description
      • Methods
      • Signals
      • Constants
      • Method Descriptions
    • EditorSpatialGizmo
      • Description
      • Methods
      • Method Descriptions
    • EditorSpatialGizmoPlugin
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • EditorSpinSlider
      • Properties
      • Property Descriptions
    • EditorVCSInterface
      • Description
      • Methods
      • Method Descriptions
    • EncodedObjectAsID
      • Description
      • Properties
      • Property Descriptions
    • Engine
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Environment
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Expression
      • Description
      • Methods
      • Method Descriptions
    • File
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • FileDialog
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • FileSystemDock
      • Methods
      • Signals
      • Method Descriptions
    • float
      • Description
      • Methods
      • Method Descriptions
    • Font
      • Description
      • Methods
      • Method Descriptions
    • FuncRef
      • Description
      • Methods
      • Method Descriptions
    • GDNative
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • GDNativeLibrary
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • GDScript
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • GDScriptFunctionState
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • GDScriptNativeClass
      • Methods
      • Method Descriptions
    • Generic6DOFJoint
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Geometry
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • GeometryInstance
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • GIProbe
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • GIProbeData
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • GodotSharp
      • Methods
      • Method Descriptions
    • Gradient
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • GradientTexture
      • Description
      • Properties
      • Property Descriptions
    • GraphEdit
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
    • GraphNode
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • GridContainer
      • Description
      • Properties
      • Theme Properties
      • Property Descriptions
    • GridMap
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Constants
      • Property Descriptions
      • Method Descriptions
    • GrooveJoint2D
      • Description
      • Properties
      • Property Descriptions
    • HashingContext
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • HBoxContainer
      • Description
      • Theme Properties
    • HeightMapShape
      • Description
      • Properties
      • Property Descriptions
    • HingeJoint
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • HScrollBar
      • Description
      • Theme Properties
    • HSeparator
      • Description
      • Theme Properties
    • HSlider
      • Description
      • Theme Properties
    • HSplitContainer
      • Description
      • Theme Properties
    • HTTPClient
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • HTTPRequest
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Image
      • Description
      • Properties
      • Methods
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • ImageTexture
      • Description
      • Methods
      • Method Descriptions
    • ImmediateGeometry
      • Description
      • Methods
      • Method Descriptions
    • Input
      • Description
      • Tutorials
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • InputDefault
      • Description
    • InputEvent
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • InputEventAction
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • InputEventGesture
      • Properties
      • Property Descriptions
    • InputEventJoypadButton
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • InputEventJoypadMotion
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • InputEventKey
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • InputEventMagnifyGesture
      • Properties
      • Property Descriptions
    • InputEventMIDI
      • Properties
      • Property Descriptions
    • InputEventMouse
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • InputEventMouseButton
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • InputEventMouseMotion
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • InputEventPanGesture
      • Properties
      • Property Descriptions
    • InputEventScreenDrag
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • InputEventScreenTouch
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • InputEventWithModifiers
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • InputMap
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • InstancePlaceholder
      • Description
      • Methods
      • Method Descriptions
    • int
      • Description
      • Methods
      • Method Descriptions
    • InterpolatedCamera
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • IP
      • Description
      • Methods
      • Enumerations
      • Constants
      • Method Descriptions
    • IP_Unix
      • Description
    • ItemList
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • JavaClass
    • JavaClassWrapper
      • Methods
      • Method Descriptions
    • JavaScript
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • Joint
      • Description
      • Properties
      • Property Descriptions
    • Joint2D
      • Description
      • Properties
      • Property Descriptions
    • JSON
      • Description
      • Methods
      • Method Descriptions
    • JSONParseResult
      • Description
      • Properties
      • Property Descriptions
    • JSONRPC
      • Methods
      • Enumerations
      • Method Descriptions
    • KinematicBody
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • KinematicBody2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • KinematicCollision
      • Description
      • Properties
      • Property Descriptions
    • KinematicCollision2D
      • Description
      • Properties
      • Property Descriptions
    • Label
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • LargeTexture
      • Description
      • Methods
      • Method Descriptions
    • Light
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Light2D
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • LightOccluder2D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • Line2D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • LineEdit
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • LineShape2D
      • Description
      • Properties
      • Property Descriptions
    • LinkButton
      • Description
      • Properties
      • Theme Properties
      • Enumerations
      • Property Descriptions
    • Listener
      • Description
      • Methods
      • Method Descriptions
    • MainLoop
      • Description
      • Methods
      • Signals
      • Constants
      • Method Descriptions
    • MarginContainer
      • Description
      • Theme Properties
    • Marshalls
      • Description
      • Methods
      • Method Descriptions
    • Material
      • Description
      • Properties
      • Constants
      • Property Descriptions
    • MenuButton
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
    • Mesh
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • MeshDataTool
      • Description
      • Methods
      • Method Descriptions
    • MeshInstance
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • MeshInstance2D
      • Description
      • Tutorials
      • Properties
      • Signals
      • Property Descriptions
    • MeshLibrary
      • Description
      • Methods
      • Method Descriptions
    • MeshTexture
      • Description
      • Properties
      • Property Descriptions
    • MobileVRInterface
      • Description
      • Properties
      • Property Descriptions
    • MonoGCHandle
    • MultiMesh
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • MultiMeshInstance
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • MultiMeshInstance2D
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • MultiplayerAPI
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • MultiplayerPeerGDNative
    • Mutex
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • NativeScript
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Navigation
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Navigation2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Navigation2DServer
      • Description
      • Methods
      • Method Descriptions
    • NavigationAgent
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • NavigationAgent2D
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • NavigationMesh
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • NavigationMeshGenerator
      • Methods
      • Method Descriptions
    • NavigationObstacle
      • Description
      • Methods
      • Method Descriptions
    • NavigationObstacle2D
      • Description
      • Methods
      • Method Descriptions
    • NavigationPolygon
      • Description
      • Methods
      • Method Descriptions
    • NavigationRegion
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • NavigationRegion2D
      • Properties
      • Property Descriptions
    • NavigationServer
      • Description
      • Methods
      • Method Descriptions
    • NetworkedMultiplayerENet
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • NetworkedMultiplayerPeer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • NinePatchRect
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Node
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Node2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • NodePath
      • Description
      • Methods
      • Method Descriptions
    • NoiseTexture
      • Description
      • Properties
      • Property Descriptions
    • Object
      • Description
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Method Descriptions
    • OccluderPolygon2D
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • OmniLight
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • OpenSimplexNoise
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OptionButton
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
    • ORMMaterial3D
    • OS
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PackedByteArray
      • Description
      • Methods
      • Method Descriptions
    • PackedColorArray
      • Description
      • Methods
      • Method Descriptions
    • PackedDataContainer
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PackedDataContainerRef
      • Methods
      • Method Descriptions
    • PackedFloat32Array
      • Description
      • Methods
      • Method Descriptions
    • PackedFloat64Array
      • Description
      • Methods
      • Method Descriptions
    • PackedInt32Array
      • Description
      • Methods
      • Method Descriptions
    • PackedInt64Array
      • Description
      • Methods
      • Method Descriptions
    • PackedScene
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PackedStringArray
      • Description
      • Methods
      • Method Descriptions
    • PackedVector2Array
      • Description
      • Methods
      • Method Descriptions
    • PackedVector3Array
      • Description
      • Methods
      • Method Descriptions
    • PacketPeer
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PacketPeerDTLS
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • PacketPeerGDNative
    • PacketPeerStream
      • Description
      • Properties
      • Property Descriptions
    • PacketPeerUDP
      • Description
      • Methods
      • Method Descriptions
    • Panel
      • Description
      • Theme Properties
    • PanelContainer
      • Description
      • Properties
      • Theme Properties
    • PanoramaSkyMaterial
      • Description
      • Properties
      • Property Descriptions
    • ParallaxBackground
      • Description
      • Properties
      • Property Descriptions
    • ParallaxLayer
      • Description
      • Properties
      • Property Descriptions
    • Particles
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Particles2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ParticlesMaterial
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Path
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • Path2D
      • Description
      • Properties
      • Property Descriptions
    • PathFollow
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • PathFollow2D
      • Description
      • Properties
      • Property Descriptions
    • PCKPacker
      • Description
      • Methods
      • Method Descriptions
    • Performance
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • PHashTranslation
      • Description
      • Methods
      • Method Descriptions
    • PhysicalBone
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PhysicalSkyMaterial
      • Description
      • Properties
      • Property Descriptions
    • Physics2DDirectBodyState
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Physics2DDirectBodyStateSW
      • Description
    • Physics2DDirectSpaceState
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • Physics2DServer
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • Physics2DServerSW
      • Description
    • Physics2DShapeQueryParameters
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Physics2DShapeQueryResult
      • Description
      • Methods
      • Method Descriptions
    • Physics2DTestMotionResult
      • Properties
      • Property Descriptions
    • PhysicsBody
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PhysicsBody2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PhysicsDirectBodyState
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PhysicsDirectSpaceState
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • PhysicsMaterial
      • Description
      • Properties
      • Property Descriptions
    • PhysicsServer
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • PhysicsShapeQueryParameters
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PhysicsShapeQueryResult
      • Description
      • Methods
      • Method Descriptions
    • PinJoint
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PinJoint2D
      • Description
      • Properties
      • Property Descriptions
    • Plane
      • Description
      • Tutorials
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • PlaneMesh
      • Description
      • Properties
      • Property Descriptions
    • PluginScript
      • Methods
      • Method Descriptions
    • PointMesh
      • Description
    • Polygon2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PolygonPathFinder
      • Methods
      • Method Descriptions
    • Popup
      • Description
      • Properties
      • Methods
      • Signals
      • Constants
      • Property Descriptions
      • Method Descriptions
    • PopupDialog
      • Description
      • Theme Properties
    • PopupMenu
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
    • PopupPanel
      • Description
      • Theme Properties
    • Position2D
      • Description
    • Position3D
      • Description
    • PrimitiveMesh
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PrismMesh
      • Description
      • Properties
      • Property Descriptions
    • ProceduralSkyMaterial
      • Description
      • Properties
      • Property Descriptions
    • ProgressBar
      • Description
      • Properties
      • Theme Properties
      • Property Descriptions
    • ProjectSettings
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ProximityGroup
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ProxyTexture
      • Properties
      • Property Descriptions
    • QuadMesh
      • Description
      • Properties
      • Property Descriptions
    • Quat
      • Description
      • Tutorials
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • RandomNumberGenerator
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Range
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • RayCast
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RayCast2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RayShape
      • Description
      • Properties
      • Property Descriptions
    • RayShape2D
      • Description
      • Properties
      • Property Descriptions
    • Rect2
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Rect2i
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • RectangleShape2D
      • Description
      • Properties
      • Property Descriptions
    • Reference
      • Description
      • Methods
      • Method Descriptions
    • ReferenceRect
      • Description
      • Properties
      • Property Descriptions
    • ReflectionProbe
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • RegEx
      • Description
      • Methods
      • Method Descriptions
    • RegExMatch
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RemoteTransform
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RemoteTransform2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RenderingDevice
    • Resource
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • ResourceFormatLoader
      • Description
      • Methods
      • Method Descriptions
    • ResourceFormatLoaderCrypto
    • ResourceFormatSaver
      • Description
      • Methods
      • Method Descriptions
    • ResourceFormatSaverCrypto
    • ResourceImporter
    • ResourceLoader
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • ResourcePreloader
      • Description
      • Methods
      • Method Descriptions
    • ResourceSaver
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • RichTextEffect
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • RichTextLabel
      • Description
      • Tutorials
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • RID
      • Description
      • Methods
      • Method Descriptions
    • RigidBody
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • RigidBody2D
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • RootMotionView
      • Properties
      • Property Descriptions
    • SceneState
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • SceneTree
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SceneTreeTimer
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • Script
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ScriptCreateDialog
      • Description
      • Properties
      • Methods
      • Signals
      • Method Descriptions
    • ScriptEditor
      • Methods
      • Signals
      • Method Descriptions
    • ScrollBar
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • ScrollContainer
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
    • SegmentShape2D
      • Description
      • Properties
      • Property Descriptions
    • Semaphore
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • Separator
      • Description
    • Shader
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ShaderMaterial
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Shape
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • Shape2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ShortCut
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Signal
      • Methods
      • Method Descriptions
    • Skeleton
      • Description
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Skeleton2D
      • Description
      • Tutorials
      • Methods
      • Signals
      • Method Descriptions
    • SkeletonIK
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Skin
      • Methods
      • Method Descriptions
    • SkinReference
      • Methods
      • Method Descriptions
    • Sky
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • Slider
      • Description
      • Properties
      • Property Descriptions
    • SliderJoint
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SoftBody
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Spatial
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Constants
      • Property Descriptions
      • Method Descriptions
    • SpatialGizmo
    • SpatialVelocityTracker
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • SphereMesh
      • Description
      • Properties
      • Property Descriptions
    • SphereShape
      • Description
      • Properties
      • Property Descriptions
    • SpinBox
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Property Descriptions
      • Method Descriptions
    • SplitContainer
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SpotLight
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • SpringArm
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Sprite
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • Sprite3D
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • SpriteBase3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SpriteFrames
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • StandardMaterial3D
    • StaticBody
      • Description
      • Properties
      • Property Descriptions
    • StaticBody2D
      • Description
      • Properties
      • Property Descriptions
    • StreamPeer
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • StreamPeerBuffer
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • StreamPeerGDNative
    • StreamPeerSSL
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • StreamPeerTCP
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • StreamTexture
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • String
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • StringName
      • Description
      • Methods
      • Method Descriptions
    • StyleBox
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • StyleBoxEmpty
      • Description
    • StyleBoxFlat
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • StyleBoxLine
      • Description
      • Properties
      • Property Descriptions
    • StyleBoxTexture
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SurfaceTool
      • Description
      • Methods
      • Method Descriptions
    • TabContainer
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Tabs
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • TCP_Server
      • Description
      • Methods
      • Method Descriptions
    • TextEdit
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • TextFile
    • Texture
    • Texture2D
      • Description
      • Methods
      • Method Descriptions
    • Texture2DArray
    • TextureButton
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • TextureLayered
      • Description
      • Methods
      • Method Descriptions
    • TextureProgress
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • TextureRect
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • Theme
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Thread
      • Description
      • Tutorials
      • Methods
      • Enumerations
      • Method Descriptions
    • TileMap
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • TileSet
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • Timer
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ToolButton
      • Description
      • Properties
      • Theme Properties
    • TouchScreenButton
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Transform
      • Description
      • Tutorials
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Transform2D
      • Description
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Translation
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • TranslationServer
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • Tree
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • TreeItem
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • TriangleMesh
      • Description
    • Tween
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • UDPServer
      • Description
      • Methods
      • Method Descriptions
    • UndoRedo
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • UPNP
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • UPNPDevice
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Variant
      • Description
      • Tutorials
    • VBoxContainer
      • Description
      • Theme Properties
    • Vector2
      • Description
      • Tutorials
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Vector2i
      • Description
      • Tutorials
      • Methods
      • Constants
      • Method Descriptions
    • Vector3
      • Description
      • Tutorials
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Vector3i
      • Description
      • Tutorials
      • Methods
      • Constants
      • Method Descriptions
    • VehicleBody
      • Description
      • Properties
      • Property Descriptions
    • VehicleWheel
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • VideoPlayer
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • VideoStream
      • Description
    • VideoStreamGDNative
      • Description
      • Methods
      • Method Descriptions
    • VideoStreamTheora
      • Description
      • Methods
      • Method Descriptions
    • VideoStreamWebm
      • Description
      • Methods
      • Method Descriptions
    • Viewport
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ViewportContainer
      • Description
      • Properties
      • Property Descriptions
    • ViewportTexture
      • Description
      • Properties
      • Property Descriptions
    • VisibilityEnabler
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • VisibilityEnabler2D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • VisibilityNotifier
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • VisibilityNotifier2D
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • VisualInstance
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • VisualScript
      • Description
      • Tutorials
      • Methods
      • Signals
      • Method Descriptions
    • VisualScriptBasicTypeConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptBuiltinFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualScriptClassConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptComment
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptComposeArray
      • Description
    • VisualScriptCondition
      • Description
    • VisualScriptConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptConstructor
      • Description
      • Methods
      • Method Descriptions
    • VisualScriptCustomNode
      • Description
      • Methods
      • Enumerations
      • Constants
      • Method Descriptions
    • VisualScriptDeconstruct
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptEditor
      • Methods
      • Signals
      • Method Descriptions
    • VisualScriptEmitSignal
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptEngineSingleton
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptExpression
    • VisualScriptFunction
    • VisualScriptFunctionCall
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualScriptFunctionState
      • Methods
      • Method Descriptions
    • VisualScriptGlobalConstant
      • Properties
      • Property Descriptions
    • VisualScriptIndexGet
    • VisualScriptIndexSet
    • VisualScriptInputAction
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualScriptIterator
      • Description
    • VisualScriptLists
      • Description
      • Methods
      • Method Descriptions
    • VisualScriptLocalVar
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptLocalVarSet
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptMathConstant
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualScriptNode
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • VisualScriptOperator
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptPreload
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptPropertyGet
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualScriptPropertySet
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualScriptResourcePath
      • Properties
      • Property Descriptions
    • VisualScriptReturn
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptSceneNode
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptSceneTree
    • VisualScriptSelect
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptSelf
      • Description
    • VisualScriptSequence
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptSubCall
      • Methods
      • Method Descriptions
    • VisualScriptSwitch
      • Description
    • VisualScriptTypeCast
      • Properties
      • Property Descriptions
    • VisualScriptVariableGet
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptVariableSet
      • Description
      • Properties
      • Property Descriptions
    • VisualScriptWhile
      • Description
    • VisualScriptYield
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualScriptYieldSignal
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualServer
      • Description
      • Tutorials
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Method Descriptions
    • VisualShader
      • Description
      • Properties
      • Methods
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • VisualShaderNode
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • VisualShaderNodeBooleanConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeBooleanUniform
      • Description
    • VisualShaderNodeColorConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeColorFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeColorOp
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeColorUniform
      • Description
    • VisualShaderNodeCompare
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeCubemap
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeCubemapUniform
      • Description
    • VisualShaderNodeCustom
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • VisualShaderNodeDeterminant
      • Description
    • VisualShaderNodeDotProduct
      • Description
    • VisualShaderNodeExpression
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeFaceForward
      • Description
    • VisualShaderNodeFloatConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeFloatFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeFloatOp
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeFloatUniform
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeFresnel
      • Description
    • VisualShaderNodeGlobalExpression
      • Description
    • VisualShaderNodeGroupBase
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • VisualShaderNodeIf
      • Description
    • VisualShaderNodeInput
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • VisualShaderNodeIntConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeIntFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeIntOp
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeIntUniform
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeIs
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeOuterProduct
    • VisualShaderNodeOutput
    • VisualShaderNodeScalarClamp
    • VisualShaderNodeScalarDerivativeFunc
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeScalarInterp
    • VisualShaderNodeScalarSmoothStep
    • VisualShaderNodeScalarSwitch
    • VisualShaderNodeSwitch
    • VisualShaderNodeTexture
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeTextureUniform
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeTextureUniformTriplanar
    • VisualShaderNodeTransformCompose
    • VisualShaderNodeTransformConstant
      • Properties
      • Property Descriptions
    • VisualShaderNodeTransformDecompose
    • VisualShaderNodeTransformFunc
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeTransformMult
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeTransformUniform
    • VisualShaderNodeTransformVecMult
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeUniform
      • Properties
      • Property Descriptions
    • VisualShaderNodeVec3Constant
      • Properties
      • Property Descriptions
    • VisualShaderNodeVec3Uniform
    • VisualShaderNodeVectorClamp
    • VisualShaderNodeVectorCompose
    • VisualShaderNodeVectorDecompose
    • VisualShaderNodeVectorDerivativeFunc
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeVectorDistance
    • VisualShaderNodeVectorFunc
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeVectorInterp
    • VisualShaderNodeVectorLen
    • VisualShaderNodeVectorOp
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeVectorRefract
    • VisualShaderNodeVectorScalarMix
    • VisualShaderNodeVectorScalarSmoothStep
    • VisualShaderNodeVectorScalarStep
    • VisualShaderNodeVectorSmoothStep
    • VScrollBar
      • Description
      • Properties
      • Theme Properties
    • VSeparator
      • Description
      • Theme Properties
    • VSlider
      • Description
      • Properties
      • Theme Properties
    • VSplitContainer
      • Description
      • Theme Properties
    • WeakRef
      • Description
      • Methods
      • Method Descriptions
    • WebRTCDataChannel
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • WebRTCDataChannelGDNative
    • WebRTCMultiplayer
      • Description
      • Properties
      • Methods
      • Method Descriptions
    • WebRTCPeerConnection
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • WebRTCPeerConnectionGDNative
    • WebSocketClient
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • WebSocketMultiplayerPeer
      • Description
      • Properties
      • Methods
      • Signals
      • Method Descriptions
    • WebSocketPeer
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • WebSocketServer
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • WindowDialog
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Property Descriptions
      • Method Descriptions
    • World
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • World2D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • WorldEnvironment
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • WorldMarginShape
      • Description
      • Properties
      • Property Descriptions
    • X509Certificate
      • Description
      • Methods
      • Method Descriptions
    • XMLParser
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • YSort
      • Description
      • Properties
      • Property Descriptions
Godot Engine
  • Docs »
  • 3D
  • Edit on GitHub

3DΒΆ

  • Introduction to 3D
  • Using 3D transforms
  • Optimizing 3D performance
  • 3D rendering limitations
  • Standard Material 3D
  • 3D lights and shadows
  • Reflection probes
  • GI Probes
  • Baked lightmaps
  • Environment and post-processing
  • Light transport in game engines
  • Using gridmaps
  • Using MultiMeshInstance
  • CSG
  • FPS tutorial
  • Animating thousands of objects
Next Previous

© Copyright 2014-2020, Juan Linietsky, Ariel Manzur and the Godot community (CC-BY 3.0) Revision 9252df6d.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
3.2
3.1
3.0
2.1
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by Read the Docs.