An interface representing the sky layer More...

Inheritance diagram for pluginbase.Objects.World.Environment.ISkyLayer:

Public Member Functions
Rgba	DirectionalColor (float x, float y, float z)
	Get the color at a direction More...

Public Member Functions inherited from pluginbase.Objects.World.Environment.IEnvironmentSimulatable
void	Simulate (double time, double x, double y, double z)
	Simulate the environment with the time, and an x/y/z More...

Properties
SkyLayerRenderMode	RenderMode `[get]`
	Gets the render mode. More...

int	Layer `[get]`
	Gets the layer the sky is drawn on More...

Vector3	Direction `[get]`
	Gets the up-direction for the layer. This can be used to rotate a sky-sphere or position a shader value More...

string	Resource `[get]`
	Gets the resource. Either a texture, or shader. Only shaders support multiple resources More...

Rgba	Color `[get]`
	Overlay color More...

float	TextureScale `[get]`
	Gets the texture scale for render types that support it More...

float	CameraAdjustmentRatio `[get]`
	The amount the camera position adjusts the direction of the layer More...

bool	ReceivesLight `[get]`
	Gets a value indicating whether this pluginbase.Objects.World.Environment.ISkyLayer receives light. More...

bool	CastsShadow `[get]`
	Gets a value indicating whether this instance can project on world. More...

Rgba	LightFilter `[get]`
	Gets a value to multiply incoming light by to simulate a layer filtering out sunlight More...

Detailed Description

An interface representing the sky layer

Member Function Documentation

◆ DirectionalColor()

Rgba pluginbase.Objects.World.Environment.ISkyLayer.DirectionalColor	(	float	x,
		float	y,
		float	z
	)

Get the color at a direction

Returns: The color.

Parameters

x	X.
y	Y.
z	Z.

Implemented in pluginbase.Objects.World.Environment.Sky.SkyLayerBase, essentials.Environment.Sky.AtmosphereLayer, and essentials.Environment.Fog.FogSkirt.

Property Documentation

◆ CameraAdjustmentRatio

float pluginbase.Objects.World.Environment.ISkyLayer.CameraAdjustmentRatio

get

The amount the camera position adjusts the direction of the layer

The camera adjustment ratio.

◆ CastsShadow

bool pluginbase.Objects.World.Environment.ISkyLayer.CastsShadow

get

Gets a value indicating whether this instance can project on world.

true if this instance can project on world; otherwise, false.

◆ Color

Rgba pluginbase.Objects.World.Environment.ISkyLayer.Color

get

Overlay color

The color.

◆ Direction

Vector3 pluginbase.Objects.World.Environment.ISkyLayer.Direction

get

Gets the up-direction for the layer. This can be used to rotate a sky-sphere or position a shader value

The direction.

◆ Layer

int pluginbase.Objects.World.Environment.ISkyLayer.Layer

get

Gets the layer the sky is drawn on

The layer.

◆ LightFilter

Rgba pluginbase.Objects.World.Environment.ISkyLayer.LightFilter

get

Gets a value to multiply incoming light by to simulate a layer filtering out sunlight

The light filter.

◆ ReceivesLight

bool pluginbase.Objects.World.Environment.ISkyLayer.ReceivesLight

get

Gets a value indicating whether this pluginbase.Objects.World.Environment.ISkyLayer receives light.

true if receives light; otherwise, false.

◆ RenderMode

SkyLayerRenderMode pluginbase.Objects.World.Environment.ISkyLayer.RenderMode

get

Gets the render mode.

The render mode.

◆ Resource

string pluginbase.Objects.World.Environment.ISkyLayer.Resource

get

Gets the resource. Either a texture, or shader. Only shaders support multiple resources

The resource.

◆ TextureScale

float pluginbase.Objects.World.Environment.ISkyLayer.TextureScale

get

Gets the texture scale for render types that support it

The texture scale.

The documentation for this interface was generated from the following file:

pluginbase/Objects/World/Environment/ISkyLayer.cs

Public Member Functions

Properties