World2D

Inherits: Resource < Reference < Object

Class that has everything pertaining to a 2D world.

Description

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

Tutorials

Properties

RID

canvas

Physics2DDirectSpaceState

direct_space_state

RID

navigation_map

RID

space

Property Descriptions

Getter

get_canvas()

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


Getter

get_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 _physics_process(delta) in the main thread.


  • RID navigation_map

Getter

get_navigation_map()

The RID of this world’s navigation map. Used by the Navigation2DServer.


Getter

get_space()

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