Attention: Here be dragons (unstable version)

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

Checking the stable version of the documentation...

World2D

Inherits: Resource < RefCounted < Object

A resource that holds all components of a 2D world, such as a canvas and a physics space.

Description

Class that has everything pertaining to a 2D world: A physics space, a canvas, and a sound space. 2D nodes register their resources into the current 2D world.

Tutorials

Properties

RID

canvas

PhysicsDirectSpaceState2D

direct_space_state

RID

navigation_map

RID

space

Property Descriptions

RID canvas 🔗

  • RID get_canvas()

The RID of this world's canvas resource. Used by the RenderingServer for 2D drawing.

PhysicsDirectSpaceState2D direct_space_state 🔗

Direct access to the world's physics 2D space state. Used for querying current and potential collisions. When using multi-threaded physics, access is limited to Node._physics_process in the main thread.

RID navigation_map 🔗

  • RID get_navigation_map()

The RID of this world's navigation map. Used by the NavigationServer2D.

RID space 🔗

  • RID get_space()

The RID of this world's physics space resource. Used by the PhysicsServer2D for 2D physics, treating it as both a space and an area.