Logo
3.0

General

  • About
    • Introduction
      • About Godot Engine
      • About the documentation
      • Organisation 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 languages are supported in Godot?
      • GDScript? Why use a custom scripting language instead of my language of choice?
      • I don’t believe you. What are the technical reasons for the item above?
      • I want to extend Godot. What are my options for creating plugins?
      • Why is FBX not supported for import?
      • Will [Insert closed SDK such as PhysX, GameWorks, etc.] be supported in Godot?
      • How should assets be created to handle multiple resolutions and aspect ratios?
      • I have a great idea that will make Godot better. What do you think?
      • How can I support Godot development or contribute?
      • Who is working on Godot? How can I contact you?

Getting started

  • Step by step
    • Introduction to Godot’s editor
      • Project manager
        • Create or import a project
      • Your first look at Godot’s editor
      • The workspaces
      • Modify the interface
        • Move and resize docks
    • Scenes and nodes
      • Introduction
      • Nodes
      • Scenes
      • Creating a new project
      • Editor
      • Configuring the project
      • To be continued…
    • Instancing
      • Introduction
      • Instancing By Example
      • Multiple Instances
      • Editing instances
      • Conclusion
    • Instancing (continued)
      • Recap
      • Design language
      • Information overload!
    • Scripting
      • Introduction
        • GDScript
        • VisualScript
        • .NET / C#
        • GDNative / C++
      • Scripting a scene
        • Scene setup
        • Adding a script
        • The role of the script
        • Handling a signal
    • Scripting (continued)
      • Processing
      • Groups
      • Notifications
      • Overrideable functions
      • Creating nodes
      • Instancing scenes
    • Your First Game
      • Overview
      • Project Setup
        • Organizing the Project
      • Player Scene
        • Node Structure
        • Sprite Animation
        • Moving the Player
        • Choosing Animations
        • Preparing for Collisions
      • Enemy Scene
        • Node Setup
        • Enemy Script
      • Main Scene
        • Spawning Mobs
        • Main Script
      • HUD
        • ScoreLabel
        • MessageLabel
        • StartButton
        • Connecting HUD to Main
      • Finishing Up
        • Background
        • Sound Effects
        • Particles
      • Project Files
    • Godot’s design philosophy
      • Object-oriented design and composition
      • All-inclusive package
      • Open-source
      • Community-driven
      • The Godot editor is a Godot game
      • Separate 2D and 3D engines
    • Design interfaces with the Control nodes
      • The 5 most common UI elements
        • TextureRect
        • TextureButton
        • TextureProgress
        • Label
        • NinePatchRect
      • There are two workflows to build responsive UIs
      • Place UI elements precisely with anchors
        • How to change the anchor
        • Anchors are relative to the parent container
        • Margins change with the anchor
        • Use size tags to change how UI elements fill the available space
      • Arrange control nodes automatically with containers
        • The 5 most useful containers
    • Design a title screen
      • How to design your game UI
      • Design the main menu
        • Break down the UI mockup
        • Prepare the Main Menu scene
        • Add the UI sprites
        • Add containers to place UI elements automatically
        • Break down the UI mockup
    • Design the GUI
      • Breaking down the UI
      • Create the base GUI
        • Create the bars’ base
        • Replace the Label’s font
        • Add the progress bar
      • Design the bomb and rupee counters
      • Turn the bar and counter into reusable UI components
      • Use Scene Inheritance to create the remaining elements
        • Inherit the Bar Scene to build the LifeBar
        • Design the EnergyBar
        • Prepare the bomb and rupee counters
      • Add the UI components to the final GUI
      • Place the GUI onto the game’s mockup
    • Control the game’s UI with code
      • Intro
      • Download and explore the start project
      • Set up the Lifebar with the Player’s max_health
      • Update health with a signal when the player takes a hit
      • Animate the loss of life with the Tween node
      • Assign the animated_health to the LifeBar
      • Fade the bar when the Player dies
    • Splash screen
      • Tutorial
      • Setting up
    • Animations
      • Introduction
      • Add an animation player
      • Creating the animation
      • Editing the animation
    • Resources
      • Nodes and resources
      • External vs built-in
      • Loading resources from code
      • Loading scenes
      • Freeing resources
      • Scripting
    • File system
      • Introduction
      • Implementation
      • project.godot
      • Path delimiter
      • Resource path
      • User path
      • Host file system
      • Drawbacks
    • SceneTree
      • Introduction
      • MainLoop
      • SceneTree
      • Root viewport
      • Scene tree
      • Tree order
      • “Becoming active” by entering the Scene Tree
      • Changing current scene
    • Singletons (AutoLoad)
      • Introduction
      • AutoLoad
      • Custom scene switcher
      • global.gd
  • Editor manual
    • From Unity3D to Godot Engine
      • Differences
      • The editor
      • The scene system
      • Project organization
      • Where are my prefabs?
      • Glossary correspondence
      • Scripting: GDScript, C# and Visual Script
        • Design
        • Connections : groups and signals
      • Using Godot in C++
    • Command line tutorial
      • 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
  • Scripting
    • GDScript
      • GDScript
        • Introduction
        • Language
        • Built-in types
        • Data
      • GDScript: An introduction to dynamic languages
        • About
        • Dynamic nature
        • Arrays
        • Dictionaries
        • For & while
        • While
        • Custom iterators
        • Duck typing
      • GDScript Style Guide
        • Description
        • Code Structure
        • Naming Conventions
      • GDScript format strings
        • Usage in GDScript
        • Multiple placeholders
        • Format specifiers
        • Padding
        • Escape sequence
        • Format method examples
    • VisualScript
      • What is Visual Scripting
      • Getting started with Visual Scripting
        • Creating a Script
        • Adding a Function
      • Nodes and Terminology
        • Node Properties
        • Ports and Connections
        • Adding Nodes
        • Adding More Nodes
    • C#
      • Introduction
        • Setup C# for Godot
        • Configuring an external editor
        • Creating a C# script
        • Project setup and workflow
        • Example
        • General differences between C# and GDScript
        • Current gotchas and known issues
        • Performance of C# in Godot
        • Using Nuget Packages in Godot
      • Features
        • Type Conversion and Casting
        • C# Signals
      • API differences to GDScript
        • General Differences
        • Global Scope
        • Math
        • Random
        • Export keyword
        • Signal keyword
        • Singletons
        • String
        • Basis
        • Transform2D
        • Plane
        • Rect2
        • Quat
        • Array
        • Dictionary
        • Variant
        • Communicating with other scripting languages
        • Other differences
      • Style Guide
        • Language Specification
        • Formatting Conventions
        • Line Breaks and Blank Lines
        • Using Spaces
        • Naming Conventions
        • Implicitly Typed Local Variables
        • Other Considerations
  • Project workflow
    • Project setup
      • Project organization
        • Introduction
        • Organization
        • Importing
    • Assets workflow
      • Import process
        • Importing assets in Godot 3.0+
        • Changing import parameters
        • Automatic reimport
        • Files generated
        • Changing import resource type
        • Changing default import parameters
        • Simplicity is key!
      • Importing Images
        • Why importing them?
        • Importing Textures
        • Compression:
        • Flags
        • Mipmaps
        • Process
        • Detect 3D
      • Importing audio samples
        • Why importing?
        • Best Practices
      • Importing translations
        • Games and internationalization
        • Translation format
        • CSV Importer
      • Importing 3D Scenes
        • Godot Scene Importer
        • Import workflows
        • Import Options
        • Animation Options
        • Scene Inheritance
        • Import Hints
      • Godot-Blender-Exporter
        • Details on exporting
        • Disabling specific objects
        • Build Pipeline Integration
    • Export
      • Exporting projects
        • Why exporting?
        • Export menu
        • Export from Command Line
      • Feature Tags
        • Introduction
        • Default features
        • Custom features
        • Overriding project settings
        • Default overrides
        • Customizing Build
      • Exporting for PC
      • Exporting for iOS
        • Requirements
        • Export a Godot project to Xcode
        • Active development considerations
        • Services for iOS
      • Exporting for Universal Windows Platform
        • Limitations on Xbox One
        • Creating a signing certificate
        • Signing the package
        • Installing the package
      • Exporting for Android
        • Download the Android SDK
        • Install OpenJDK or Oracle JDK
        • Create a debug.keystore
        • Make sure you have adb
        • Setting it up in Godot
      • Exporting for the Web
        • Limitations
        • Serving the files
        • Export options
        • Calling JavaScript from script
      • Customizing the Web export HTML page
        • Placeholder substitution
        • The Engine object
        • Starting an Engine instance
        • Configuring start-up behaviour
        • Customizing the presentation
        • Accessing the Emscripten Module
      • One-click deploy
        • Sounds good, what is it?
        • Steps for one-click deploy
      • Changing application icon for windows
        • Changing the taskbar icon
        • Changing the file icon
        • Testing the result
        • Icon (ICO) file requirements

