Table of Contents

Class WorldEnvironment

Namespace
Godot
Assembly
GodotSharp.dll

The WorldEnvironment node is used to configure the default Environment for the scene.

The parameters defined in the WorldEnvironment can be overridden by an Environment node set on the current Camera3D. Additionally, only one WorldEnvironment may be instantiated in a given scene at a time.

The WorldEnvironment allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). Usually, these are added in order to improve the realism/color balance of the scene.

public class WorldEnvironment : Node, IDisposable
Inheritance
WorldEnvironment
Implements
Inherited Members

Constructors

WorldEnvironment() 

public WorldEnvironment()

Properties

CameraAttributes

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

public CameraAttributes CameraAttributes { get; set; }

Property Value

CameraAttributes

Compositor

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

public Compositor Compositor { get; set; }

Property Value

Compositor

Environment

The Environment resource used by this WorldEnvironment, defining the default properties.

public Environment Environment { get; set; }

Property Value

Environment

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool
Edit this page