World3D — C# API

A resource that holds all components of a 3D world, such as a visual scenario and a physics space.

class World3DReckfellSharpInherits Resource

A resource that holds all components of a 3D world, such as a visual scenario and a physics space.

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

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

Constructors1

World3DConstructor

# World3D

C#
public World3D();

Properties7

CameraAttributesProperty

# CameraAttributes

C#
public CameraAttributes CameraAttributes { get; set; }

The default CameraAttributes resource to use if none set on the Camera3D.

DirectSpaceStateProperty

# DirectSpaceState

public PhysicsDirectSpaceState3D DirectSpaceState { get; }

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

EnvironmentProperty

# Environment

C#
public Environment Environment { get; set; }

The World3D's Environment.

FallbackEnvironmentProperty

# FallbackEnvironment

C#
public Environment FallbackEnvironment { get; set; }

The World3D's fallback environment will be used if World3D.Environment fails or is missing.

NavigationMapProperty

# NavigationMap

public Rid NavigationMap { get; }

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

ScenarioProperty

# Scenario

public Rid Scenario { get; }

The World3D's visual scenario.

SpaceProperty

# Space

public Rid Space { get; }

The World3D's physics space.

Methods10

GetCameraAttributesCameraAttributes

# GetCameraAttributes

C#
public CameraAttributes GetCameraAttributes();

Returns CameraAttributes

GetDirectSpaceStatePhysicsDirectSpaceState3D

# GetDirectSpaceState

C#
public PhysicsDirectSpaceState3D GetDirectSpaceState();

Returns PhysicsDirectSpaceState3D

GetEnvironmentEnvironment

# GetEnvironment

C#
public Environment GetEnvironment();

Returns Environment

GetFallbackEnvironmentEnvironment

# GetFallbackEnvironment

C#
public Environment GetFallbackEnvironment();

Returns Environment

GetNavigationMapRid

# GetNavigationMap

C#
public Rid GetNavigationMap();

Returns Rid

GetScenarioRid

# GetScenario

C#
public Rid GetScenario();

Returns Rid

GetSpaceRid

# GetSpace

C#
public Rid GetSpace();

Returns Rid

SetCameraAttributesvoid

# SetCameraAttributes

C#
public void SetCameraAttributes(CameraAttributes attributes);

Parameters
Name	Type	Default
`attributes`	`CameraAttributes`	—

SetEnvironmentvoid

# SetEnvironment

C#
public void SetEnvironment(Environment env);

Parameters
Name	Type	Default
`env`	`Environment`	—

SetFallbackEnvironmentvoid

# SetFallbackEnvironment

C#
public void SetFallbackEnvironment(Environment env);

Parameters
Name	Type	Default
`env`	`Environment`	—