World2D — C# API

World2D

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

1.0.0

class World2DReckfellSharpInherits Resource

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

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.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

World2DConstructor

# World2D

C#
public World2D();

Properties4

CanvasProperty

# Canvas

public Rid Canvas { get; }

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

DirectSpaceStateProperty

# DirectSpaceState

public PhysicsDirectSpaceState2D DirectSpaceState { get; }

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 Entity._PhysicsProcess in the main thread.

NavigationMapProperty

# NavigationMap

public Rid NavigationMap { get; }

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

SpaceProperty

# Space

public Rid Space { get; }

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.

Methods4

GetCanvasRid

# GetCanvas

C#
public Rid GetCanvas();

Returns Rid

GetDirectSpaceStatePhysicsDirectSpaceState2D

# GetDirectSpaceState

C#
public PhysicsDirectSpaceState2D GetDirectSpaceState();

Returns PhysicsDirectSpaceState2D

GetNavigationMapRid

# GetNavigationMap

C#
public Rid GetNavigationMap();

Returns Rid

GetSpaceRid

# GetSpace

C#
public Rid GetSpace();

Returns Rid

Reckfell Engine documentationBack to top ↑