Tutorials

  • 2D
    • Canvas layers
      • Viewport and Canvas items
      • Not enough…
      • CanvasLayers
      • Performance
    • Viewport and canvas transforms
      • Introduction
      • Canvas transform
      • Global canvas transform
      • Stretch transform
      • Transform order
      • Transform functions
      • Feeding custom input events
    • Using tilemaps
      • Introduction
      • Making a tileset
      • TileSet scene
      • Collision
      • Exporting a TileSet
      • Using the TileSet in a TileMap
      • Painting your world
      • Offset and scaling artifacts
    • Custom drawing in 2D
      • Why?
      • But…
      • OK, how?
      • Updating
      • An example: drawing circular arcs
        • Arc function
        • Draw the arc on screen
        • Arc polygon function
        • Dynamic custom drawing
      • Tools
    • Particle Systems (2D)
      • Intro
        • Particles2D
        • ParticlesMaterial
        • Texture
      • Time Parameters
        • Lifetime
        • One Shot
        • Preprocess
        • Speed Scale
        • Explosiveness
        • Randomness
        • Fixed FPS
        • Fract Delta
      • Drawing Parameters
        • Visibility Rect
        • Local Coords
        • Draw Order
      • ParticlesMaterial settings
        • Direction
        • Spread
        • Gravity
        • Initial Velocity
        • Angular Velocity
        • Spin Velocity
        • Orbit Velocity
        • Linear Acceleration
        • Radial Acceleration
        • Tangential Acceleration
        • Damping
        • Angle
        • Scale
        • Color
        • Hue variation
    • 2D Movement Overview
      • Introduction
      • Setup
      • 8-Way Movement
      • Rotation + Movement
      • Rotation + Movement (mouse)
      • Click-and-Move
      • Summary
  • 3D
    • Introduction to 3D
      • Spatial node
      • 3D content
        • DCC-created models
        • Generated geometry
        • Immediate geometry
        • 2D in 3D
      • Environment
      • 3D viewport
        • Coordinate system
        • Space and manipulation gizmos
        • View menu
        • Default environment
        • Cameras
        • Lights
    • Using 3D transforms in Godot
      • 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 performance and limitations
      • Introduction
      • Rendering
        • Reuse shaders and materials
        • Pixels cost vs vertex cost
        • Texture compression
        • Transparent objects
        • Level of detail (LOD)
        • Use instancing (MultiMesh)
        • Bake lighting
    • Spatial Material
      • Introduction
      • Flags
        • Transparent
        • Unshaded
        • Vertex Lighting
        • No Depth Test
        • Use Point Size
        • World Triplanar
        • Fixed Size
        • Do Not Receive Shadows
      • Vertex Color
        • Use as Albedo
        • Is SRGB
      • Parameters
        • Diffuse Mode
        • Specular Mode
        • Blend Mode
        • Cull Mode
        • Depth Draw Mode
        • Line Width
        • Point Size
        • Billboard Mode
        • Grow
        • Use Alpha Scissor
      • Material colors, maps and channels
        • Albedo
        • Metallic
        • Roughness
        • Emission
        • Normalmap
        • Rim
        • Clearcoat
        • Anisotropy
        • Ambient Occlusion
        • Depth
        • Subsurface Scattering
        • Transmission
        • Refraction
        • Detail
        • UV1 and UV2
        • Triplanar Mapping
      • Proximity and Distance Fade
      • Render Priority
    • Lights And Shadows
      • Introduction
      • Light nodes
        • Shadow Mapping
        • Directional Shadow Mapping
        • Omni Shadow Mapping
        • Spot Shadow Mapping
    • Reflection Probes
      • Introduction
      • Setting Up
      • Interior vs Exterior
      • Blending
      • Reflection Atlas
    • GI Probes
      • Introduction
      • Setting Up
      • Adding Lights
      • Reflections
      • Interior vs Exterior
      • Tweaking
      • Quality
    • Baked Lightmaps
      • Introduction
      • Visual Comparison
      • Setting Up
        • Unwrap from your 3D DCC
        • Unwrap from within Godot
        • Unwrap on Scene import
        • Checking UV2
      • Setting up the Scene
        • Configure Bounds
        • Setting Up Meshes
        • Setting up Lights
        • Baking Quality
      • Baking
        • Configuring Bake
      • Dynamic Objects
    • Environment and Post-Processing
      • Environment
        • Camera Node
        • WorldEnvironment Node
        • Default Environment
      • Environment Options
        • Background
        • Ambient Light
        • Fog
        • Tonemap
        • Auto Exposure (HDR)
      • Mid and Post-Processing Effects
        • Screen-Space Reflections (SSR)
        • Screen-Space Ambient Occlusion (SSAO)
        • Depth of Field / Far Blur
        • Depth of Field / Near Blur
        • Glow
        • Adjustments
    • High dynamic range
      • Introduction
      • Linear color space
      • Linear color space & asset pipeline
        • SRGB -> linear conversion on image import
        • Hardware sRGB -> linear conversion.
        • Linear -> sRGB at the end.
      • Parameters of HDR
        • ToneMapper
        • Exposure
        • White
        • Glow threshold
        • Glow scale
        • Min luminance
        • Max luminance
        • Exposure adjustment speed
    • Using gridmaps
      • Introduction
      • Example Project
      • Creating a MeshLibrary
      • Collisions
      • Exporting the MeshLibrary
      • Using GridMap
      • Using gridmap in code
    • Using MultiMeshInstance
      • Introduction
      • Setting up the nodes
      • MultiMesh Settings
        • Target Surface
        • Source Mesh
        • Mesh Up Axis
        • Random Rotation
        • Random Tilt
        • Random Scale
        • Scale
        • Amount
    • Working with 3D skeletons
      • Skeleton node
      • Skeleton class
      • Using 3D “bones” for mesh control
      • Using 3D “bones” to implement Inverse Kinematics
      • Using 3D “bones” to implement ragdoll-like physics
    • Inverse kinematics
      • Initial problem
      • Implementation
    • Vertex displacement with shaders
      • Introduction
      • The plane mesh
      • Shader magic
      • Noise
      • Fragment Shader
      • Uniforms
      • Interacting with light
    • FPS tutorial
      • Part 1
        • Tutorial introduction
        • Part Overview
        • Getting everything ready
        • Making the FPS movement logic
        • Giving the player a flash light and the option to sprint
        • Final notes
      • Part 2
        • Part Overview
        • Making a system to handle animations
        • Getting the animations ready
        • Creating the bullet scene
        • Creating the first weapon
        • Creating the other two weapons
        • Making the weapons work
        • Creating some test subjects
        • Final notes
      • Part 3
        • Part Overview
        • Changing levels
        • Adding ammo
        • Adding reloading to the weapons
        • Adding reloading to the player
        • Adding sounds
        • Final notes
      • Part 4
        • Part Overview
        • Adding joypad input
        • Adding mouse scroll wheel input
        • Adding the health pick ups
        • Adding the ammo pick ups
        • Adding breakable targets
        • Final notes
      • Part 5
        • Part Overview
        • Adding grenades
        • Adding grenades to the player
        • Adding the ability to grab and throw RigidBody nodes to the player
        • Adding a turret
        • Final notes
      • Part 6
        • Part Overview
        • Adding the main menu
        • Making the Globals singleton
        • Adding the debug menu
        • Adding a pause menu
        • Starting the respawn system
        • Finishing the respawn system
        • Writing a sound system we can use anywhere
        • Final notes
  • Audio
    • Audio Buses
      • Introduction
      • Decibel Scale
      • Audio Buses
      • Playback of Audio to a Bus
      • Adding Effects
        • Amplify
        • BandLimit and BandPass
        • Chorus
        • Compressor
        • Delay
        • Distortion
        • EQ6, EQ10, EQ21
        • HighPassFilter, HighShelfFilter
        • Limiter
        • LowPassFilter, LowShelfFilter
        • NotchFilter
        • Panner
        • Phaser
        • PitchShift
        • Reverb
        • StereoEnhance
      • Automatic Bus Disabling
      • Bus Rearrangement
      • Default Bus Layout
    • Audio Streams
      • Introduction
      • AudioStream
      • AudioStreamPlayer
      • AudioStreamPlayer2D
      • AudioStreamPlayer3D
        • Reverb Buses
        • Doppler
  • Physics
    • Physics introduction
      • Collision Objects
        • Collision Shapes
        • Physics process callback
        • Collision Layers and Masks
      • Area2D
      • StaticBody2D
      • RigidBody2D
        • Rigid body modes
        • Using RigidBody2D
        • Contact reporting
      • KinematicBody2D
        • Kinematic collision response
    • Rigid Body
      • What is a rigid body?
      • How to control rigid body
      • Look at function
    • Using KinematicBody2D
      • Introduction
      • What is a kinematic body?
      • Movement and Collision
        • move_and_collide
        • move_and_slide
      • 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
    • Kinematic Character (2D)
      • Introduction
      • Physics process
      • Scene setup
      • Moving the Kinematic character
  • Math
    • Vector math
      • Introduction
      • Coordinate systems (2D)
      • Vector Operations
      • Practical applications
      • 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
    • Matrices and transforms
      • Introduction
      • Oriented coordinate system (OCS)
      • Basis
      • Transforms in Godot
      • Transform2D
      • Identity
      • Operations
      • Rotation
      • Translation
      • Local to global coordinates and vice versa
      • Scale
      • Transform
      • Inverse transform
      • Orthonormal matrices
      • Affine inverse
      • Matrix multiplication
      • Multiplication by inverse
      • Multiplication by identity
      • Matrix tips
      • Matrices & transforms in 3D
      • Basis
      • Rotation in 3D
      • Transform
  • Animation
    • Introduction to the 2D animation features
      • Overview
      • Create an AnimationPlayer node
      • Computer animation relies on keyframes
      • Tutorial: Creating a simple animation
        • Scene setup
        • Adding a track
        • The second keyframe
        • Run the animation
        • Back and forth
        • Track settings
      • Keyframes for other properties
      • Edit keyframes
      • Advanced: Call Func tracks
      • References
        • Animation panel reference
    • Cutout animation
      • What is it?
      • Cutout in Godot
      • Making of GBot!
      • Setting up the rig
      • Adjusting the pivot
      • RemoteTransform2D node
      • Completing the skeleton
      • Skeletons
      • IK chains
      • Animation
        • 2D animation
      • Rest pose
      • Rotation
      • Keyframing IK
      • Moving sprites above and behind others.
      • Batch setting transition curves
  • Inputs
    • InputEvent
      • What is it?
      • How does it work?
      • Anatomy of an InputEvent
      • Actions
      • InputMap
    • Mouse and input coordinates
      • About
      • Hardware display coordinates
      • Viewport display coordinates
    • Customizing mouse cursor
      • Using project settings
      • Using a script
      • Demo project
      • Cursor list
  • I/O
    • Background loading
      • ResourceInteractiveLoader
      • Usage
        • Obtaining a ResourceInteractiveLoader
        • Polling
        • Load progress (optional)
        • Forcing completion (optional)
        • Obtaining the resource
      • Example
      • Using multiple threads
        • Use a Semaphore
        • Not blocking main thread during the polling
      • Example class
        • Example:
    • Data paths
      • Path separators
      • Resource path
      • User path (persistent data)
    • Saving games
      • Introduction
      • Identify persistent objects
      • Serializing
      • Saving and reading data
      • Some notes
  • Internationalization
    • Internationalizing games
      • Introduction
      • Configuring the imported translation
      • Localizing resources
      • Converting keys to text
      • Making controls resizable
      • TranslationServer
      • Command line
      • Translating the project name
    • Locales
  • GUI
    • GUI skinning
      • Oh beautiful GUI!
      • Theme
      • Theme options
      • Customizing a control
      • Creating a theme
      • Example: theming a button
    • Custom GUI controls
      • So many controls…
      • Drawing
        • Checking control size
        • Checking focus
      • Sizing
      • Input
        • Input events
        • Notifications
    • Size and anchors
    • BBCode in RichTextLabel
      • Introduction
      • Setting up
      • Reference
        • Built-in color names
        • Hexadecimal color codes
  • Viewports
    • Viewports
      • Introduction
      • Input
      • Listener
      • Cameras (2D & 3D)
      • Scale & stretching
      • Worlds
      • Capture
      • Viewport Container
      • Rendering
      • Render target
    • Multiple resolutions
      • Base resolution
      • Resizing
      • Stretch settings
      • Stretch mode
      • Stretch aspect
  • Shading
    • Shading language
      • Introduction
      • Shader Types
      • Render Modes
      • Data types
        • Casting
        • Members
        • Constructing
        • Swizzling
        • Precision
      • Operators:
      • Flow Control
      • Discarding
      • Functions
      • Processor Functions
        • Vertex Processor
        • Fragment Processor
        • Light Processor
        • Varyings
        • Interpolation qualifiers
        • Uniforms
      • Built-in Functions
      • Shader Types In-Depth
        • Spatial
        • Canvas Item
        • Particles
    • Shader materials
      • Introduction
      • Creating a ShaderMaterial
      • Converting to ShaderMaterial
    • Screen-reading shaders
      • Introduction
      • SCREEN_TEXTURE built-in texture.
      • SCREEN_TEXTURE example
      • Behind the scenes
      • Back-buffer logic
      • DEPTH_TEXTURE
  • Networking
    • High level multiplayer
      • High level vs low level API
      • Mid level abstraction
      • Initializing the network
      • Managing connections
      • RPC
      • Back to lobby
      • Starting the game
        • Player scenes
        • Synchronizing game start
      • Synchronizing the game
        • Network master
        • Master and slave keywords
    • 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
  • Asset Library
    • About the Asset Library
      • Frequently asked questions
        • Can paid assets be uploaded to the asset library?
    • Using the AssetLib
      • On the website
        • Overview
        • Searching
        • Breakdown of an asset
        • Registering and logging in
      • In the editor
    • Submitting to the Asset Library
      • Introduction
      • Submitting
      • Submission guidelines
  • VR
    • An AR/VR Primer for Godot
      • AR/VR Server
      • New AR/VR Nodes
      • Other things to consider
  • Plugins
    • Editor plugins
      • Making Plugins
        • About Plugins
        • Creating a plugin
        • A custom node
        • Going beyond
      • Import plugins
        • Introduction
        • Configuration
        • The EditorImportPlugin class
        • Options and presets
        • The import method
        • Platform variants and generated files
        • Trying the plugin
    • GDNative
      • GDNative C example
        • Introduction
        • Prerequisites
        • Our C source
        • Compiling
        • Creating our GDNLIB file
        • Putting it all together
        • Creating our GDNS file
      • GDNative C++ example
        • Introduction
        • Setting up your project
        • Building the C++ bindings
        • Creating a simple plugin
        • Compiling our plugin
        • Using your GDNative module
        • Next steps
  • Platform-specific
    • Android in-app purchases
      • Getting the product details
      • Check if user purchased an item
      • Simple Purchase
      • Consumables and Non-Consumables
      • Testing
    • Services for iOS
      • Asynchronous methods
      • Store Kit
        • purchase
        • request_product_info
      • Game Center
        • post_score
        • award_achievement
        • reset_achievements
        • request_achievements
        • request_achievement_descriptions
        • show_game_center
      • Multi-platform games
    • Console Support in Godot
      • Official Support
      • Third-Party Support
  • Miscellaneous
    • Handling quit requests
      • Quitting
      • Handling the notification
    • Pausing games
      • Pause?
      • How pausing works
      • White-listing nodes
      • Example
    • Binary serialization API
      • Introduction
      • Packet specification
        • 0: null
        • 1: bool
        • 2: int
        • 3: float/real
        • 4: String
        • 5: Vector2
        • 6: Rect2
        • 7: Vector3
        • 8: Transform2D
        • 9: Plane
        • 10: Quat
        • 11: AABB
        • 12: Basis
        • 13: Transform
        • 14: Color
        • 15: NodePath
        • 16: RID (unsupported)
        • 17: Object (unsupported)
        • 18: Dictionary
        • 19: Array
        • 20: PoolByteArray
        • 21: PoolIntArray
        • 22: PoolRealArray
        • 23: PoolStringArray
        • 24: PoolVector2Array
        • 25: PoolVector3Array
        • 26: PoolColorArray
  • Debug
    • Overview of debugging tools
      • Introduction
      • Debug options
        • Deploy with Remote Debug
        • Small Deploy with Network FS
        • Visible Collision Shapes
        • Visible Navigation
        • Sync Scene Changes
        • Sync Script Changes
      • Debugging tools
        • Debugger
        • Errors
        • Profiler
        • Monitors
        • Video Mem
        • Misc
      • Remote in Scene dock

