Empeld
Empeld plugin documentation.
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Pages
Public Member Functions | List of all members
pluginbase.Dependencies.IEnvironmentState Interface Reference

Server-side interface that provides information about the lighting situation of a given position More...

Public Member Functions

Rgba GetRawEnvironmentLight (Vector3d pos)
 Gets the environment lighting, ignoring shadows or location More...
 
Rgba GetEnvironmentLight (Vector3d pos)
 Gets the current environment light (Sum of light sources), estimating shadows More...
 
Rgba GetArtificialLight (Vector3d pos)
 Gets the amount of artificial light affecting a point More...
 
Rgba GetTotalLight (Vector3d pos)
 Gets total light on a point (Environment + Artificial) More...
 
Vector3 GetWindForce (Vector3d pos)
 Gets the force of the wind More...
 

Detailed Description

Server-side interface that provides information about the lighting situation of a given position

Attribute: Injectable

Member Function Documentation

◆ GetArtificialLight()

Rgba pluginbase.Dependencies.IEnvironmentState.GetArtificialLight ( Vector3d  pos)

Gets the amount of artificial light affecting a point

Returns
The artificial light.
Parameters
posPosition.

◆ GetEnvironmentLight()

Rgba pluginbase.Dependencies.IEnvironmentState.GetEnvironmentLight ( Vector3d  pos)

Gets the current environment light (Sum of light sources), estimating shadows

Returns
The environment light.

◆ GetRawEnvironmentLight()

Rgba pluginbase.Dependencies.IEnvironmentState.GetRawEnvironmentLight ( Vector3d  pos)

Gets the environment lighting, ignoring shadows or location

Returns
The raw environment light.

◆ GetTotalLight()

Rgba pluginbase.Dependencies.IEnvironmentState.GetTotalLight ( Vector3d  pos)

Gets total light on a point (Environment + Artificial)

Returns
The total light.
Parameters
posPosition.

◆ GetWindForce()

Vector3 pluginbase.Dependencies.IEnvironmentState.GetWindForce ( Vector3d  pos)

Gets the force of the wind

Returns
The wind force.
Parameters
posPosition.
The documentation for this interface was generated from the following file: