Logo
latest

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 3D model formats does Godot support?
    • Will [insert closed SDK such as FMOD, GameWorks, etc.] be supported in Godot?
    • How do I install the Godot editor on my system (for desktop integration)?
      • Windows
      • macOS
      • Linux
    • Is the Godot editor a portable application?
    • Why does Godot use Vulkan or OpenGL instead of Direct3D?
    • Why does Godot aim to keep its core feature set small?
    • How should assets be created to handle multiple resolutions and aspect ratios?
    • How can I extend Godot?
    • When is the next release of Godot out?
    • 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 to create non-game applications?
    • Is it possible to use Godot as a library?
    • What user interface toolkit does Godot use?
    • Why does Godot not use STL (Standard Template Library)?
    • Why does Godot not use exceptions?
    • Why does Godot not enforce RTTI?
    • Does Godot use an ECS (Entity Component System)?
    • 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?
  • Troubleshooting
    • Everything I do in the editor or project manager appears delayed by one frame.
    • The editor runs slowly and uses all my CPU and GPU resources, making my computer noisy.
    • The editor stutters and flickers on my variable refresh rate monitor (G-Sync/FreeSync).
    • The grid disappears and meshes turn black when I rotate the 3D camera in the editor.
    • The editor or project takes a very long time to start.
    • Editor tooltips in the Inspector and Node docks blink when they're displayed.
    • The Godot editor appears frozen after clicking the system console.
    • Some text such as "NO DC" appears in the top-left corner of the project manager and editor window.
    • The project window appears blurry, unlike the editor.
    • The project window doesn't appear centered when I run the project.
    • The project works when run from the editor, but fails to load some files when running from an exported copy.
  • 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
      • File formats
      • Miscellaneous
  • Documentation changelog
    • New pages since version 3.3
      • C++
      • GDScript
    • New pages since version 3.2
      • 3D
      • About
      • Best practices
      • Community
      • Development
      • Editor
      • Export
      • Input
      • Math
      • Platform-specific
      • Physics
      • Shaders
      • Scripting
      • User Interface (UI)
    • New pages since version 3.1
      • Project workflow
      • 2D
      • Audio
      • Math
      • Inputs
      • Internationalization
      • Shading
      • Networking
      • Plugins
      • Multi-threading
      • Creating content
      • Optimization
      • Legal
    • New pages 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?
  • Complying with licenses
    • What are licenses?
    • Requirements
    • Inclusion
      • Credits screen
      • Licenses screen
      • Output log
      • Accompanying file
      • Printed manual
      • Link to the license
    • Third-party licenses
      • FreeType
      • ENet
      • mbed TLS

Getting started

  • Introduction
    • Introduction to Godot
      • What is Godot?
      • What can the engine do?
      • How does it work and look?
      • Programming languages
      • What do I need to know to use Godot?
    • Overview of Godot's key concepts
      • Scenes
      • Nodes
      • The scene tree
      • Signals
      • Summary
    • First look at Godot's editor
      • The Project manager
      • First look at Godot's editor
      • The four main screens
      • Integrated class reference
    • Learning new features
      • Making the most of this manual
      • Learning to think like a programmer
      • Learning with the community
      • Community tutorials
    • 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
  • Step by step
    • Nodes and Scenes
      • Nodes
      • Scenes
      • Creating your first scene
      • Changing a node's properties
      • Running the scene
      • Setting the main scene
    • Creating instances
      • In practice
      • Editing scenes and instances
      • Scene instances as a design language
      • Summary
    • Scripting languages
      • Available scripting languages
      • Which language should I use?
        • GDScript
        • .NET / C#
        • C and C++ via GDExtension
      • Summary
    • Creating your first script
      • Project setup
      • Creating a new script
      • Hello, world!
      • Turning around
        • Moving forward
      • Complete script
    • Listening to player input
      • Moving when pressing "up"
      • Complete script
      • Summary
    • Using signals
      • Scene setup
      • Connecting a signal in the editor
      • Connecting a signal via code
      • Complete script
      • Custom signals
      • Summary
  • Your first 2D game
    • Prerequisites
    • Contents
      • Setting up the project
        • Organizing the project
      • Creating the player scene
        • Node structure
        • Sprite animation
      • Coding the player
        • Choosing animations
        • Preparing for collisions
      • Creating the enemy
        • Node setup
        • Enemy script
      • The main game scene
        • Spawning mobs
        • Main script
        • Testing the scene
      • Heads up display
        • ScoreLabel
        • Message
        • StartButton
        • Connecting HUD to Main
        • Removing old creeps
      • Finishing up
        • Background
        • Sound effects
        • Keyboard shortcut
  • Your first 3D game
    • Contents
      • Setting up the game area
        • Setting up the playable area
      • Player scene and input actions
        • Creating input actions
      • Moving the player with code
        • Testing our player's movement
      • Designing the mob scene
        • Removing monsters off-screen
      • Spawning monsters
        • Creating the spawn path
        • Spawning monsters randomly
      • Jumping and squashing monsters
        • Controlling physics interactions
        • Jumping
        • Squashing monsters
      • Killing the player
        • Hitbox with the Area node
        • Ending the game
        • Code checkpoint
      • Score and replay
        • Creating a UI theme
        • Keeping track of the score
        • Retrying the game
        • Adding music
      • Character animation
        • Using the animation editor
        • The float animation
        • Animating the mobs
      • Going further
        • Exploring the manual