Development

  • Compiling
    • Getting the source
      • Downloading the Godot source code
    • Introduction to the buildsystem
      • SCons
      • Setup
      • Platform selection
      • Resulting binary
      • Tools
      • Target
      • Bits
      • Export templates
    • Compiling for Windows
      • Requirements
      • Setting up SCons
      • Setting up Pywin32
      • Installing Visual Studio caveats
      • Downloading Godot’s source
      • Compiling
        • About the Developer/Tools Command Prompts and the Visual C++ compiler
        • Running SCons
        • How the prompts actually work
        • How to run an automated build of Godot
      • Development in Visual Studio or other IDEs
      • Cross-compiling for Windows from other operating systems
        • Troubleshooting
      • Creating Windows export templates
    • Compiling for X11 (Linux, *BSD)
      • Requirements
        • Distro-specific oneliners
      • Compiling
      • Building export templates
    • Compiling for OSX
      • Requirements
      • Compiling
      • Compiling for 32 and 64-bit
      • Cross-compiling
    • Compiling for Android
      • Note
      • Requirements
      • Setting up the buildsystem
        • Toolchain
      • Building the export templates
        • Adding support for x86 devices
      • Using the export templates
        • Installing the templates
      • Troubleshooting
        • Application not installed
        • Application exits immediately
    • Compiling for iOS
      • Requirements
      • Compiling
      • Run
    • Cross-compiling for iOS on Linux
      • Disclaimer
      • Requirements
      • Configuring the environment
        • darling-dmg
        • Preparing the SDK
        • Toolchain
      • Compiling Godot for iPhone
        • Producing fat binaries
    • Compiling for Universal Windows Platform
      • Requirements
      • Compiling
      • Creating UWP export templates
      • Running UWP apps with Visual Studio
    • Compiling for the Web
      • Requirements
      • Building export templates
      • Building per asm.js translation or LLVM backend
    • Compiling with Mono
      • Requirements
      • Environment Variables
      • Enable Mono Module
      • Generate The Glue
        • Notes
      • Example (x11)
    • Packaging Godot
      • Default behaviour
      • Global template path (Unix only)
      • Self contained mode
  • Engine development
    • Introduction to Godot development
      • Architecture diagram
      • Debugging the editor with gdb
    • Configuring an IDE
      • Qt Creator
        • Importing the project
        • Build and run
        • Updating Sources after pulling latest commits
      • Kdevelop
      • Xcode
        • Project Setup
        • Scheme Setup
    • Core types
      • Definitions
        • References:
      • Memory model
      • Allocating memory
        • References:
      • Containers
        • References:
      • String
        • References:
      • StringName
        • References:
      • Math types
        • References:
      • NodePath
        • References:
      • RID
        • References:
    • Variant class
      • About
        • References:
      • Containers: Dictionary and Array
        • References:
    • Object class
      • General definition
        • References:
      • Registering an Object
        • References:
      • Constants
      • Properties (set/get)
      • Binding properties using _set/_get/_get_property_list
      • Dynamic casting
      • Signals
      • References
        • References:
      • Resources:
        • References:
      • Resource loading
        • References:
      • Resource saving
        • References:
    • Inheritance class tree
      • Object
      • Reference
      • Control
      • Node2D
      • Spatial
    • Custom modules in C++
      • Modules
      • What for?
      • Creating a new module
      • Using the module
      • Improving the build system for development
      • Writing custom documentation
      • Summing up
    • Custom Resource Format Loaders
      • Introduction
        • References:
      • What for?
      • What not?
        • References:
      • Creating a ResourceFormatLoader
      • Creating Custom Data Types
        • Considerations
        • References:
      • Registering the New File Format
        • References:
      • Loading it on GDScript
    • Custom AudioStreams
      • Introduction
        • References:
      • What for?
      • Create an AudioStream
        • References:
      • Create an AudioStreamPlayback
        • Resampling
        • References:
    • Custom Godot servers
      • Introduction
        • References
      • What for?
      • Creating a Godot server
      • Custom managed resource data
        • References
      • Registering the class in GDScript
        • Bind methods
      • MessageQueue
        • References:
      • Summing it up
        • Notes
    • Creating Android modules
      • Introduction
      • Maybe REST?
      • Android module
        • config.py
      • Java singleton
      • AndroidManifest
      • Resources
      • SDK library
      • SDK project
      • Building
        • Using the module
      • Troubleshooting
        • Godot crashes upon load
      • Future
  • Godot file formats
    • TSCN File Format
      • File Structure
        • Entries inside the file
      • The Scene Tree
        • Node Path
        • Skeleton
        • BoneAttachment
        • AnimationPlayer
      • Resources
        • External Resources
        • Internal Resources
        • ArrayMesh
        • Animation

Community

  • Community
    • Contributing
      • Ways to contribute
        • Contributing code
        • Testing and reporting issues
        • Contributing to the documentation
      • Pull request workflow
        • Git source repository
        • Forking and cloning
        • Branching
        • Updating your branch
        • Making changes
        • Pushing changes to a remote
        • Issuing a pull request
        • Modifying a pull request
        • Mastering the PR workflow: the rebase
        • Deleting a Git branch
      • Code style guidelines
        • C++ and Objective-C
        • Java
        • Python
      • Bug triage guidelines
        • Issues management
      • Documentation guidelines
        • How to contribute
        • What makes good documentation?
        • Titles
        • Translating existing pages
        • License
      • Docs writing guidelines
        • 7 rules for a clear english
        • How to write methods and classes
        • Common vocabulary to use in godot’s docs
        • Image Contribution guidelines
      • Contribute to the Class Reference
        • How to contribute
        • Get started with GitHub
        • How to edit class XML
    • Channels
      • Q & A
      • IRC on Freenode
      • Other chats
      • Social networks
      • Forum
    • Tutorials
      • Video tutorials
    • Resources
      • General

Class reference

  • Godot API
    • @C#
      • Brief Description
    • @GDScript
      • Brief Description
      • Member Functions
      • Numeric Constants
      • Description
      • Member Function Description
    • @GlobalScope
      • Brief Description
      • Member Variables
      • Numeric Constants
      • Enums
      • Description
    • @NativeScript
      • Brief Description
    • @VisualScript
      • Brief Description
      • Description
    • AABB
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • AcceptDialog
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • AnimatedSprite
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • AnimatedSprite3D
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • Animation
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • AnimationPlayer
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • AnimationTreePlayer
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • Area
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • Area2D
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • Array
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • ArrayMesh
      • Brief Description
      • Member Functions
      • Member Variables
      • Numeric Constants
      • Enums
      • Member Function Description
    • ARVRAnchor
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • ARVRCamera
      • Brief Description
      • Description
    • ARVRController
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • ARVRInterface
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • ARVRInterfaceGDNative
      • Brief Description
      • Description
    • ARVROrigin
      • Brief Description
      • Member Variables
      • Description
    • ARVRPositionalTracker
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • ARVRServer
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • AStar
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • AtlasTexture
      • Brief Description
      • Member Variables
      • Description
    • AudioBusLayout
      • Brief Description
      • Description
    • AudioEffect
      • Brief Description
      • Description
    • AudioEffectAmplify
      • Brief Description
      • Member Variables
      • Description
    • AudioEffectBandLimitFilter
      • Brief Description
      • Description
    • AudioEffectBandPassFilter
      • Brief Description
      • Description
    • AudioEffectChorus
      • Brief Description
      • Member Variables
      • Description
    • AudioEffectCompressor
      • Brief Description
      • Member Variables
      • Description
    • AudioEffectDelay
      • Brief Description
      • Member Variables
      • Description
    • AudioEffectDistortion
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • AudioEffectEQ
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • AudioEffectEQ10
      • Brief Description
      • Description
    • AudioEffectEQ21
      • Brief Description
      • Description
    • AudioEffectEQ6
      • Brief Description
      • Description
    • AudioEffectFilter
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • AudioEffectHighPassFilter
      • Brief Description
      • Description
    • AudioEffectHighShelfFilter
      • Brief Description
    • AudioEffectLimiter
      • Brief Description
      • Member Variables
      • Description
    • AudioEffectLowPassFilter
      • Brief Description
      • Description
    • AudioEffectLowShelfFilter
      • Brief Description
    • AudioEffectNotchFilter
      • Brief Description
      • Description
    • AudioEffectPanner
      • Brief Description
      • Member Variables
      • Description
    • AudioEffectPhaser
      • Brief Description
      • Member Variables
      • Description
    • AudioEffectPitchShift
      • Brief Description
      • Member Variables
      • Description
    • AudioEffectReverb
      • Brief Description
      • Member Variables
      • Description
    • AudioEffectStereoEnhance
      • Brief Description
      • Member Variables
    • AudioServer
      • Brief Description
      • Member Functions
      • Signals
      • Enums
      • Description
      • Member Function Description
    • AudioStream
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • AudioStreamOGGVorbis
      • Brief Description
      • Member Variables
      • Description
    • AudioStreamPlayback
      • Brief Description
      • Description
    • AudioStreamPlayer
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • AudioStreamPlayer2D
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • AudioStreamPlayer3D
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • AudioStreamRandomPitch
      • Brief Description
      • Member Variables
      • Description
    • AudioStreamSample
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • BackBufferCopy
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • BakedLightmap
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Member Function Description
    • BakedLightmapData
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • BaseButton
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • Basis
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • BitMap
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • BitmapFont
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • BoneAttachment
      • Brief Description
      • Member Variables
      • Description
    • bool
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • BoxContainer
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • BoxShape
      • Brief Description
      • Member Variables
      • Description
    • BulletPhysicsDirectBodyState
      • Brief Description
    • BulletPhysicsServer
      • Brief Description
    • Button
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • ButtonGroup
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Camera
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • Camera2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • CanvasItem
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Numeric Constants
      • Enums
      • Description
      • Member Function Description
    • CanvasItemMaterial
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • CanvasLayer
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • CanvasModulate
      • Brief Description
      • Member Variables
      • Description
    • CapsuleMesh
      • Brief Description
      • Member Variables
      • Description
    • CapsuleShape
      • Brief Description
      • Member Variables
      • Description
    • CapsuleShape2D
      • Brief Description
      • Member Variables
      • Description
    • CenterContainer
      • Brief Description
      • Member Variables
      • Description
    • CheckBox
      • Brief Description
      • Description
    • CheckButton
      • Brief Description
      • Description
    • CircleShape2D
      • Brief Description
      • Member Variables
      • Description
    • ClassDB
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • CollisionObject
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • CollisionObject2D
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • CollisionPolygon
      • Brief Description
      • Member Variables
      • Description
    • CollisionPolygon2D
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • CollisionShape
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • CollisionShape2D
      • Brief Description
      • Member Variables
      • Description
    • Color
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • ColorPicker
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • ColorPickerButton
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • ColorRect
      • Brief Description
      • Member Variables
      • Description
    • ConcavePolygonShape
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • ConcavePolygonShape2D
      • Brief Description
      • Member Variables
      • Description
    • ConeTwistJoint
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • ConfigFile
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • ConfirmationDialog
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Container
      • Brief Description
      • Member Functions
      • Signals
      • Numeric Constants
      • Description
      • Member Function Description
    • Control
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Numeric Constants
      • Enums
      • Description
      • Member Function Description
    • ConvexPolygonShape
      • Brief Description
      • Member Variables
      • Description
    • ConvexPolygonShape2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • CSharpScript
      • Brief Description
      • Member Functions
      • Member Function Description
    • CubeMap
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • CubeMesh
      • Brief Description
      • Member Variables
      • Description
    • Curve
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • Curve2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Curve3D
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • CurveTexture
      • Brief Description
      • Member Variables
      • Description
    • CylinderMesh
      • Brief Description
      • Member Variables
      • Description
    • DampedSpringJoint2D
      • Brief Description
      • Member Variables
      • Description
    • Dictionary
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • DirectionalLight
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • Directory
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • DynamicFont
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • DynamicFontData
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • EditorExportPlugin
      • Brief Description
      • Member Functions
      • Member Function Description
    • EditorFileDialog
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Member Function Description
    • EditorFileSystem
      • Brief Description
      • Member Functions
      • Signals
      • Description
      • Member Function Description
    • EditorFileSystemDirectory
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • EditorImportPlugin
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • EditorInterface
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • EditorPlugin
      • Brief Description
      • Member Functions
      • Signals
      • Enums
      • Description
      • Member Function Description
    • EditorResourceConversionPlugin
      • Brief Description
      • Member Functions
      • Member Function Description
    • EditorResourcePreview
      • Brief Description
      • Member Functions
      • Signals
      • Description
      • Member Function Description
    • EditorResourcePreviewGenerator
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • EditorSceneImporter
      • Brief Description
      • Member Functions
      • Numeric Constants
      • Member Function Description
    • EditorScenePostImport
      • Brief Description
      • Member Functions
      • Member Function Description
    • EditorScript
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • EditorSelection
      • Brief Description
      • Member Functions
      • Signals
      • Description
      • Member Function Description
    • EditorSettings
      • Brief Description
      • Member Functions
      • Signals
      • Description
      • Member Function Description
    • EditorSpatialGizmo
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • EncodedObjectAsID
      • Brief Description
      • Member Functions
      • Member Function Description
    • Engine
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Environment
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • File
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • FileDialog
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • float
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Font
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • FuncRef
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • GDNative
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • GDNativeLibrary
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • GDScript
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • GDScriptFunctionState
      • Brief Description
      • Member Functions
      • Signals
      • Description
      • Member Function Description
    • GDScriptNativeClass
      • Brief Description
      • Member Functions
      • Member Function Description
    • Generic6DOFJoint
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • Geometry
      • Brief Description
      • Member Functions
      • Member Function Description
    • GeometryInstance
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • GIProbe
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Member Function Description
    • GIProbeData
      • Brief Description
      • Member Variables
    • GodotSharp
      • Brief Description
      • Member Functions
      • Member Function Description
    • Gradient
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • GradientTexture
      • Brief Description
      • Member Variables
      • Description
    • GraphEdit
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • GraphNode
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • GridContainer
      • Brief Description
      • Member Variables
      • Description
    • GridMap
      • Brief Description
      • Member Functions
      • Member Variables
      • Numeric Constants
      • Description
      • Member Function Description
    • GrooveJoint2D
      • Brief Description
      • Member Variables
      • Description
    • HBoxContainer
      • Brief Description
      • Description
    • HingeJoint
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • HScrollBar
      • Brief Description
      • Description
    • HSeparator
      • Brief Description
      • Description
    • HSlider
      • Brief Description
      • Description
    • HSplitContainer
      • Brief Description
      • Description
    • HTTPClient
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • HTTPRequest
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • Image
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • ImageTexture
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • ImmediateGeometry
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Input
      • Brief Description
      • Member Functions
      • Signals
      • Enums
      • Description
      • Member Function Description
    • InputDefault
      • Brief Description
      • Description
    • InputEvent
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • InputEventAction
      • Brief Description
      • Member Variables
      • Description
    • InputEventGesture
      • Brief Description
      • Member Variables
    • InputEventJoypadButton
      • Brief Description
      • Member Variables
      • Description
    • InputEventJoypadMotion
      • Brief Description
      • Member Variables
      • Description
    • InputEventKey
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • InputEventMagnifyGesture
      • Brief Description
      • Member Variables
    • InputEventMouse
      • Brief Description
      • Member Variables
      • Description
    • InputEventMouseButton
      • Brief Description
      • Member Variables
      • Description
    • InputEventMouseMotion
      • Brief Description
      • Member Variables
      • Description
    • InputEventPanGesture
      • Brief Description
      • Member Variables
    • InputEventScreenDrag
      • Brief Description
      • Member Variables
      • Description
    • InputEventScreenTouch
      • Brief Description
      • Member Variables
      • Description
    • InputEventWithModifiers
      • Brief Description
      • Member Variables
      • Description
    • InputMap
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • InstancePlaceholder
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • int
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • InterpolatedCamera
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • IP
      • Brief Description
      • Member Functions
      • Numeric Constants
      • Enums
      • Description
      • Member Function Description
    • IP_Unix
      • Brief Description
      • Description
    • ItemList
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • JavaScript
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Joint
      • Brief Description
      • Member Variables
      • Description
    • Joint2D
      • Brief Description
      • Member Variables
      • Description
    • JSON
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • JSONParseResult
      • Brief Description
      • Member Variables
      • Description
    • KinematicBody
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • KinematicBody2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • KinematicCollision
      • Brief Description
      • Member Variables
      • Description
    • KinematicCollision2D
      • Brief Description
      • Member Variables
      • Description
    • Label
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • LargeTexture
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Light
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • Light2D
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • LightOccluder2D
      • Brief Description
      • Member Variables
      • Description
    • Line2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • LineEdit
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • LineShape2D
      • Brief Description
      • Member Variables
      • Description
    • LinkButton
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • Listener
      • Brief Description
      • Member Functions
      • Member Function Description
    • MainLoop
      • Brief Description
      • Member Functions
      • Numeric Constants
      • Description
      • Member Function Description
    • MarginContainer
      • Brief Description
      • Description
    • Marshalls
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Material
      • Brief Description
      • Member Variables
      • Numeric Constants
      • Description
    • MenuButton
      • Brief Description
      • Member Functions
      • Signals
      • Description
      • Member Function Description
    • Mesh
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • MeshDataTool
      • Brief Description
      • Member Functions
      • Member Function Description
    • MeshInstance
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • MeshLibrary
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • MobileVRInterface
      • Brief Description
      • Member Variables
      • Description
    • MultiMesh
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • MultiMeshInstance
      • Brief Description
      • Member Variables
      • Description
    • Mutex
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • NativeScript
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • Navigation
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Navigation2D
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • NavigationMesh
      • Brief Description
      • Member Functions
      • Member Variables
      • Numeric Constants
      • Member Function Description
    • NavigationMeshInstance
      • Brief Description
      • Member Variables
    • NavigationPolygon
      • Brief Description
      • Member Functions
      • Member Function Description
    • NavigationPolygonInstance
      • Brief Description
      • Member Variables
    • NetworkedMultiplayerENet
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • NetworkedMultiplayerPeer
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Numeric Constants
      • Enums
      • Description
      • Member Function Description
    • Nil
      • Brief Description
      • Member Functions
      • Member Function Description
    • NinePatchRect
      • Brief Description
      • Signals
      • Member Variables
      • Enums
      • Description
    • Node
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Numeric Constants
      • Enums
      • Description
      • Member Function Description
    • Node2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • NodePath
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Object
      • Brief Description
      • Member Functions
      • Signals
      • Numeric Constants
      • Enums
      • Description
      • Member Function Description
    • OccluderPolygon2D
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • OmniLight
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • OptionButton
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • OS
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • PackedDataContainer
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • PackedDataContainerRef
      • Brief Description
      • Member Functions
      • Member Function Description
    • PackedScene
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • PacketPeer
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • PacketPeerStream
      • Brief Description
      • Member Variables
      • Description
    • PacketPeerUDP
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Panel
      • Brief Description
      • Description
    • PanelContainer
      • Brief Description
      • Description
    • PanoramaSky
      • Brief Description
      • Member Variables
    • ParallaxBackground
      • Brief Description
      • Member Variables
      • Description
    • ParallaxLayer
      • Brief Description
      • Member Variables
      • Description
    • Particles
      • Brief Description
      • Member Functions
      • Member Variables
      • Numeric Constants
      • Enums
      • Description
      • Member Function Description
    • Particles2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • ParticlesMaterial
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • Path
      • Brief Description
      • Member Variables
      • Description
    • Path2D
      • Brief Description
      • Member Variables
      • Description
    • PathFollow
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • PathFollow2D
      • Brief Description
      • Member Variables
      • Description
    • PCKPacker
      • Brief Description
      • Member Functions
      • Member Function Description
    • Performance
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • PHashTranslation
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Physics2DDirectBodyState
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Physics2DDirectBodyStateSW
      • Brief Description
      • Description
    • Physics2DDirectSpaceState
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Physics2DServer
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • Physics2DServerSW
      • Brief Description
      • Description
    • Physics2DShapeQueryParameters
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Physics2DShapeQueryResult
      • Brief Description
      • Member Functions
      • Member Function Description
    • Physics2DTestMotionResult
      • Brief Description
      • Member Variables
    • PhysicsBody
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • PhysicsBody2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • PhysicsDirectBodyState
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • PhysicsDirectSpaceState
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • PhysicsServer
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • PhysicsShapeQueryParameters
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • PhysicsShapeQueryResult
      • Brief Description
      • Member Functions
      • Member Function Description
    • PinJoint
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • PinJoint2D
      • Brief Description
      • Member Variables
      • Description
    • Plane
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • PlaneMesh
      • Brief Description
      • Member Variables
      • Description
    • PlaneShape
      • Brief Description
      • Member Variables
    • PluginScript
      • Brief Description
    • Polygon2D
      • Brief Description
      • Member Variables
      • Description
    • PolygonPathFinder
      • Brief Description
      • Member Functions
      • Member Function Description
    • PoolByteArray
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • PoolColorArray
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • PoolIntArray
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • PoolRealArray
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • PoolStringArray
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • PoolVector2Array
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • PoolVector3Array
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Popup
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Numeric Constants
      • Description
      • Member Function Description
    • PopupDialog
      • Brief Description
      • Description
    • PopupMenu
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • PopupPanel
      • Brief Description
      • Description
    • Position2D
      • Brief Description
      • Description
    • Position3D
      • Brief Description
      • Description
    • PrimitiveMesh
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • PrismMesh
      • Brief Description
      • Member Variables
      • Description
    • ProceduralSky
      • Brief Description
      • Member Variables
      • Enums
    • ProgressBar
      • Brief Description
      • Member Variables
      • Description
    • ProjectSettings
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • ProximityGroup
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • ProxyTexture
      • Brief Description
      • Member Variables
    • QuadMesh
      • Brief Description
      • Member Variables
      • Description
    • Quat
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Range
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • RayCast
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • RayCast2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • RayShape
      • Brief Description
      • Member Variables
      • Description
    • RayShape2D
      • Brief Description
      • Member Variables
      • Description
    • Rect2
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • RectangleShape2D
      • Brief Description
      • Member Variables
      • Description
    • Reference
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • ReferenceRect
      • Brief Description
      • Description
    • ReflectionProbe
      • Brief Description
      • Member Variables
      • Enums
    • RegEx
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • RegExMatch
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • RemoteTransform
      • Brief Description
      • Member Variables
      • Description
    • RemoteTransform2D
      • Brief Description
      • Member Variables
      • Description
    • Resource
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • ResourceImporter
      • Brief Description
    • ResourceImporterOGGVorbis
      • Brief Description
    • ResourceImporterTheora
      • Brief Description
    • ResourceImporterWebm
      • Brief Description
    • ResourceInteractiveLoader
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • ResourceLoader
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • ResourcePreloader
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • ResourceSaver
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • RichTextLabel
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • RID
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • RigidBody
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • RigidBody2D
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • SceneState
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • SceneTree
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • SceneTreeTimer
      • Brief Description
      • Signals
      • Member Variables
    • Script
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • ScriptEditor
      • Brief Description
      • Member Functions
      • Signals
      • Member Function Description
    • ScrollBar
      • Brief Description
      • Signals
      • Member Variables
      • Description
    • ScrollContainer
      • Brief Description
      • Signals
      • Member Variables
      • Description
    • SegmentShape2D
      • Brief Description
      • Member Variables
      • Description
    • Semaphore
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • Separator
      • Brief Description
      • Description
    • Shader
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • ShaderMaterial
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • Shape
      • Brief Description
      • Description
    • Shape2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • ShortCut
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Skeleton
      • Brief Description
      • Member Functions
      • Numeric Constants
      • Description
      • Member Function Description
    • Sky
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • Slider
      • Brief Description
      • Member Variables
      • Description
    • SliderJoint
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • Spatial
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Numeric Constants
      • Description
      • Member Function Description
    • SpatialGizmo
      • Brief Description
    • SpatialMaterial
      • Brief Description
      • Member Variables
      • Enums
    • SpatialVelocityTracker
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • SphereMesh
      • Brief Description
      • Member Variables
      • Description
    • SphereShape
      • Brief Description
      • Member Variables
      • Description
    • SpinBox
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • SplitContainer
      • Brief Description
      • Signals
      • Member Variables
      • Enums
      • Description
    • SpotLight
      • Brief Description
      • Member Variables
      • Description
    • Sprite
      • Brief Description
      • Signals
      • Member Variables
      • Description
    • Sprite3D
      • Brief Description
      • Signals
      • Member Variables
      • Description
    • SpriteBase3D
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • SpriteFrames
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • StaticBody
      • Brief Description
      • Member Variables
      • Description
    • StaticBody2D
      • Brief Description
      • Member Variables
      • Description
    • StreamPeer
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • StreamPeerBuffer
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • StreamPeerSSL
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • StreamPeerTCP
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • StreamTexture
      • Brief Description
      • Member Variables
      • Description
    • String
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • StyleBox
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • StyleBoxEmpty
      • Brief Description
      • Description
    • StyleBoxFlat
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • StyleBoxLine
      • Brief Description
      • Member Variables
    • StyleBoxTexture
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • SurfaceTool
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • TabContainer
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • Tabs
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • TCP_Server
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • TextEdit
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • Texture
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • TextureButton
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • TextureProgress
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • TextureRect
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • Theme
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Thread
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • TileMap
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Numeric Constants
      • Enums
      • Description
      • Member Function Description
    • TileSet
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • Timer
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • ToolButton
      • Brief Description
      • Description
    • TouchScreenButton
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • Transform
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Transform2D
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Translation
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • TranslationServer
      • Brief Description
      • Member Functions
      • Member Function Description
    • Tree
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • TreeItem
      • Brief Description
      • Member Functions
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • TriangleMesh
      • Brief Description
    • Tween
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • UndoRedo
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • Variant
      • Brief Description
      • Description
    • VBoxContainer
      • Brief Description
      • Description
    • Vector2
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • Vector3
      • Brief Description
      • Member Functions
      • Member Variables
      • Numeric Constants
      • Description
      • Member Function Description
    • VehicleBody
      • Brief Description
      • Member Variables
      • Description
    • VehicleWheel
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • VideoPlayer
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • VideoStream
      • Brief Description
    • VideoStreamTheora
      • Brief Description
      • Member Functions
      • Member Function Description
    • VideoStreamWebm
      • Brief Description
      • Member Functions
      • Member Function Description
    • Viewport
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Enums
      • Description
      • Member Function Description
    • ViewportContainer
      • Brief Description
      • Member Variables
    • ViewportTexture
      • Brief Description
      • Member Variables
    • VisibilityEnabler
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • VisibilityEnabler2D
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • VisibilityNotifier
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • VisibilityNotifier2D
      • Brief Description
      • Member Functions
      • Signals
      • Member Variables
      • Description
      • Member Function Description
    • VisualInstance
      • Brief Description
      • Member Functions
      • Member Variables
      • Member Function Description
    • VisualScript
      • Brief Description
      • Member Functions
      • Signals
      • Description
      • Member Function Description
    • VisualScriptBasicTypeConstant
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptBuiltinFunc
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • VisualScriptClassConstant
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptComment
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptCondition
      • Brief Description
      • Description
    • VisualScriptConstant
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptConstructor
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • VisualScriptCustomNode
      • Brief Description
      • Member Functions
      • Numeric Constants
      • Enums
      • Description
      • Member Function Description
    • VisualScriptDeconstruct
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptEditor
      • Brief Description
      • Member Functions
      • Signals
      • Member Function Description
    • VisualScriptEmitSignal
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptEngineSingleton
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptExpression
      • Brief Description
    • VisualScriptFunction
      • Brief Description
    • VisualScriptFunctionCall
      • Brief Description
      • Member Variables
      • Enums
    • VisualScriptFunctionState
      • Brief Description
      • Member Functions
      • Member Function Description
    • VisualScriptGlobalConstant
      • Brief Description
      • Member Variables
    • VisualScriptIndexGet
      • Brief Description
    • VisualScriptIndexSet
      • Brief Description
    • VisualScriptInputAction
      • Brief Description
      • Member Variables
      • Enums
    • VisualScriptIterator
      • Brief Description
      • Description
    • VisualScriptLocalVar
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptLocalVarSet
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptMathConstant
      • Brief Description
      • Member Variables
      • Enums
      • Description
    • VisualScriptNode
      • Brief Description
      • Member Functions
      • Signals
      • Description
      • Member Function Description
    • VisualScriptOperator
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptPreload
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptPropertyGet
      • Brief Description
      • Member Variables
      • Enums
    • VisualScriptPropertySet
      • Brief Description
      • Member Variables
      • Enums
    • VisualScriptResourcePath
      • Brief Description
      • Member Variables
    • VisualScriptReturn
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptSceneNode
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptSceneTree
      • Brief Description
    • VisualScriptSelect
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptSelf
      • Brief Description
      • Description
    • VisualScriptSequence
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptSubCall
      • Brief Description
      • Member Functions
      • Member Function Description
    • VisualScriptSwitch
      • Brief Description
      • Description
    • VisualScriptTypeCast
      • Brief Description
      • Member Variables
    • VisualScriptVariableGet
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptVariableSet
      • Brief Description
      • Member Variables
      • Description
    • VisualScriptWhile
      • Brief Description
      • Description
    • VisualScriptYield
      • Brief Description
      • Member Variables
      • Enums
    • VisualScriptYieldSignal
      • Brief Description
      • Member Variables
      • Enums
    • VisualServer
      • Brief Description
      • Member Functions
      • Signals
      • Numeric Constants
      • Enums
      • Description
      • Member Function Description
    • VScrollBar
      • Brief Description
    • VSeparator
      • Brief Description
      • Description
    • VSlider
      • Brief Description
      • Description
    • VSplitContainer
      • Brief Description
      • Description
    • WeakRef
      • Brief Description
      • Member Functions
      • Description
      • Member Function Description
    • WindowDialog
      • Brief Description
      • Member Functions
      • Member Variables
      • Description
      • Member Function Description
    • World
      • Brief Description
      • Member Variables
      • Description
    • World2D
      • Brief Description
      • Member Variables
      • Description
    • WorldEnvironment
      • Brief Description
      • Member Variables
      • Description
    • XMLParser
      • Brief Description
      • Member Functions
      • Enums
      • Description
      • Member Function Description
    • YSort
      • Brief Description
      • Member Variables
      • Description
