World2D

Inherits: Resource < Reference < Object

Category: Core

Brief Description

Class that has everything pertaining to a 2D world.

Member Functions

RID

get_canvas ( )

Physics2DDirectSpaceState

get_direct_space_state ( )

RID

get_sound_space ( )

RID

get_space ( )

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.

Member Function Description

  • RID get_canvas ( )

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

Retrieve the state of this world’s physics space. This allows arbitrary querying for collision.

  • RID get_sound_space ( )

Retrieve the RID of this world’s sound space resource. Used by the SpatialSound2DServer for 2D spatial audio.

  • RID get_space ( )

Retrieve 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.