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 and a sound space. 2D nodes register their resources into the current 2D world.

Tutorials

Properties

RID

canvas

Physics2DDirectSpaceState

direct_space_state

RID

space

Property Descriptions

RID canvas

Getter

get_canvas()

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

Physics2DDirectSpaceState direct_space_state

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 space

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.

© 2014–2021 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.3/classes/class_world2d.html