Manual

  • Best practices
    • Introduction
    • Applying object-oriented principles in Godot
      • How scripts work in the engine
      • Scenes
    • Scene organization
      • How to build relationships effectively
      • Choosing a node tree structure
    • When to use scenes versus scripts
      • Anonymous types
      • Named types
      • Performance of Script vs PackedScene
      • 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. AnimatedSprite2D vs. AnimationPlayer vs. AnimationTree
    • Logic preferences
      • Adding nodes and changing properties: which first?
      • Loading vs. preloading
      • Large levels: static vs. dynamic
    • Project organization
      • Introduction
      • Organization
      • Style guide
      • Importing
        • Ignoring specific folders
      • Case sensitivity
    • Version Control Systems
      • Introduction
      • Official Git plugin
      • Files to exclude from VCS
      • Working with Git on Windows
      • Known issues
  • Editor introduction
    • Editor's interface
      • Using the Project manager
        • Creating and importing projects
        • Opening and importing projects
        • Downloading demos and templates
      • The Inspector
        • Overview of the interface
      • Project Settings
      • Default editor shortcuts
        • General Editor Actions
        • 2D / Canvas Item Editor
        • 3D / Spatial Editor
        • Text Editor
        • Script Editor
        • Editor Output
        • Debugger
        • File Dialog
        • FileSystem Dock
        • Scene Tree Dock
        • Animation Track Editor
        • Tile Map Editor
        • Tileset Editor
      • Customizing the interface
        • Moving and resizing docks
    • Web editor
      • Using the Web editor
        • Browser support
        • Limitations
        • Importing a project
        • Editing and running a project
        • Where are my project files?
    • Advanced features
      • 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
        • Using External Editor in Debugger
        • Official editor plugins
    • Managing editor features
      • Managing editor features
        • Introduction
        • Creating a profile
        • Sharing a profile
  • Migrating to a new version
    • Upgrading from Godot 3 to Godot 4
      • Should I upgrade to Godot 4?
        • Advantages of upgrading
        • Disadvantages of upgrading
        • Caveats of upgrading
      • Preparing before the upgrade (optional)
      • Running the project upgrade tool
        • Using the project manager
        • Using the command line
      • Fixing the project after running the project upgrade tool
        • Automatically renamed nodes and resources
        • Manually renaming methods, properties, signals and constants
        • Checking project settings
        • Checking Environment settings
        • Updating external shaders
        • Updating scripts to take backwards-incompatible changes into account
        • ArrayMesh resource compatibility breakage
      • List of automatically renamed methods, properties, signals and constants
      • Porting editor settings
  • 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
        • ParticleProcessMaterial
        • Texture
      • Time parameters
        • Lifetime
        • One Shot
        • Preprocess
        • Speed Scale
        • Explosiveness
        • Randomness
        • Fixed FPS
        • Fract Delta
      • Drawing parameters
        • Visibility Rect
        • Local Coords
        • Draw Order
      • ParticleProcessMaterial settings
        • Direction
        • Spread
        • Flatness
        • 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
      • Nodes
      • Point lights
      • Directional light
      • Common light properties
      • Setting up shadows
        • Automatically generating a light occluder
        • Manually drawing a light occluder
        • Occluder draw order
      • Normal and specular maps
    • 2D meshes
      • Introduction
      • Optimizing pixels drawn
      • Converting Sprite2Ds to 2D meshes
    • Custom drawing in 2D
      • Introduction
      • Drawing
      • Updating
      • Coordinates
      • An example: drawing circular arcs
        • Arc function
        • Draw the arc on the screen
        • Arc polygon function
        • Dynamic custom drawing
        • Antialiased drawing
      • Tools
    • 2D sprite animation
      • Introduction
      • Individual images with AnimatedSprite2D
        • Controlling the animation
      • Sprite sheet with AnimatedSprite2D
      • Sprite sheet with AnimationPlayer
        • Controlling an AnimationPlayer animation
      • Summary
    • 2D antialiasing
      • Introduction
      • Antialiasing property in Line2D and custom drawing
      • Multisample antialiasing (MSAA)
  • 3D
    • Introduction to 3D
      • Node3D 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
    • 3D rendering limitations
      • Introduction
      • Texture size limits
      • Color banding
      • Depth buffer precision
      • Transparency sorting
      • Multi-sample antialiasing
    • Standard Material 3D and ORM Material 3D
      • Introduction
      • BaseMaterial 3D Settings
      • Transparency
        • Blend Mode
        • Cull Mode
        • Depth Draw Mode
        • No Depth Test
      • Shading
        • Shading mode
        • Diffuse Mode
        • Specular Mode
        • Disable Ambient Light
      • Vertex Color
        • Use as Albedo
        • Is sRGB
      • Albedo
      • Metallic
      • Roughness
      • Emission
      • Normal map
      • Rim
      • Clearcoat
      • Anisotropy
      • Ambient Occlusion
      • Height
      • Subsurface Scattering
      • Back Lighting
      • Refraction
      • Detail
      • UV1 and UV2
        • Triplanar Mapping
        • World Triplanar
      • Sampling
        • Filter
        • Repeat
      • Shadows
        • Do Not Receive Shadows
        • Use Shadow to Opacity
      • Billboard
        • Billboard Mode
        • Billboard Keep Scale
      • Grow
      • Transform
        • Fixed Size
        • Use Point Size
        • Point Size
        • Transmission
      • Proximity and Distance Fade
      • Material Settings
      • Render priority
      • Next Pass
    • 3D lights and shadows
      • Introduction
      • Light nodes
        • Shadow mapping
        • Directional shadow mapping
        • Omni shadow mapping
        • Spot shadow mapping
    • Physical light and camera units
      • Why use physical light and camera units?
        • Advantages of physical units
        • Disadvantages of physical units
      • Setting up physical light units
        • Enable the project setting
        • Configure the camera
        • Configure the environment
        • Configure the light nodes
      • Setting up physical camera units
    • Reflection probes
      • Introduction
      • Setting up
      • Interior vs exterior
      • Blending
      • Reflection atlas
    • Using GIProbe
      • Introduction
      • Setting up
      • Adding lights
      • Reflections
      • Interior vs exterior
      • Tweaking
      • Quality
    • Baked lightmaps
      • Introduction
      • Visual comparison
      • Setting up
        • Unwrap on scene import
        • Unwrap from within Godot
        • Unwrap from your 3D DCC
        • Checking UV2
      • Setting up the scene
        • Configure bounds
        • Setting up meshes
        • Setting up lights
      • Baking
        • Balancing bake times with quality
        • 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
    • 3D antialiasing
      • Introduction
      • Multisample antialiasing (MSAA)
      • Temporal antialiasing (TAA)
      • Fast approximate antialiasing (FXAA)
      • Supersample antialiasing (SSAA)
      • Screen-space roughness limiter
      • Texture roughness limiter on import
      • Which antialiasing technique should I use?
    • Resolution scaling
      • Why use resolution scaling?
      • Resolution scaling options
        • Scaling mode
        • Rendering scale
        • FSR Sharpness
        • Mipmap bias
      • Troubleshooting
        • Performance does not increase much when decreasing resolution scale
    • Volumetric fog and fog volumes
      • Volumetric fog properties
      • Light interaction with volumetric fog
      • Using volumetric fog as a volumetric lighting solution
      • Balancing performance and quality
      • Using fog volumes for local volumetric fog
      • FogVolume properties
      • Custom FogVolume shaders
    • High dynamic range lighting
      • 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
      • NavigationMeshes
      • Exporting the MeshLibrary
      • Using GridMap
      • Using GridMap in code
    • Using MultiMeshInstance3D
      • Introduction
      • Setting up the nodes
      • MultiMesh settings
        • Target Surface
        • Source Mesh
        • Mesh Up Axis
        • Random Rotation
        • Random Tilt
        • Random Scale
        • Scale
        • Amount
    • Prototyping levels with CSG
      • Introduction to CSG nodes
        • CSG tools features
        • CSGPolygon
        • Custom meshes
        • CSGCombiner3D
        • Processing order
      • Prototyping a level
      • Using prototype textures
    • Procedural geometry
      • Using the ArrayMesh
        • Setting up the ArrayMesh
        • Generating geometry
        • Saving
      • Using the MeshDataTool
      • Using the SurfaceTool
      • Using ImmediateMesh
      • What is geometry?
      • What is a Mesh?
      • What a Mesh is
        • Surfaces
        • Surface array
      • Tools
        • ArrayMesh
        • MeshDataTool
        • SurfaceTool
        • ImmediateMesh
      • Which one should I use?
    • 3D text
      • Introduction
      • Label3D
        • Advantages
        • Limitations
      • TextMesh
        • Advantages
        • Limitations
      • Projected Label node (or any other Control)
        • Advantages
        • Limitations
      • Should I use Label3D, TextMesh or a projected Control?
    • Mesh level of detail (LOD)
      • Introduction
      • Visual comparison
      • Generating mesh LOD
      • Comparing mesh LOD visuals and performance
      • Configuring mesh LOD performance and quality
      • Using mesh LOD with MultiMesh and particles
    • Visibility ranges (HLOD)
      • How it works
      • Setting up visibility range
      • Visibility range properties
        • Fade mode
      • Configuration tips
        • Use simpler materials at a distance to improve performance
        • Use dithering for LOD transitions
    • Occlusion culling
      • Why use occlusion culling
      • How occlusion culling works in Godot
      • Setting up occlusion culling
        • Automatically baking occluders (recommended)
        • Manually placing occluders
      • Previewing occlusion culling
      • Performance considerations
        • Design your levels to take advantage of occlusion culling
        • Avoid moving OccluderInstance3D nodes during gameplay
        • Use the simplest possible occluder shapes
      • Troubleshooting
        • My occludee isn't being culled when it should be
        • My occludee is being culled when it shouldn't be
  • Animation
    • Introduction to the animation features
      • 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
      • Using RESET tracks
    • Animation Track types
      • 3D Transform Track
      • Call Method tracks
      • Bezier Curve Track
      • Audio Playback Track
      • Animation Playback Track
    • 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
    • Using AnimationTree
      • Introduction
      • Creating an AnimationTree
      • Creating a tree
      • Blend tree
        • Blend2 / Blend3
        • OneShot
        • Seek
        • TimeScale
        • Transition
        • BlendSpace2D
        • BlendSpace1D
        • StateMachine
      • For better blending
      • Root motion
      • Controlling from code
      • State machine travel
    • Playing videos
      • Supported playback formats
      • Setting up VideoStreamPlayer
        • Handling resizing and different aspect ratios
        • Displaying a video on a 3D surface
      • Video decoding conditions and recommended resolutions
      • Playback limitations
      • Recommended Theora encoding settings
        • Balancing quality and file size
        • FFmpeg: Convert while preserving original video resolution
        • FFmpeg: Resize the video then convert it
    • Creating movies
      • Enabling Movie Maker mode
        • Command line usage
      • Choosing an output format
        • AVI (recommended)
        • PNG
        • Custom
      • Configuration
      • Quitting Movie Maker mode
      • Using high-quality graphics settings
      • Rendering at a higher resolution than the screen resolution
      • Post-processing steps
        • Converting AVI video to MP4
        • Converting PNG image sequence + WAV audio to a video
        • Cutting video
        • Resizing video
        • Reducing framerate
        • Generating accumulation motion blur with FFmpeg
  • Assets pipeline
    • Import process
      • Importing assets in Godot 3.0+
      • Changing import parameters
      • Reimporting multiple assets
      • Automatic reimport
      • Files generated
      • Changing import resource type
      • Changing default import parameters
      • Simplicity is key!
    • Importing images
      • Supported image formats
      • Importing textures
        • Detect 3D
      • Compression
        • Compress Mode
        • HDR Mode
        • Normal Map
      • Flags
        • Repeat
        • Filter
        • Mipmaps
        • Anisotropic
        • sRGB
      • Process
        • Fix Alpha Border
        • Premultiplied Alpha
        • HDR as sRGB
        • Invert Color
      • Svg
        • Scale
    • Importing audio samples
      • Supported files
      • Best practices
        • Trimming
        • Looping
    • Importing translations
      • Games and internationalization
      • Translation format
      • CSV importer
    • Importing 3D scenes
      • Godot scene importer
        • Exporting glTF 2.0 files from Blender
        • Exporting DAE files from Blender
        • Exporting ESCN files from Blender
        • Exporting textures separately
        • Exporting considerations
      • Import workflows
      • Import options
        • Nodes
        • Materials
        • Meshes
        • External Files
      • Animation options
        • FPS
        • Filter Script
        • Storage
        • Optimizer
        • Clips
      • Scene inheritance
      • Import hints
        • Remove nodes (-noimp)
        • Create collisions (-col, -convcol, -colonly, -convcolonly)
        • Create navigation (-navmesh)
        • Create a VehicleBody (-vehicle)
        • Create a VehicleWheel (-wheel)
        • Rigid Body (-rigid)
        • Animation loop (-loop, -cycle)
    • Retargeting 3D Skeletons
      • To share animations among multiple Skeletons
      • Options for Retargeting
        • Bone Map
        • Remove Tracks
        • Bone Renamer
        • Rest Fixer
    • Exporting 3D scenes
      • Overview
      • Limitations
    • Blender ESCN exporter
      • Details on exporting
        • Materials
        • Physics properties
        • Lights
        • Mesh
        • Skeleton
        • Animation
      • Disabling specific objects
      • Build pipeline integration
  • Audio
    • Audio buses
      • Introduction
      • Decibel scale
      • Audio buses
      • Playback of audio through a bus
      • Adding effects
      • Automatic bus disabling
      • Bus rearrangement
      • Default bus layout
    • Audio effects
      • Amplify
      • BandLimit and BandPass
      • Capture
      • Chorus
      • Compressor
      • Delay
      • Distortion
      • EQ
      • EQ6, EQ10, EQ21
      • Filter
      • HighPassFilter
      • HighShelfFilter
      • Limiter
      • LowPassFilter
      • LowShelfFilter
      • NotchFilter
      • Panner
      • Phaser
      • PitchShift
      • Record
      • Reverb
      • SpectrumAnalyzer
      • StereoEnhance
    • 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
  • Export
    • Exporting projects
      • Why export?
        • On PC
        • On mobile
      • Export menu
        • Export templates
        • Resource options
      • Exporting from the command line
      • PCK versus ZIP pack file formats
    • 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 Linux
    • Exporting for macOS
      • Requirements
      • Code signing and notarization
        • If you have an Apple Developer ID Certificate and exporting from macOS
        • If you have an Apple Developer ID Certificate and exporting from Linux or Windows
        • If you do not have an Apple Developer ID Certificate
        • Signing Options
        • Notarization Options
      • Entitlements
        • Hardened Runtime Entitlements
        • App Sandbox Entitlement
    • Running Godot apps on macOS
      • App is signed, notarized and distributed via App Store
      • App is signed, notarized and distributed outside App Store
      • App is signed (including ad-hoc signatures) but not notarized
      • App is not-signed, executable is linker-signed
      • Neither app nor executable is signed (relevant for Apple Silicon macs only)
    • Exporting for Windows
      • Code signing
        • Setup
    • Changing application icon for Windows
      • Creating an ICO file
      • Changing the taskbar icon
      • Changing the file icon
      • Testing the result
    • Exporting for Universal Windows Platform
      • Limitations on Xbox One
      • Creating a signing certificate
      • Setting up automatic signing
      • Installing the package
    • Exporting for iOS
      • Requirements
      • Export a Godot project to Xcode
      • Active development considerations
        • Steps to link a Godot project folder to Xcode
      • Plugins for iOS
    • Exporting for Android
      • Install OpenJDK 11
      • Download the Android SDK
      • Create a debug.keystore
      • Setting it up in Godot
      • Providing launcher icons
      • Exporting for Google Play Store
      • Optimizing the APK size
    • Custom builds for Android
      • Set up the custom build environment
      • Enabling the custom build and exporting
    • Exporting for the Web
      • WebGL version
      • Export options
      • Limitations
        • Using cookies for data persistence
        • Background processing
        • Threads
        • Full screen and mouse capture
        • Audio
        • Networking
        • Clipboard
        • Gamepads
        • Boot splash is not displayed
        • Shader language limitations
      • Serving the files
      • Calling JavaScript from script
    • Exporting for dedicated servers
      • Platform support
      • "Headless" versus "server" binaries
      • Exporting a PCK file
      • Preparing the server distribution
      • Starting the dedicated server
      • Next steps
    • One-click deploy
      • What is one-click deploy?
      • Supported platforms
      • Using one-click deploy
      • Troubleshooting
        • Android
  • Internationalization
    • Internationalizing games
      • Introduction
      • Configuring the imported translation
      • Localizing resources
      • Converting keys to text
        • Placeholders
        • Translation contexts
        • Pluralization
      • Making controls resizable
      • TranslationServer
      • Bidirectional text and UI Mirroring
      • Adding break iterator data to exported project
      • Structured text BiDi override
      • Localizing numbers
      • Localizing icons and images
      • Testing translations
      • Translating the project name
    • Localization using gettext
      • Advantages
      • Disadvantages
      • Installing gettext tools
      • Creating the PO template
      • Automatic generation using the editor
      • Manual creation
      • 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
      • Using binary MO files (useful for large projects only)
    • Locale codes
      • List of supported language codes
      • List of supported script codes
      • List of supported country codes
  • Inputs
    • Using 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
    • Controllers, gamepads, and joysticks
      • Supporting universal input
        • Which Input singleton method should I use?
      • Differences between keyboard/mouse and controller input
        • Dead zone
        • "Echo" events
      • Troubleshooting
        • My controller isn't recognized by Godot.
        • My controller has incorrectly mapped buttons or axes.
        • My controller works on a given platform, but not on another platform.
    • Handling quit requests
      • Quitting
      • Handling the notification
      • Sending your own quit notification
  • Input and Output (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:
    • File paths in Godot projects
      • Path separators
      • Accessing files in the project folder (res://)
      • Accessing persistent user data (user://)
      • Converting paths to absolute paths or "local" paths
      • Editor data paths
        • Self-contained mode
    • Saving games
      • Introduction
      • Identify persistent objects
      • Serializing
      • Saving and reading data
      • Some notes
      • JSON vs binary serialization
        • JSON limitations
        • Binary serialization
    • Binary serialization API
      • Introduction
      • Full Objects vs Object instance IDs
      • Packet specification
        • 0: null
        • 1: bool
        • 2: int
        • 3: float
        • 4: String
        • 5: Vector2
        • 6: Rect2
        • 7: Vector3
        • 8: Transform2D
        • 9: Plane
        • 10: Quaternion
        • 11: AABB
        • 12: Basis
        • 13: Transform3D
        • 14: Color
        • 15: NodePath
        • For old format:
        • For new format:
        • 16: RID (unsupported)
        • 17: Object
        • 18: Dictionary
        • 19: Array
        • 20: PackedByteArray
        • 21: PackedInt32Array
        • 22: PackedInt64Array
        • 23: PackedFloat32Array
        • 24: PackedFloat64Array
        • 25: PackedStringArray
        • 26: PackedVector2Array
        • 27: PackedVector3Array
        • 28: PackedColorArray
  • 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
    • Random number generation
      • Global scope versus RandomNumberGenerator class
      • The randomize() method
      • Getting a random number
      • Get a random array element
      • Get a random dictionary value
      • Weighted random probability
      • "Better" randomness using shuffle bags
      • Random noise
  • Navigation
    • 2D Navigation Overview
      • Setup for 2D scene
    • 3D Navigation Overview
      • Setup for 3D scene
    • Using NavigationServer
      • Communicating with the NavigationServer
      • Threading and Synchronisation
      • 2D and 3D NavigationServer differences
      • Waiting for synchronisation
      • Server Avoidance Callbacks
    • Using NavigationMaps
      • Default navigation maps
      • Creating new navigation maps
    • Using NavigationRegions
      • Creating new navigation regions
    • Using NavigationMeshes
      • Creating 2D NavigationMeshes
      • Creating 3D NavigationMeshes
      • NavigationMesh rebaking at runtime
      • 2D Navmesh from CollisionPolygons
      • Procedual 2D NavigationMesh
      • Procedual 3D NavigationMesh
      • Navmesh for 3D GridMaps
    • Using NavigationPaths
      • Obtaining a Navigationpath
    • Using NavigationPathQueryObjects
    • Using NavigationAgents
      • NavigationAgent Pathfinding
      • NavigationAgent Avoidance
      • NavigationAgent Script Templates
        • Actor as Node3D
        • Actor as CharacterBody3D
        • Actor as RigidBody3D
    • Using NavigationObstacles
    • Using NavigationLinks
    • Using NavigationLayers
    • Using Agent Avoidance
      • Creating Avoidance Agents with Scripts
    • Navigation Debug Tools
      • Enabling debug navigation
      • Debug navigation settings
      • Debug navigation mesh polygons
      • Debug edge connections
      • Debug Performance
    • Connecting NavigationMeshes
    • Support different actor types
    • Support different actor locomotion
    • Support different actor area access
  • Networking
    • High-level multiplayer
      • High-level vs low-level API
      • Mid-level abstraction
      • Hosting considerations
      • 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
  • Performance
    • Introduction
    • Common
      • General optimization tips
        • Introduction
      • Measuring performance
        • Limitations
        • Detective work
      • Profilers
      • Principles
        • Performant design
        • Incremental design
        • The optimization process
        • Optimizing bottlenecks
      • Appendix
        • Bottleneck math
      • 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
    • CPU
      • CPU optimization
      • Measuring performance
      • CPU profilers
        • External profilers
      • Manually timing functions
      • Caches
      • Languages
        • GDScript
        • C#
        • Other languages
        • C++
      • Threads
      • SceneTree
      • Physics
    • GPU
      • GPU optimization
        • Introduction
      • Draw calls, state changes, and APIs
        • 2D batching
        • 3D batching
        • Reuse Shaders and Materials
      • Pixel cost versus vertex cost
      • Pixel/fragment shaders and fill rate
        • Reading textures
        • Texture compression
        • Post-processing and shadows
      • Transparency and blending
      • Multi-platform advice
      • Mobile/tiled renderers
      • Optimization using MultiMeshes
        • MultiMeshes
        • Multimesh example
    • 3D
      • Optimizing 3D performance
      • Culling
        • Occlusion culling
        • Other occlusion techniques
        • Transparent objects
      • Level of detail (LOD)
        • Billboards and imposters
        • Use instancing (MultiMesh)
      • Bake lighting
      • Animation and skinning
      • Large worlds
      • Animating thousands of objects
        • Animating thousands of fish with MultiMeshInstance3D
        • Controlling thousands of fish with Particles
    • Threads
      • Using multiple threads
        • Threads
        • Creating a Thread
        • Mutexes
        • Semaphores
      • Thread-safe APIs
        • Threads
        • Global scope
        • Scene tree
        • Rendering
        • GDScript arrays, dictionaries
        • Resources
  • Physics
    • Physics introduction
      • Collision objects
        • Physics material
        • Collision shapes
        • Physics process callback
        • Collision layers and masks
      • Area2D
      • StaticBody2D
      • RigidBody2D
        • Using RigidBody2D
        • Contact reporting
      • CharacterBody2D
        • Character collision response
    • Using 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 CharacterBody2D/3D
      • Introduction
      • What is a character body?
      • Movement and collision
        • move_and_collide
        • move_and_slide
      • 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
    • Using SoftBody
      • Basic set-up
      • Cloak simulation
    • Collision shapes (2D)
      • Primitive collision shapes
      • Convex collision shapes
      • Concave or trimesh collision shapes
      • Performance caveats
    • Collision shapes (3D)
      • Primitive collision shapes
      • Convex collision shapes
      • Concave or trimesh collision shapes
      • Performance caveats
    • Large world coordinates
      • Why use large world coordinates?
      • How large world coordinates work
      • Who are large world coordinates for?
      • Enabling large world coordinates
      • Compatibility between single-precision and double-precision builds
        • Known incompatibilities
      • Limitations
  • Platform-specific
    • Android plugins
      • Creating Android plugins
        • Introduction
        • Android plugin
        • Troubleshooting
      • Android in-app purchases
        • Usage
        • Migrating from Godot 3.2.1 and lower (GodotPaymentsV3)
    • iOS plugins
      • Creating iOS plugins
        • Loading and using an existing plugin
        • Creating an iOS plugin
      • Plugins for iOS
        • Accessing plugin singletons
        • Asynchronous methods
        • Store Kit
        • Game Center
    • HTML5
      • HTML5 shell class reference
        • Engine
        • Engine configuration
      • 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
  • 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
        • Registering autoloads/singletons in plugins
      • 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
      • 3D gizmo plugins
        • Introduction
        • The EditorNode3DGizmoPlugin
        • Simple approach
        • Alternative approach
      • Inspector plugins
        • Setting up your plugin
        • Interacting with the inspector
        • Adding an interface to edit properties
      • Visual Shader plugins
    • Running code in the editor
      • What is @tool?
      • How to use it
      • Try it out
      • Editing variables
      • Reporting node configuration warnings
      • Instancing scenes
  • Rendering
    • Using 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
      • Common use case scenarios
        • Desktop game
        • Mobile game in landscape mode
        • Mobile game in portrait mode
        • Non-game application
      • hiDPI support
      • Reducing aliasing on downsampling
      • Handling aspect ratios
      • Field of view scaling
      • Scaling 2D and 3D elements differently using Viewports
    • Fixing jitter, stutter and input lag
      • What is jitter, stutter and input lag?
      • Distinguishing between jitter and stutter
      • Jitter
      • Stutter
        • Windows
        • Linux
        • macOS
        • Android
        • iOS
      • Input lag
        • Project configuration
        • Hardware/OS-specific
      • Reporting jitter, stutter or input lag problems
  • Scripting
    • Programming languages
      • GDScript
        • GDScript reference
        • GDScript: An introduction to dynamic languages
        • GDScript exports
        • GDScript documentation comments
        • GDScript style guide
        • Static typing in GDScript
        • GDScript warning system
        • GDScript format strings
      • C#
        • C# basics
        • C# features
        • C# API differences to GDScript
        • C# Signals
        • C# Exports
        • C# style guide
    • Core features
      • How to read the Godot API
        • Inheritance
        • Brief Description
        • Description
        • Tutorials
        • Properties
        • Methods
        • Signals
        • Enumerations
        • Constants
        • Property Descriptions
        • Method Descriptions
      • Debug
        • Overview of debugging tools
        • Debugger panel
        • The Profiler
        • Custom performance monitors
      • Idle and Physics Processing
      • Groups
        • Managing groups
      • Nodes and scene instances
        • Getting nodes
        • Node paths
        • Creating nodes
        • Instancing scenes
      • Overridable functions
      • Cross-language scripting
        • Instantiating nodes
        • Accessing fields
        • Calling methods
        • Inheritance
      • Creating script templates
        • Locating the templates
        • Default behaviour and overriding it
        • Default template
        • List of template placeholders
      • Evaluating expressions
        • Basic usage
        • Passing variables to an expression
        • Setting a base instance for the expression
        • Example script
        • Built-in functions
      • Change scenes manually
      • Instancing with signals
        • Shooting example
      • Pausing games and process mode
        • Introduction
        • How pausing works
        • Process Modes
        • Pause Menu Example
      • File system
        • Introduction
        • Implementation
        • project.godot
        • Path delimiter
        • Resource path
        • User path
        • Host file system
        • Drawbacks
      • Resources
        • Nodes and resources
        • External vs built-in
        • Loading resources from code
        • Loading scenes
        • Freeing resources
        • Creating your own resources
      • Singletons (AutoLoad)
        • Introduction
        • AutoLoad
        • Custom scene switcher
      • Using SceneTree
        • Introduction
        • MainLoop
        • SceneTree
        • Root viewport
        • Scene tree
        • Tree order
        • "Becoming active" by entering the Scene Tree
        • Changing current scene
      • Scene Unique Nodes
        • Introduction
        • Creating and using them
  • Shaders
    • Introduction to shaders
      • Shaders in Godot
      • Shader types
      • Render modes
        • Vertex processor
        • Fragment processor
        • Light processor
    • Shading reference
      • Shading language
        • Introduction
        • Data types
        • Arrays
        • Constants
        • Structs
        • Operators
        • Flow control
        • Discarding
        • Functions
        • Varyings
        • Interpolation qualifiers
        • Uniforms
        • Built-in variables
        • Built-in functions
      • Shader preprocessor
        • Why use a shader preprocessor?
        • Directives
      • 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
        • SDF functions
      • Particle shaders
        • Render modes
        • Built-ins
        • Global built-ins
        • Start and Process built-ins
        • Start built-ins
        • Process built-ins
        • Process functions
      • Sky shaders
        • Render modes
        • Built-ins
        • Global built-ins
        • Sky built-ins
      • Fog shaders
        • Built-ins
        • Global built-ins
        • Fog built-ins
    • Your first shader
      • Your first 2D shader
        • Introduction
        • Setup
        • Your first CanvasItem shader
        • Your first fragment function
        • Your first vertex function
        • Conclusion
      • Your first 3D shader
        • Where to assign my material
        • Setting up
        • Shader magic
        • Noise heightmap
        • Uniforms
        • Interacting with light
      • Your second 3D shader
        • Your first spatial fragment function
        • Animating with TIME
        • Advanced effects: waves
    • Shader materials
      • Introduction
      • Creating a ShaderMaterial
      • Converting to ShaderMaterial
    • Using VisualShaders
      • Creating a VisualShader
      • Using the Visual Shader Editor
      • Visual Shader nodes
        • Expression node
        • Fresnel node
        • Boolean node
        • If node
        • Switch node
    • Using compute shaders
      • How they work
      • Creating a ComputeShader
      • Create a local RenderingDevice
      • Provide input data
      • Defining a compute pipeline
      • Execute a compute shader
      • Retrieving results
      • Conclusion
    • Screen-reading shaders
      • Introduction
      • SCREEN_TEXTURE built-in texture
      • SCREEN_TEXTURE example
      • Behind the scenes
      • Back-buffer logic
      • DEPTH_TEXTURE
    • Converting GLSL to Godot shaders
      • 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
    • Shaders 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
        • Preprocessor directives
      • Code order
        • Local variables
    • Advanced post-processing
      • Introduction
      • Full screen quad
      • Depth texture
      • An optimization
    • 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
    • Making trees
      • Start with a tree
      • Paint with vertex colors
      • Write a custom shader for the leaves
      • Improving the shader
  • User Interface (UI)
    • UI building blocks
      • Size and anchors
        • Centering a control
        • Layout Presets
      • Using Containers
        • Container layout
        • Sizing options
        • Container types
        • Creating custom Containers
      • Custom GUI controls
        • So many controls...
        • Drawing
        • Sizing
        • Input
      • Keyboard/Controller Navigation and Focus
        • Node settings
        • Necessary code
      • Control node gallery
    • GUI skinning and themes
      • Introduction to GUI skinning
        • Basics of themes
        • Customizing a control
        • Customizing a project
        • Beyond controls
      • Using the theme editor
        • Creating a theme
        • Theme editor overview
        • Manage and import items
      • Theme type variations
        • Creating a type variation
        • Using a type variation
      • Using Fonts
        • Dynamic fonts
        • Bitmap fonts
        • Loading a font file
        • Advanced font features
    • Control node tutorials
      • BBCode in RichTextLabel
        • Introduction
        • Using BBCode
        • Reference
        • Animation effects
        • Custom BBCode tags and text effects
  • XR
    • Basic Tutorial
      • Setting up XR
        • Introduction to the XR system in Godot
        • Prerequisites for XR in Godot 4
        • OpenXR
        • Setting up the XR scene
      • Deploying to Android
        • Setup
        • Custom Android build
        • Installing the loader plugins
        • Creating the export templates
      • Basic XR Locomotion
    • Advanced topics
      • The OpenXR action map
      • The OpenXR hand tracking

Contributing

  • Ways to contribute
    • Contributing code
    • Testing and reporting issues
      • Testing development versions
      • Filing an issue on GitHub
    • Contributing to the documentation
    • Contributing translations
  • Contribution workflow
    • Bisecting regressions
      • What is bisecting?
      • Using official builds to speed up bisecting
      • The Git bisect command
        • Determine the commit hashes
        • Build the engine
        • Run the engine
    • Bug triage guidelines
      • Issues management
        • Labels
        • Documentation labels
        • Milestones
    • 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
    • Testing pull requests
      • Downloading a compiled build
        • If you have a GitHub account
        • If you don't have a GitHub account
      • Compiling a pull request branch from source
  • Engine development
    • Best practices for engine contributors
      • Introduction
      • Language
      • Best Practices
        • #1: The problem always comes first
        • #2: To solve the problem, it has to exist in the first place
        • #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: Prefer local solutions
        • #8: Don't use complex canned solutions for simple problems
    • Code style guidelines
      • C++ and Objective-C
        • Using clang-format locally
        • Header includes
      • Java
      • Python
        • Using black locally
      • Comment style guide
    • C++ usage guidelines
      • Rationale
      • Disallowed features
        • Standard Template Library
        • auto keyword
        • Lambdas
        • #pragma once directive
    • Building from source
      • Getting the source
        • Downloading the Godot source code
      • Introduction to the buildsystem
        • SCons
        • Setup
        • Platform selection
        • Resulting binary
        • Target
        • Dev build
        • Architecture
        • Custom modules
        • Cleaning generated files
        • Other build options
        • Export templates
      • Compiling for Windows
        • Requirements
        • Setting up SCons
        • Installing Visual Studio caveats
        • Downloading Godot's source
        • Compiling
        • Development in Visual Studio
        • Cross-compiling for Windows from other operating systems
        • Creating Windows export templates
      • Compiling for Linux, *BSD
        • Requirements
        • Compiling
        • Running a headless/server build
        • Building export templates
        • Using Clang and LLD for faster development
        • Using mold for faster development
        • Using system libraries for faster development
        • Using Pyston for faster development
      • Compiling for macOS
        • Requirements
        • Compiling
        • Running a headless/server build
        • Building export templates
        • Using Pyston for faster development
        • Cross-compiling for macOS from Linux
      • Compiling for Android
        • Note
        • Requirements
        • Setting up the buildsystem
        • Building the export templates
        • Using the export templates
        • Building the Godot editor
        • Removing the Editor templates
        • Installing the Godot editor
        • Troubleshooting
      • Compiling for iOS
        • Requirements
        • Compiling
        • Run
      • Cross-compiling for iOS on Linux
        • Disclaimer
        • Requirements
        • Configuring the environment
        • Compiling Godot for iPhone
      • 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
        • GDExtension
        • Building the editor
      • Compiling with Mono
        • Requirements
        • Environment variables
        • Enable the Mono module
        • Generate the glue
        • Rebuild with Mono glue
        • Examples
        • Data directory
        • 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
        • Stripping binaries
        • Optimizing for size instead of speed
        • Compiling with link-time optimization
        • Disabling 3D
        • Disabling advanced GUI objects
        • Disabling unwanted modules
      • Compiling with PCK encryption key
        • Step by step
        • Troubleshooting
    • Debugging and profiling
      • Using C++ profilers
        • Recommended profilers
        • Setting up Godot
        • Benchmarking startup/shutdown times
        • Profiler-specific instructions
      • Debugging on macOS
        • Debugging Godot editor
        • Debugging exported project
      • Vulkan
        • Validation layers
      • Debugging the editor
    • Configuring an IDE
      • Android Studio
        • Importing the project
      • CLion
        • Importing the project
        • Compiling and debugging 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
    • Engine core and modules
      • Getting started with Godot's source code
        • Godot's architecture diagram
        • Common engine methods and macros
        • Core types
        • Variant class
        • Object class
        • Inheritance class tree
      • Extending Godot by modifying its source code
        • Custom modules in C++
        • Binding to external libraries
        • Custom Godot servers
        • Custom resource format loaders
        • Custom AudioStreams
        • Unit testing
    • Editor development
      • Introduction to editor development
        • Technical choices
        • Directory structure
        • Editor dependencies in scene/ files
        • Development tips
      • 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
        • The scene tree
        • Resources
  • Writing documentation
    • Guidelines
      • Content guidelines
        • Guidelines and principles
      • Writing guidelines
        • 7 rules for clear English
        • How to write methods and classes
        • Common vocabulary to use in Godot's documentation
        • Keyboard shortcut guidelines
      • Creating Documentation Images
        • Capturing an image
        • Format conversion
        • Cropping
        • Scaling down an image
        • Saving as WebP in Krita
        • Outlines arrows and text
        • Adding an image to a documentation page
    • Writing the manual
      • Contributing to the documentation
        • Getting started
        • What is the Godot documentation
        • Contributing changes
        • Editing pages online
        • Adding new pages
        • License
      • Building the manual with Sphinx
    • Class reference guides
      • Contributing to the class reference
        • The source of the class reference
        • What to contribute
        • Updating class reference when working on the engine
      • Class reference primer
        • How to edit class XML
    • Translating the documentation
      • Editor and documentation localization
        • Using Weblate for translations
        • Locating original content
        • Respecting the markup syntax
        • Offline translation and testing
        • Localizing documentation images

Community

  • Asset Library
    • About the Asset Library
      • Types of assets
      • Frequently asked questions
        • Can paid assets be uploaded to the asset library?
    • Using the Asset Library
      • 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
  • Community channels
    • Q&A
    • Rocket.Chat
    • IRC on Libera.Chat
    • Other chats
    • Language-based communities
    • Social networks
    • Forum
  • Tutorials and resources
    • Where to start
    • Video tutorials
    • Text tutorials
    • Devlogs
    • Resources

Class reference

  • All classes
  • Globals
    • @GDScript
      • Description
      • Tutorials
      • Methods
      • Constants
      • Annotations
      • Method Descriptions
    • @GlobalScope
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
  • Nodes
    • Node
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • AcceptDialog
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • AnimatableBody2D
      • Description
      • Properties
      • Property Descriptions
    • AnimatableBody3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AnimatedSprite2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • AnimatedSprite3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • AnimationPlayer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AnimationTree
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Area2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Area3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AspectRatioContainer
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • AudioListener2D
      • Description
      • Methods
      • Method Descriptions
    • AudioListener3D
      • Description
      • Methods
      • Method Descriptions
    • 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
    • BackBufferCopy
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • BaseButton
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Bone2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • BoneAttachment3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • BoxContainer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Theme Properties
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • Button
      • Description
      • Tutorials
      • Properties
      • Theme Properties
      • Property Descriptions
      • Theme Property Descriptions
    • Camera2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Camera3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CanvasGroup
      • Description
      • Properties
      • Property Descriptions
    • CanvasItem
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • CanvasLayer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • CanvasModulate
      • Description
      • Properties
      • Property Descriptions
    • CenterContainer
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • CharacterBody2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CharacterBody3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CheckBox
      • Description
      • Properties
      • Theme Properties
      • Theme Property Descriptions
    • CheckButton
      • Description
      • Properties
      • Theme Properties
      • Theme Property Descriptions
    • CodeEdit
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • CollisionObject2D
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CollisionObject3D
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CollisionPolygon2D
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • CollisionPolygon3D
      • Description
      • Properties
      • Property Descriptions
    • CollisionShape2D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • CollisionShape3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ColorPicker
      • Description
      • Tutorials
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • ColorPickerButton
      • Description
      • Tutorials
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • ColorRect
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • ConeTwistJoint3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ConfirmationDialog
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Container
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Constants
      • Method Descriptions
    • Control
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • CPUParticles2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CPUParticles3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CSGBox3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • CSGCombiner3D
      • Description
      • Tutorials
    • CSGCylinder3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • CSGMesh3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • CSGPolygon3D
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • CSGPrimitive3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • CSGShape3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CSGSphere3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • CSGTorus3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • DampedSpringJoint2D
      • Description
      • Properties
      • Property Descriptions
    • Decal
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • DirectionalLight2D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • DirectionalLight3D
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • EditorCommandPalette
      • Description
      • Properties
      • Methods
      • Method Descriptions
    • EditorFileDialog
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • EditorFileSystem
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • EditorInspector
      • Description
      • Properties
      • Methods
      • Signals
      • Method Descriptions
    • EditorInterface
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • EditorPlugin
      • Description
      • Tutorials
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • EditorProperty
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • EditorResourcePicker
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • EditorResourcePreview
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • EditorScriptPicker
      • Description
      • Properties
      • Property Descriptions
    • EditorSpinSlider
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • FileDialog
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • FileSystemDock
      • Methods
      • Signals
      • Method Descriptions
    • FlowContainer
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • FogVolume
      • Description
      • Properties
      • Property Descriptions
    • Generic6DOFJoint3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • GeometryInstance3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • GPUParticles2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • GPUParticles3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • GPUParticlesAttractor3D
      • Description
      • Properties
      • Property Descriptions
    • GPUParticlesAttractorBox3D
      • Description
      • Properties
      • Property Descriptions
    • GPUParticlesAttractorSphere3D
      • Description
      • Properties
      • Property Descriptions
    • GPUParticlesAttractorVectorField3D
      • Description
      • Properties
      • Property Descriptions
    • GPUParticlesCollision3D
      • Description
      • Properties
      • Property Descriptions
    • GPUParticlesCollisionBox3D
      • Description
      • Properties
      • Property Descriptions
    • GPUParticlesCollisionHeightField3D
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • GPUParticlesCollisionSDF3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • GPUParticlesCollisionSphere3D
      • Description
      • Properties
      • Property Descriptions
    • GraphEdit
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • GraphNode
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • GridContainer
      • Description
      • Tutorials
      • Properties
      • Theme Properties
      • Property Descriptions
      • Theme Property Descriptions
    • GridMap
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Constants
      • Property Descriptions
      • Method Descriptions
    • GrooveJoint2D
      • Description
      • Properties
      • Property Descriptions
    • HBoxContainer
      • Description
      • Tutorials
      • Theme Properties
      • Theme Property Descriptions
    • HFlowContainer
      • Description
      • Theme Properties
      • Theme Property Descriptions
    • HingeJoint3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • HScrollBar
      • Description
      • Theme Properties
      • Theme Property Descriptions
    • HSeparator
      • Description
      • Theme Properties
      • Theme Property Descriptions
    • HSlider
      • Description
      • Theme Properties
      • Theme Property Descriptions
    • HSplitContainer
      • Description
      • Tutorials
      • Theme Properties
      • Theme Property Descriptions
    • HTTPRequest
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ImporterMeshInstance3D
      • Properties
      • Property Descriptions
    • InstancePlaceholder
      • Description
      • Methods
      • Method Descriptions
    • ItemList
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • Joint2D
      • Description
      • Properties
      • Property Descriptions
    • Joint3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • Label
      • Description
      • Tutorials
      • Properties
      • Methods
      • Theme Properties
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • Label3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Light2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Light3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • LightmapGI
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • LightmapProbe
      • Description
    • LightOccluder2D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • Line2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • LineEdit
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • LinkButton
      • Description
      • Properties
      • Theme Properties
      • Enumerations
      • Property Descriptions
      • Theme Property Descriptions
    • MarginContainer
      • Description
      • Tutorials
      • Theme Properties
      • Theme Property Descriptions
    • Marker2D
      • Description
      • Properties
      • Property Descriptions
    • Marker3D
      • Description
      • Properties
      • Property Descriptions
    • MenuBar
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • MenuButton
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • MeshInstance2D
      • Description
      • Tutorials
      • Properties
      • Signals
      • Property Descriptions
    • MeshInstance3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • MissingNode
      • Description
      • Properties
      • Property Descriptions
    • MultiMeshInstance2D
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • MultiMeshInstance3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • MultiplayerSpawner
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • MultiplayerSynchronizer
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • NavigationAgent2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • NavigationAgent3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • NavigationLink2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • NavigationLink3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • NavigationObstacle2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • NavigationObstacle3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • NavigationRegion2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • NavigationRegion3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • NinePatchRect
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Node2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Node3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • OccluderInstance3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OmniLight3D
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • OpenXRHand
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • OptionButton
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • Panel
      • Description
      • Tutorials
      • Theme Properties
      • Theme Property Descriptions
    • PanelContainer
      • Description
      • Tutorials
      • Properties
      • Theme Properties
      • Theme Property Descriptions
    • ParallaxBackground
      • Description
      • Properties
      • Property Descriptions
    • ParallaxLayer
      • Description
      • Properties
      • Property Descriptions
    • Path2D
      • Description
      • Properties
      • Property Descriptions
    • Path3D
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • PathFollow2D
      • Description
      • Properties
      • Property Descriptions
    • PathFollow3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PhysicalBone2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PhysicalBone3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PhysicsBody2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Method Descriptions
    • PhysicsBody3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PinJoint2D
      • Description
      • Properties
      • Property Descriptions
    • PinJoint3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PointLight2D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • Polygon2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Popup
      • Description
      • Properties
      • Signals
    • PopupMenu
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • PopupPanel
      • Description
      • Theme Properties
      • Theme Property Descriptions
    • ProgressBar
      • Description
      • Properties
      • Theme Properties
      • Enumerations
      • Property Descriptions
      • Theme Property Descriptions
    • Range
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • RayCast2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RayCast3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ReferenceRect
      • Description
      • Properties
      • Property Descriptions
    • ReflectionProbe
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • RemoteTransform2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RemoteTransform3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ResourcePreloader
      • Description
      • Methods
      • Method Descriptions
    • RichTextLabel
      • Description
      • Tutorials
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • RigidBody2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • RigidBody3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • RootMotionView
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • ScriptCreateDialog
      • Description
      • Properties
      • Methods
      • Signals
      • Method Descriptions
    • ScriptEditor
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • ScriptEditorBase
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • ScrollBar
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • ScrollContainer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • Separator
      • Description
    • ShaderGlobalsOverride
    • ShapeCast2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ShapeCast3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Skeleton2D
      • Description
      • Tutorials
      • Methods
      • Signals
      • Method Descriptions
    • Skeleton3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Constants
      • Property Descriptions
      • Method Descriptions
    • SkeletonIK3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Slider
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • SliderJoint3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SoftBody3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SpinBox
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • SplitContainer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • SpotLight3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • SpringArm3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Sprite2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • Sprite3D
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • SpriteBase3D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • StaticBody2D
      • Description
      • Properties
      • Property Descriptions
    • StaticBody3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • SubViewport
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • SubViewportContainer
      • Description
      • Properties
      • Property Descriptions
    • TabBar
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • TabContainer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • TextEdit
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • TextureButton
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • TextureProgressBar
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • TextureRect
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • TileMap
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Timer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • TouchScreenButton
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • Tree
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • VBoxContainer
      • Description
      • Tutorials
      • Theme Properties
      • Theme Property Descriptions
    • VehicleBody3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • VehicleWheel3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • VFlowContainer
      • Description
      • Theme Properties
      • Theme Property Descriptions
    • VideoStreamPlayer
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • Viewport
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • VisibleOnScreenEnabler2D
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisibleOnScreenEnabler3D
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisibleOnScreenNotifier2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • VisibleOnScreenNotifier3D
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • VisualInstance3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • VoxelGI
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • VScrollBar
      • Description
      • Properties
      • Theme Properties
      • Theme Property Descriptions
    • VSeparator
      • Description
      • Theme Properties
      • Theme Property Descriptions
    • VSlider
      • Description
      • Properties
      • Theme Properties
      • Theme Property Descriptions
    • VSplitContainer
      • Description
      • Tutorials
      • Theme Properties
      • Theme Property Descriptions
    • Window
      • Description
      • Properties
      • Methods
      • Theme Properties
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
      • Theme Property Descriptions
    • WorldEnvironment
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • XRAnchor3D
      • Description
      • Methods
      • Method Descriptions
    • XRCamera3D
      • Description
      • Tutorials
    • XRController3D
      • Description
      • Tutorials
      • Methods
      • Signals
      • Method Descriptions
    • XRNode3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • XROrigin3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
  • Resources
    • Resource
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • AnimatedTexture
      • Description
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Animation
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AnimationLibrary
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • AnimationNode
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AnimationNodeAdd2
      • Description
      • Tutorials
    • AnimationNodeAdd3
      • Description
      • Tutorials
    • AnimationNodeAnimation
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • AnimationNodeBlend2
      • Description
      • Tutorials
    • AnimationNodeBlend3
      • Description
      • Tutorials
    • 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
      • Signals
      • Constants
      • Property Descriptions
      • Method Descriptions
    • AnimationNodeOneShot
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • AnimationNodeOutput
      • Tutorials
    • AnimationNodeStateMachine
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • AnimationNodeStateMachinePlayback
      • Description
      • Tutorials
      • Properties
      • Methods
      • Method Descriptions
    • AnimationNodeStateMachineTransition
      • Tutorials
      • Properties
      • Signals
      • Enumerations
      • Property Descriptions
    • AnimationNodeSync
      • Properties
      • Property Descriptions
    • AnimationNodeTimeScale
      • Description
      • Tutorials
    • AnimationNodeTimeSeek
      • Description
      • Tutorials
    • AnimationNodeTransition
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • AnimationRootNode
    • ArrayMesh
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ArrayOccluder3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • AtlasTexture
      • Description
      • Properties
      • Property Descriptions
    • AudioBusLayout
      • Description
    • AudioEffect
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • AudioEffectAmplify
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AudioEffectBandLimitFilter
      • Description
      • Tutorials
    • AudioEffectBandPassFilter
      • Description
      • Tutorials
    • AudioEffectCapture
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • AudioEffectChorus
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • AudioEffectCompressor
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AudioEffectDelay
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AudioEffectDistortion
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • AudioEffectEQ
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • AudioEffectEQ10
      • Description
      • Tutorials
    • AudioEffectEQ21
      • Description
      • Tutorials
    • AudioEffectEQ6
      • Description
      • Tutorials
    • AudioEffectFilter
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • AudioEffectHighPassFilter
      • Description
      • Tutorials
    • AudioEffectHighShelfFilter
      • Description
      • Tutorials
    • AudioEffectLimiter
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AudioEffectLowPassFilter
      • Description
      • Tutorials
    • AudioEffectLowShelfFilter
      • Description
      • Tutorials
    • AudioEffectNotchFilter
      • Description
      • Tutorials
    • AudioEffectPanner
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AudioEffectPhaser
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AudioEffectPitchShift
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • AudioEffectRecord
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • AudioEffectReverb
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AudioEffectSpectrumAnalyzer
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • AudioEffectStereoEnhance
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AudioStream
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • AudioStreamGenerator
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • AudioStreamMicrophone
      • Description
      • Tutorials
    • AudioStreamMP3
      • Description
      • Properties
      • Property Descriptions
    • AudioStreamOggVorbis
      • Properties
      • Property Descriptions
    • AudioStreamPolyphonic
      • Description
      • Properties
      • Property Descriptions
    • AudioStreamRandomizer
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AudioStreamWAV
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • BaseMaterial3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • BitMap
      • Description
      • Methods
      • Method Descriptions
    • BoneMap
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • BoxMesh
      • Description
      • Properties
      • Property Descriptions
    • BoxOccluder3D
      • Description
      • Properties
      • Property Descriptions
    • BoxShape3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • ButtonGroup
      • Description
      • Properties
      • Methods
      • Signals
      • Method Descriptions
    • CameraAttributes
      • Description
      • Properties
      • Property Descriptions
    • CameraAttributesPhysical
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • CameraAttributesPractical
      • Description
      • Properties
      • Property Descriptions
    • CameraTexture
      • Description
      • Properties
      • Property Descriptions
    • CanvasItemMaterial
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • CanvasTexture
      • Description
      • Properties
      • Property Descriptions
    • CapsuleMesh
      • Description
      • Properties
      • Property Descriptions
    • CapsuleShape2D
      • Description
      • Properties
      • Property Descriptions
    • CapsuleShape3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • CircleShape2D
      • Description
      • Properties
      • Property Descriptions
    • CodeHighlighter
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • CompressedCubemap
      • Description
    • CompressedCubemapArray
      • Description
    • CompressedTexture2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • CompressedTexture2DArray
      • Description
    • CompressedTexture3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • CompressedTextureLayered
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ConcavePolygonShape2D
      • Description
      • Properties
      • Property Descriptions
    • ConcavePolygonShape3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ConvexPolygonShape2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ConvexPolygonShape3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • CryptoKey
      • Description
      • Methods
      • Method Descriptions
    • CSharpScript
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • Cubemap
      • Description
      • Methods
      • Method Descriptions
    • CubemapArray
      • Description
      • Methods
      • Method 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
      • Enumerations
      • Property Descriptions
    • CurveXYZTexture
      • Description
      • Properties
      • Property Descriptions
    • CylinderMesh
      • Description
      • Properties
      • Property Descriptions
    • CylinderShape3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • EditorNode3DGizmoPlugin
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • EditorSettings
      • Description
      • Properties
      • Methods
      • Signals
      • Constants
      • Property Descriptions
      • Method Descriptions
    • EditorSyntaxHighlighter
      • Description
      • Methods
      • Method Descriptions
    • Environment
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • FastNoiseLite
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • FogMaterial
      • Description
      • Properties
      • Property Descriptions
    • Font
      • Description
      • Methods
      • Method Descriptions
    • FontFile
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • FontVariation
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • GDExtension
      • Methods
      • Enumerations
      • Method Descriptions
    • GDScript
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • GLTFAccessor
      • Properties
      • Property Descriptions
    • GLTFAnimation
      • Properties
      • Property Descriptions
    • GLTFBufferView
      • Properties
      • Property Descriptions
    • GLTFCamera
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • GLTFDocument
      • Description
      • Methods
      • Method Descriptions
    • GLTFDocumentExtension
      • Description
      • Methods
      • Method Descriptions
    • GLTFDocumentExtensionConvertImporterMesh
    • GLTFLight
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • GLTFMesh
      • Properties
      • Property Descriptions
    • GLTFNode
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • GLTFSkeleton
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • GLTFSkin
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • GLTFSpecGloss
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • GLTFState
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • GLTFTexture
      • Properties
      • Property Descriptions
    • GLTFTextureSampler
      • Description
      • Properties
      • Property Descriptions
    • Gradient
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • GradientTexture1D
      • Description
      • Properties
      • Property Descriptions
    • GradientTexture2D
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • HeightMapShape3D
      • Description
      • Properties
      • Property Descriptions
    • Image
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • ImageTexture
      • Description
      • Tutorials
      • Properties
      • Methods
      • Method Descriptions
    • ImageTexture3D
      • Description
      • Methods
      • Method Descriptions
    • ImageTextureLayered
      • Description
      • Methods
      • Method Descriptions
    • ImmediateMesh
      • Description
      • Methods
      • Method Descriptions
    • ImporterMesh
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • InputEvent
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • InputEventAction
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • InputEventFromWindow
      • 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
      • Description
      • Tutorials
      • 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
    • InputEventShortcut
      • Properties
      • Property Descriptions
    • InputEventWithModifiers
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • JSON
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • LabelSettings
      • Description
      • Properties
      • Property Descriptions
    • LightmapGIData
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Material
      • Description
      • Tutorials
      • Properties
      • Methods
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Mesh
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • MeshLibrary
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • MeshTexture
      • Description
      • Properties
      • Property Descriptions
    • MissingResource
      • Description
      • Properties
      • Property Descriptions
    • MultiMesh
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • NavigationMesh
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • NavigationPolygon
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • Noise
      • Description
      • Methods
      • Method Descriptions
    • NoiseTexture2D
      • Description
      • Properties
      • Property Descriptions
    • Occluder3D
      • Description
      • Methods
      • Method Descriptions
    • OccluderPolygon2D
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • OggPacketSequence
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OpenXRAction
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • OpenXRActionMap
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OpenXRActionSet
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OpenXRInteractionProfile
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OpenXRIPBinding
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OptimizedTranslation
      • Description
      • Methods
      • Method Descriptions
    • ORMMaterial3D
      • Description
      • Tutorials
    • PackedDataContainer
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PackedScene
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PanoramaSkyMaterial
      • Description
      • Properties
      • Property Descriptions
    • ParticleProcessMaterial
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PhysicalSkyMaterial
      • Description
      • Properties
      • Property Descriptions
    • PhysicsMaterial
      • Description
      • Properties
      • Property Descriptions
    • PlaceholderCubemap
      • Description
    • PlaceholderCubemapArray
      • Description
    • PlaceholderMaterial
      • Description
    • PlaceholderMesh
      • Description
      • Properties
      • Property Descriptions
    • PlaceholderTexture2D
      • Description
      • Properties
      • Property Descriptions
    • PlaceholderTexture2DArray
      • Description
    • PlaceholderTexture3D
      • Description
      • Properties
      • Property Descriptions
    • PlaceholderTextureLayered
      • Description
      • Properties
      • Property Descriptions
    • PlaneMesh
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • PointMesh
      • Description
    • PolygonOccluder3D
      • Description
      • Properties
      • Property Descriptions
    • PolygonPathFinder
      • Methods
      • Method Descriptions
    • PortableCompressedTexture2D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PrimitiveMesh
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PrismMesh
      • Description
      • Properties
      • Property Descriptions
    • ProceduralSkyMaterial
      • Description
      • Properties
      • Property Descriptions
    • QuadMesh
      • Description
      • Tutorials
      • Properties
    • QuadOccluder3D
      • Description
      • Properties
      • Property Descriptions
    • RDShaderFile
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RDShaderSPIRV
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RectangleShape2D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • RibbonTrailMesh
      • Properties
      • Enumerations
      • Property Descriptions
    • RichTextEffect
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • SceneReplicationConfig
      • Methods
      • Method Descriptions
    • Script
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ScriptExtension
      • Methods
      • Method Descriptions
    • SegmentShape2D
      • Description
      • Properties
      • Property Descriptions
    • SeparationRayShape2D
      • Description
      • Properties
      • Property Descriptions
    • SeparationRayShape3D
      • Description
      • Properties
      • Property Descriptions
    • Shader
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ShaderInclude
      • Properties
      • Property Descriptions
    • ShaderMaterial
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Shape2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Shape3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • Shortcut
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • SkeletonModification2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • SkeletonModification2DCCDIK
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • SkeletonModification2DFABRIK
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • SkeletonModification2DJiggle
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • SkeletonModification2DLookAt
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • SkeletonModification2DPhysicalBones
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • SkeletonModification2DStackHolder
      • Description
      • Methods
      • Method Descriptions
    • SkeletonModification2DTwoBoneIK
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • SkeletonModificationStack2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • SkeletonProfile
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SkeletonProfileHumanoid
      • Description
      • Tutorials
      • Properties
    • Skin
      • Methods
      • Method Descriptions
    • Sky
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • SphereMesh
      • Description
      • Properties
      • Property Descriptions
    • SphereOccluder3D
      • Description
      • Properties
      • Property Descriptions
    • SphereShape3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • SpriteFrames
      • Description
      • Methods
      • Method Descriptions
    • StandardMaterial3D
      • Description
      • Tutorials
    • 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
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SyntaxHighlighter
      • Description
      • Methods
      • Method Descriptions
    • SystemFont
      • Description
      • Properties
      • Property Descriptions
    • TextMesh
      • Description
      • Properties
      • Property Descriptions
    • Texture
      • Description
    • Texture2D
      • Description
      • Methods
      • Method Descriptions
    • Texture2DArray
      • Description
      • Methods
      • Method Descriptions
    • Texture3D
      • Description
      • Methods
      • Method Descriptions
    • TextureLayered
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • Theme
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • TileMapPattern
      • Description
      • Methods
      • Method Descriptions
    • TileSet
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • TileSetAtlasSource
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • TileSetScenesCollectionSource
      • Description
      • Methods
      • Method Descriptions
    • TileSetSource
      • Description
      • Methods
      • Method Descriptions
    • TorusMesh
      • Description
      • Properties
      • Property Descriptions
    • Translation
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • TubeTrailMesh
      • Properties
      • Property Descriptions
    • VideoStream
      • Description
    • VideoStreamTheora
      • Description
      • Methods
      • Method Descriptions
    • ViewportTexture
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • VisualShader
      • Description
      • Properties
      • Methods
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • VisualShaderNode
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • VisualShaderNodeBillboard
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeBooleanConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeBooleanParameter
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeClamp
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeColorConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeColorFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeColorOp
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeColorParameter
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeComment
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeCompare
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeConstant
      • Description
    • VisualShaderNodeCubemap
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeCubemapParameter
      • Description
    • VisualShaderNodeCurveTexture
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeCurveXYZTexture
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeCustom
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • VisualShaderNodeDerivativeFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeDeterminant
      • Description
    • VisualShaderNodeDistanceFade
      • 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
    • VisualShaderNodeFloatParameter
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeFresnel
      • Description
    • VisualShaderNodeGlobalExpression
      • Description
    • VisualShaderNodeGroupBase
      • Description
      • Methods
      • Method Descriptions
    • VisualShaderNodeIf
      • Description
    • VisualShaderNodeInput
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • VisualShaderNodeIntConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeIntFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeIntOp
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeIntParameter
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeIs
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeLinearSceneDepth
      • Description
    • VisualShaderNodeMix
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeMultiplyAdd
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeOuterProduct
      • Description
    • VisualShaderNodeOutput
      • Description
    • VisualShaderNodeParameter
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeParameterRef
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeParticleAccelerator
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeParticleBoxEmitter
      • Description
    • VisualShaderNodeParticleConeVelocity
      • Description
    • VisualShaderNodeParticleEmit
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeParticleEmitter
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeParticleMeshEmitter
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeParticleMultiplyByAxisAngle
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeParticleOutput
      • Description
    • VisualShaderNodeParticleRandomness
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeParticleRingEmitter
      • Description
    • VisualShaderNodeParticleSphereEmitter
      • Description
    • VisualShaderNodeProximityFade
      • Description
    • VisualShaderNodeRandomRange
      • Description
    • VisualShaderNodeRemap
      • Description
    • VisualShaderNodeResizableBase
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeSample3D
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeScreenUVToSDF
      • Description
    • VisualShaderNodeSDFRaymarch
      • Description
    • VisualShaderNodeSDFToScreenUV
      • Description
    • VisualShaderNodeSmoothStep
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeStep
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeSwitch
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeTexture
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeTexture2DArray
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeTexture2DArrayParameter
      • Description
    • VisualShaderNodeTexture2DParameter
      • Description
    • VisualShaderNodeTexture3D
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeTexture3DParameter
      • Description
    • VisualShaderNodeTextureParameter
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeTextureParameterTriplanar
      • Description
    • VisualShaderNodeTextureSDF
      • Description
    • VisualShaderNodeTextureSDFNormal
      • Description
    • VisualShaderNodeTransformCompose
      • Description
    • VisualShaderNodeTransformConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeTransformDecompose
      • Description
    • VisualShaderNodeTransformFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeTransformOp
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeTransformParameter
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeTransformVecMult
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeUIntConstant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeUIntFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeUIntOp
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeUIntParameter
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeUVFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeUVPolarCoord
      • Description
    • VisualShaderNodeVarying
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeVaryingGetter
      • Description
    • VisualShaderNodeVaryingSetter
      • Description
    • VisualShaderNodeVec2Constant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeVec2Parameter
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeVec3Constant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeVec3Parameter
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeVec4Constant
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeVec4Parameter
      • Description
      • Properties
      • Property Descriptions
    • VisualShaderNodeVectorBase
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeVectorCompose
      • Description
    • VisualShaderNodeVectorDecompose
      • Description
    • VisualShaderNodeVectorDistance
      • Description
    • VisualShaderNodeVectorFunc
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeVectorLen
      • Description
    • VisualShaderNodeVectorOp
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • VisualShaderNodeVectorRefract
      • Description
    • VoxelGIData
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • World2D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • World3D
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • WorldBoundaryShape2D
      • Description
      • Properties
      • Property Descriptions
    • WorldBoundaryShape3D
      • Description
      • Properties
      • Property Descriptions
    • X509Certificate
      • Description
      • Methods
      • Method Descriptions
  • Other objects
    • Object
      • Description
      • Tutorials
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Method Descriptions
    • AESContext
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • AnimationTrackEditPlugin
    • AStar2D
      • Description
      • Methods
      • Method Descriptions
    • AStar3D
      • Description
      • Methods
      • Method Descriptions
    • AStarGrid2D
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AudioEffectInstance
      • Methods
      • Method Descriptions
    • AudioEffectSpectrumAnalyzerInstance
      • Methods
      • Enumerations
      • Method Descriptions
    • AudioServer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • AudioStreamGeneratorPlayback
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • AudioStreamPlayback
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • AudioStreamPlaybackOggVorbis
    • AudioStreamPlaybackPolyphonic
      • Description
      • Methods
      • Constants
      • Method Descriptions
    • AudioStreamPlaybackResampled
      • Methods
      • Method Descriptions
    • CallbackTweener
      • Description
      • Methods
      • Method Descriptions
    • CameraFeed
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • CameraServer
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • CharFXTransform
      • Description
      • Tutorials
      • Properties
      • Property Descriptions
    • ClassDB
      • Description
      • Methods
      • Method Descriptions
    • ConfigFile
      • Description
      • Methods
      • Method Descriptions
    • Crypto
      • Description
      • Methods
      • Method Descriptions
    • DirAccess
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • DisplayServer
      • Description
      • Methods
      • Enumerations
      • Constants
      • Method Descriptions
    • DTLSServer
      • Description
      • Methods
      • Method Descriptions
    • EditorDebuggerPlugin
      • Description
      • Methods
      • Method Descriptions
    • EditorDebuggerSession
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • EditorExportPlatform
      • Description
    • EditorExportPlugin
      • Description
      • Methods
      • Method Descriptions
    • EditorFeatureProfile
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • EditorFileSystemDirectory
      • Description
      • Methods
      • Method Descriptions
    • EditorFileSystemImportFormatSupportQuery
      • Description
      • Methods
      • Method Descriptions
    • EditorImportPlugin
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • EditorInspectorPlugin
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • EditorNode3DGizmo
      • Description
      • Methods
      • Method Descriptions
    • EditorPaths
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • EditorResourceConversionPlugin
      • Description
      • Methods
      • Method Descriptions
    • EditorResourcePreviewGenerator
      • Description
      • Methods
      • Method Descriptions
    • EditorSceneFormatImporter
      • Description
      • Methods
      • Constants
      • Method Descriptions
    • EditorSceneFormatImporterBlend
      • Description
    • EditorSceneFormatImporterFBX
      • Description
    • EditorSceneFormatImporterGLTF
    • EditorScenePostImport
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • EditorScenePostImportPlugin
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • EditorScript
      • Description
      • Methods
      • Method Descriptions
    • EditorSelection
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • EditorTranslationParserPlugin
      • Description
      • Methods
      • Method Descriptions
    • EditorUndoRedoManager
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • EditorVCSInterface
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • EncodedObjectAsID
      • Description
      • Properties
      • Property Descriptions
    • ENetConnection
      • Description
      • Tutorials
      • Methods
      • Enumerations
      • Method Descriptions
    • ENetMultiplayerPeer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • ENetPacketPeer
      • Description
      • Tutorials
      • Methods
      • Enumerations
      • Constants
      • Method Descriptions
    • Engine
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • EngineDebugger
      • Description
      • Methods
      • Method Descriptions
    • EngineProfiler
      • Description
      • Methods
      • Method Descriptions
    • Expression
      • Description
      • Methods
      • Method Descriptions
    • FileAccess
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • GDExtensionManager
      • Methods
      • Enumerations
      • Method Descriptions
    • Geometry2D
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • Geometry3D
      • Description
      • Methods
      • Method Descriptions
    • GodotSharp
      • Description
      • Methods
      • Method Descriptions
    • HashingContext
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • HMACContext
      • Description
      • Methods
      • Method Descriptions
    • HTTPClient
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ImageFormatLoader
      • Description
      • Enumerations
    • ImageFormatLoaderExtension
      • Description
      • Methods
      • Method Descriptions
    • Input
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • InputMap
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • IntervalTweener
      • Description
    • IP
      • Description
      • Methods
      • Enumerations
      • Constants
      • Method Descriptions
    • JavaClass
    • JavaClassWrapper
      • Methods
      • Method Descriptions
    • JavaScriptBridge
      • Description
      • Tutorials
      • Methods
      • Signals
      • Method Descriptions
    • JavaScriptObject
      • Description
    • JNISingleton
      • Description
      • Tutorials
    • JSONRPC
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • KinematicCollision2D
      • Description
      • Methods
      • Method Descriptions
    • KinematicCollision3D
      • Description
      • Methods
      • Method Descriptions
    • Lightmapper
      • Description
    • LightmapperRD
      • Description
    • MainLoop
      • Description
      • Methods
      • Signals
      • Constants
      • Method Descriptions
    • Marshalls
      • Description
      • Methods
      • Method Descriptions
    • MeshDataTool
      • Description
      • Methods
      • Method Descriptions
    • MethodTweener
      • Description
      • Methods
      • Method Descriptions
    • MobileVRInterface
      • Description
      • Properties
      • Property Descriptions
    • MovieWriter
      • Description
      • Methods
      • Method Descriptions
    • MultiplayerAPI
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • MultiplayerAPIExtension
      • Description
      • Methods
      • Method Descriptions
    • MultiplayerPeer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • MultiplayerPeerExtension
      • Description
      • Methods
      • Method Descriptions
    • Mutex
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • NavigationMeshGenerator
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • NavigationPathQueryParameters2D
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • NavigationPathQueryParameters3D
      • Description
      • Tutorials
      • Properties
      • Enumerations
      • Property Descriptions
    • NavigationPathQueryResult2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • NavigationPathQueryResult3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • NavigationServer2D
      • Description
      • Tutorials
      • Methods
      • Signals
      • Method Descriptions
    • NavigationServer3D
      • Description
      • Tutorials
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • Node
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Node3DGizmo
    • OfflineMultiplayerPeer
      • Description
    • OggPacketSequencePlayback
    • OpenXRInterface
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • OS
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • PackedDataContainerRef
      • Methods
      • Method Descriptions
    • PacketPeer
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PacketPeerDTLS
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • PacketPeerExtension
      • Methods
      • Method Descriptions
    • PacketPeerStream
      • Description
      • Properties
      • Property Descriptions
    • PacketPeerUDP
      • Description
      • Methods
      • Method Descriptions
    • PCKPacker
      • Description
      • Methods
      • Method Descriptions
    • Performance
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • PhysicsDirectBodyState2D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PhysicsDirectBodyState2DExtension
      • Methods
      • Method Descriptions
    • PhysicsDirectBodyState3D
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PhysicsDirectBodyState3DExtension
      • Methods
      • Method Descriptions
    • PhysicsDirectSpaceState2D
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • PhysicsDirectSpaceState2DExtension
      • Methods
      • Method Descriptions
    • PhysicsDirectSpaceState3D
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • PhysicsDirectSpaceState3DExtension
      • Methods
      • Method Descriptions
    • PhysicsPointQueryParameters2D
      • Description
      • Properties
      • Property Descriptions
    • PhysicsPointQueryParameters3D
      • Description
      • Properties
      • Property Descriptions
    • PhysicsRayQueryParameters2D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PhysicsRayQueryParameters3D
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PhysicsServer2D
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • PhysicsServer2DExtension
      • Methods
      • Method Descriptions
    • PhysicsServer2DManager
      • Description
      • Methods
      • Method Descriptions
    • PhysicsServer3D
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • PhysicsServer3DExtension
      • Methods
      • Method Descriptions
    • PhysicsServer3DManager
      • Description
      • Methods
      • Method Descriptions
    • PhysicsServer3DRenderingServerHandler
      • Methods
      • Method Descriptions
    • PhysicsShapeQueryParameters2D
      • Description
      • Properties
      • Property Descriptions
    • PhysicsShapeQueryParameters3D
      • Description
      • Properties
      • Property Descriptions
    • PhysicsTestMotionParameters2D
      • Description
      • Properties
      • Property Descriptions
    • PhysicsTestMotionParameters3D
      • Description
      • Properties
      • Property Descriptions
    • PhysicsTestMotionResult2D
      • Description
      • Methods
      • Method Descriptions
    • PhysicsTestMotionResult3D
      • Description
      • Methods
      • Method Descriptions
    • ProjectSettings
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • PropertyTweener
      • Description
      • Methods
      • Method Descriptions
    • RandomNumberGenerator
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RDAttachmentFormat
      • Properties
      • Property Descriptions
    • RDFramebufferPass
      • Description
      • Properties
      • Constants
      • Property Descriptions
    • RDPipelineColorBlendState
      • Properties
      • Property Descriptions
    • RDPipelineColorBlendStateAttachment
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RDPipelineDepthStencilState
      • Properties
      • Property Descriptions
    • RDPipelineMultisampleState
      • Properties
      • Property Descriptions
    • RDPipelineRasterizationState
      • Properties
      • Property Descriptions
    • RDPipelineSpecializationConstant
      • Properties
      • Property Descriptions
    • RDSamplerState
      • Properties
      • Property Descriptions
    • RDShaderSource
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RDTextureFormat
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RDTextureView
      • Properties
      • Property Descriptions
    • RDUniform
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RDVertexAttribute
      • Properties
      • Property Descriptions
    • RefCounted
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • RegEx
      • Description
      • Methods
      • Method Descriptions
    • RegExMatch
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • RenderingDevice
      • Methods
      • Enumerations
      • Constants
      • Method Descriptions
    • RenderingServer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Property Descriptions
      • Method Descriptions
    • Resource
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • ResourceFormatLoader
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • ResourceFormatSaver
      • Description
      • Methods
      • Method Descriptions
    • ResourceImporter
      • Description
      • Tutorials
      • Enumerations
    • ResourceLoader
      • Description
      • Tutorials
      • Methods
      • Enumerations
      • Method Descriptions
    • ResourceSaver
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • ResourceUID
      • Description
      • Methods
      • Constants
      • Method Descriptions
    • SceneMultiplayer
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • SceneState
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • SceneTree
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SceneTreeTimer
      • Description
      • Properties
      • Signals
      • Property Descriptions
    • ScriptLanguage
    • ScriptLanguageExtension
      • Methods
      • Enumerations
      • Method Descriptions
    • Semaphore
      • Description
      • Tutorials
      • Methods
      • Method Descriptions
    • SkinReference
      • Methods
      • Method Descriptions
    • StreamPeer
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • StreamPeerBuffer
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • StreamPeerExtension
      • Methods
      • Method Descriptions
    • StreamPeerGZIP
      • Description
      • Methods
      • Method Descriptions
    • StreamPeerTCP
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • StreamPeerTLS
      • Description
      • Tutorials
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • SurfaceTool
      • Description
      • Tutorials
      • Methods
      • Enumerations
      • Method Descriptions
    • TCPServer
      • Description
      • Methods
      • Method Descriptions
    • TextLine
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • TextParagraph
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • TextServer
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • TextServerAdvanced
    • TextServerDummy
    • TextServerExtension
      • Description
      • Methods
      • Method Descriptions
    • TextServerFallback
    • TextServerManager
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • ThemeDB
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • Thread
      • Description
      • Tutorials
      • Methods
      • Enumerations
      • Method Descriptions
    • TileData
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • Time
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • TranslationServer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • TreeItem
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • TriangleMesh
      • Description
    • Tween
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • Tweener
      • Description
      • Signals
    • UDPServer
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • 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
    • WeakRef
      • Description
      • Methods
      • Method Descriptions
    • WebRTCDataChannel
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • WebRTCDataChannelExtension
      • Methods
      • Method Descriptions
    • WebRTCMultiplayerPeer
      • Description
      • Methods
      • Method Descriptions
    • WebRTCPeerConnection
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • WebRTCPeerConnectionExtension
      • Methods
      • Method Descriptions
    • WebSocketMultiplayerPeer
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • WebSocketPeer
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • WebXRInterface
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • WorkerThreadPool
      • Methods
      • Method Descriptions
    • XMLParser
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • XRInterface
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • XRInterfaceExtension
      • Description
      • Methods
      • Method Descriptions
    • XRPose
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • XRPositionalTracker
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • XRServer
      • Description
      • Tutorials
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • ZIPPacker
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • ZIPReader
      • Description
      • Methods
      • Method Descriptions
  • Variant types
    • AABB
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Array
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Basis
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • bool
      • Description
      • Constructors
      • Operators
      • Constructor Descriptions
      • Operator Descriptions
    • Callable
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Color
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Dictionary
      • Description
      • Tutorials
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • float
      • Description
      • Tutorials
      • Constructors
      • Operators
      • Constructor Descriptions
      • Operator Descriptions
    • int
      • Description
      • Constructors
      • Operators
      • Constructor Descriptions
      • Operator Descriptions
    • NodePath
      • Description
      • Tutorials
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Object
      • Description
      • Tutorials
      • Methods
      • Signals
      • Enumerations
      • Constants
      • Method Descriptions
    • PackedByteArray
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • PackedColorArray
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • PackedFloat32Array
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • PackedFloat64Array
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • PackedInt32Array
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • PackedInt64Array
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • PackedStringArray
      • Description
      • Tutorials
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • PackedVector2Array
      • Description
      • Tutorials
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • PackedVector3Array
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Plane
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Projection
      • Description
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Quaternion
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Rect2
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Rect2i
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • RID
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Signal
      • Description
      • Tutorials
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • String
      • Description
      • Tutorials
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • StringName
      • Description
      • Constructors
      • Methods
      • Operators
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Transform2D
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Transform3D
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Variant
      • Description
      • Tutorials
    • Vector2
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Vector2i
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Vector3
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Vector3i
      • Description
      • Tutorials
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Vector4
      • Description
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
    • Vector4i
      • Description
      • Properties
      • Constructors
      • Methods
      • Operators
      • Constants
      • Property Descriptions
      • Constructor Descriptions
      • Method Descriptions
      • Operator Descriptions
Godot Engine
  • All classes
  • NavigationAgent3D

NavigationAgent3D¶

Inherits: Node < Object

3D Agent used in navigation for collision avoidance.

Description¶

3D Agent that is used in navigation to reach a position while avoiding static and dynamic obstacles. The dynamic obstacles are avoided using RVO collision avoidance. The agent needs navigation data to work correctly. NavigationAgent3D is physics safe.

Note: After setting target_position it is required to use the get_next_path_position function once every physics frame to update the internal path logic of the NavigationAgent. The returned vector position from this function should be used as the next movement position for the agent's parent Node.

Tutorials¶

  • Using NavigationAgents

Properties¶

float

agent_height_offset

0.0

bool

avoidance_enabled

false

bool

ignore_y

true

int

max_neighbors

10

float

max_speed

10.0

int

navigation_layers

1

float

neighbor_distance

50.0

float

path_desired_distance

1.0

float

path_max_distance

3.0

PathMetadataFlags

path_metadata_flags

7

float

radius

1.0

float

target_desired_distance

1.0

Vector3

target_position

Vector3(0, 0, 0)

float

time_horizon

5.0

Methods¶

float

distance_to_target ( ) const

PackedVector3Array

get_current_navigation_path ( ) const

int

get_current_navigation_path_index ( ) const

NavigationPathQueryResult3D

get_current_navigation_result ( ) const

Vector3

get_final_position ( )

bool

get_navigation_layer_value ( int layer_number ) const

RID

get_navigation_map ( ) const

Vector3

get_next_path_position ( )

RID

get_rid ( ) const

bool

is_navigation_finished ( )

bool

is_target_reachable ( )

bool

is_target_reached ( ) const

void

set_navigation_layer_value ( int layer_number, bool value )

void

set_navigation_map ( RID navigation_map )

void

set_velocity ( Vector3 velocity )


Signals¶

link_reached ( Dictionary details )

Notifies when a navigation link has been reached.

The details dictionary may contain the following keys depending on the value of path_metadata_flags:

  • position: The start position of the link that was reached.

  • type: Always NavigationPathQueryResult3D.PATH_SEGMENT_TYPE_LINK.

  • rid: The RID of the link.

  • owner: The object which manages the link (usually NavigationLink3D).


navigation_finished ( )

Notifies when the final position is reached.


path_changed ( )

Notifies when the navigation path changes.


target_reached ( )

Notifies when the player-defined target_position is reached.


velocity_computed ( Vector3 safe_velocity )

Notifies when the collision avoidance velocity is calculated. Emitted by set_velocity. Only emitted when avoidance_enabled is true.


waypoint_reached ( Dictionary details )

Notifies when a waypoint along the path has been reached.

The details dictionary may contain the following keys depending on the value of path_metadata_flags:

  • position: The position of the waypoint that was reached.

  • type: The type of navigation primitive (region or link) that contains this waypoint.

  • rid: The RID of the containing navigation primitive (region or link).

  • owner: The object which manages the containing navigation primitive (region or link).


Property Descriptions¶

float agent_height_offset = 0.0

  • void set_agent_height_offset ( float value )

  • float get_agent_height_offset ( )

The NavigationAgent height offset is subtracted from the y-axis value of any vector path position for this NavigationAgent. The NavigationAgent height offset does not change or influence the navigation mesh or pathfinding query result. Additional navigation maps that use regions with navigation meshes that the developer baked with appropriate agent radius or height values are required to support different-sized agents.


bool avoidance_enabled = false

  • void set_avoidance_enabled ( bool value )

  • bool get_avoidance_enabled ( )

If true the agent is registered for an RVO avoidance callback on the NavigationServer3D. When set_velocity is used and the processing is completed a safe_velocity Vector3 is received with a signal connection to velocity_computed. Avoidance processing with many registered agents has a significant performance cost and should only be enabled on agents that currently require it.


bool ignore_y = true

  • void set_ignore_y ( bool value )

  • bool get_ignore_y ( )

Ignores collisions on the Y axis. Must be true to move on a horizontal plane.


int max_neighbors = 10

  • void set_max_neighbors ( int value )

  • int get_max_neighbors ( )

The maximum number of neighbors for the agent to consider.


float max_speed = 10.0

  • void set_max_speed ( float value )

  • float get_max_speed ( )

The maximum speed that an agent can move.


int navigation_layers = 1

  • void set_navigation_layers ( int value )

  • int get_navigation_layers ( )

A bitfield determining what navigation layers of navigation regions this NavigationAgent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new navigation layers.


float neighbor_distance = 50.0

  • void set_neighbor_distance ( float value )

  • float get_neighbor_distance ( )

The distance to search for other agents.


float path_desired_distance = 1.0

  • void set_path_desired_distance ( float value )

  • float get_path_desired_distance ( )

The distance threshold before a path point is considered to be reached. This will allow an agent to not have to hit a path point on the path exactly, but in the area. If this value is set to high the NavigationAgent will skip points on the path which can lead to leaving the navigation mesh. If this value is set to low the NavigationAgent will be stuck in a repath loop cause it will constantly overshoot or undershoot the distance to the next point on each physics frame update.


float path_max_distance = 3.0

  • void set_path_max_distance ( float value )

  • float get_path_max_distance ( )

The maximum distance the agent is allowed away from the ideal path to the final position. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path.


PathMetadataFlags path_metadata_flags = 7

  • void set_path_metadata_flags ( PathMetadataFlags value )

  • PathMetadataFlags get_path_metadata_flags ( )

Additional information to return with the navigation path.


float radius = 1.0

  • void set_radius ( float value )

  • float get_radius ( )

The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by neighbor_distance).

Does not affect normal pathfinding. To change an actor's pathfinding radius bake NavigationMesh resources with a different NavigationMesh.agent_radius property and use different navigation maps for each actor size.


float target_desired_distance = 1.0

  • void set_target_desired_distance ( float value )

  • float get_target_desired_distance ( )

The distance threshold before the final target point is considered to be reached. This will allow an agent to not have to hit the point of the final target exactly, but only the area. If this value is set to low the NavigationAgent will be stuck in a repath loop cause it will constantly overshoot or undershoot the distance to the final target point on each physics frame update.


Vector3 target_position = Vector3(0, 0, 0)

  • void set_target_position ( Vector3 value )

  • Vector3 get_target_position ( )

The user-defined target position. Setting this property will clear the current navigation path.


float time_horizon = 5.0

  • void set_time_horizon ( float value )

  • float get_time_horizon ( )

The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. Must be positive.


Method Descriptions¶

float distance_to_target ( ) const

Returns the distance to the target position, using the agent's global position. The user must set target_position in order for this to be accurate.


PackedVector3Array get_current_navigation_path ( ) const

Returns this agent's current path from start to finish in global coordinates. The path only updates when the target position is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended get_next_path_position once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic.


int get_current_navigation_path_index ( ) const

Returns which index the agent is currently on in the navigation path's PackedVector3Array.


NavigationPathQueryResult3D get_current_navigation_result ( ) const

Returns the path query result for the path the agent is currently following.


Vector3 get_final_position ( )

Returns the reachable final position in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.


bool get_navigation_layer_value ( int layer_number ) const

Returns whether or not the specified layer of the navigation_layers bitmask is enabled, given a layer_number between 1 and 32.


RID get_navigation_map ( ) const

Returns the RID of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use set_navigation_map to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer.


Vector3 get_next_path_position ( )

Returns the next position in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent.


RID get_rid ( ) const

Returns the RID of this agent on the NavigationServer3D.


bool is_navigation_finished ( )

Returns true if the navigation path's final position has been reached.


bool is_target_reachable ( )

Returns true if target_position is reachable.


bool is_target_reached ( ) const

Returns true if target_position is reached. It may not always be possible to reach the target position. It should always be possible to reach the final position though. See get_final_position.


void set_navigation_layer_value ( int layer_number, bool value )

Based on value, enables or disables the specified layer in the navigation_layers bitmask, given a layer_number between 1 and 32.


void set_navigation_map ( RID navigation_map )

Sets the RID of the navigation map this NavigationAgent node should use and also updates the agent on the NavigationServer.


void set_velocity ( Vector3 velocity )

Sends the passed in velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the velocity_computed signal.

Previous Next

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

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Languages
en
de
es
fr
Versions
latest
stable
3.6
3.5
3.4
3.3
3.2
3.1
3.0
2.1
On Read the Docs
Project Home
Builds
Downloads

Hosted by Read the Docs · Privacy Policy