Godot Engine
  • Docs »
  • Godot API »
  • NavigationPolygon
  • Edit on GitHub

NavigationPolygon¶

Inherits: Resource < Reference < Object

Category: Core

Brief Description¶

Member Functions¶

void add_outline ( PoolVector2Array outline )
void add_outline_at_index ( PoolVector2Array outline, int index )
void add_polygon ( PoolIntArray polygon )
void clear_outlines ( )
void clear_polygons ( )
PoolVector2Array get_outline ( int idx ) const
int get_outline_count ( ) const
PoolIntArray get_polygon ( int idx )
int get_polygon_count ( ) const
PoolVector2Array get_vertices ( ) const
void make_polygons_from_outlines ( )
void remove_outline ( int idx )
void set_outline ( int idx, PoolVector2Array outline )
void set_vertices ( PoolVector2Array vertices )

Member Function Description¶

  • void add_outline ( PoolVector2Array outline )
  • void add_outline_at_index ( PoolVector2Array outline, int index )
  • void add_polygon ( PoolIntArray polygon )
  • void clear_outlines ( )
  • void clear_polygons ( )
  • PoolVector2Array get_outline ( int idx ) const
  • int get_outline_count ( ) const
  • PoolIntArray get_polygon ( int idx )
  • int get_polygon_count ( ) const
  • PoolVector2Array get_vertices ( ) const
  • void make_polygons_from_outlines ( )
  • void remove_outline ( int idx )
  • void set_outline ( int idx, PoolVector2Array outline )
  • void set_vertices ( PoolVector2Array vertices )
Next Previous

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

Built with Sphinx using a theme provided by Read the Docs.