SCRIPTING API / Rendering and effects / DirectionalLight

DirectionalLight

Script access to an entity's Directional Light: colour, intensity and shadows.

Kindclass

NamespaceKroys.EngineScripting

Members29

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

Component access: every member takes the entity first, for example DirectionalLight.Has(Entity). The values are the ones the Inspector shows for this component.

Declaration

public static partial class DirectionalLight

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Directional Light component.

methodstatic

#public static bool IsEnabled(Entity e)

Reads the Directional Light component's Enabled value of the entity.

methodstatic

#public static void SetEnabled(Entity e, bool value)

Sets the Directional Light component's Enabled value on the entity.

methodstatic

#public static bool CastsShadows(Entity e)

Reads the Directional Light component's casts shadows flag of the entity.

methodstatic

#public static void SetCastsShadows(Entity e, bool value)

Sets the Directional Light component's Casts Shadows value on the entity.

methodstatic

#public static bool ShowsCascadeDebug(Entity e)

Reads the Directional Light component's shows cascade debug flag of the entity.

methodstatic

#public static void SetShowCascadeDebug(Entity e, bool value)

Sets the Directional Light component's Show Cascade Debug value on the entity.

methodstatic

#public static Vector3 GetColor(Entity e)

Reads the Directional Light component's Color value of the entity.

methodstatic

#public static void SetColor(Entity e, Vector3 value)

Sets the Directional Light component's Color value on the entity.

methodstatic

#public static float GetIntensity(Entity e)

Reads the Directional Light component's Intensity value of the entity.

methodstatic

#public static void SetIntensity(Entity e, float value)

Sets the Directional Light component's Intensity value on the entity.

methodstatic

#public static float GetShadowBias(Entity e)

Reads the Directional Light component's Shadow Bias value of the entity.

methodstatic

#public static void SetShadowBias(Entity e, float value)

Sets the Directional Light component's Shadow Bias value on the entity.

methodstatic

#public static float GetShadowNormalBias(Entity e)

Reads the Directional Light component's Shadow Normal Bias value of the entity.

methodstatic

#public static void SetShadowNormalBias(Entity e, float value)

Sets the Directional Light component's Shadow Normal Bias value on the entity.

methodstatic

#public static float GetShadowSlopeBias(Entity e)

Reads the Directional Light component's Shadow Slope Bias value of the entity.

methodstatic

#public static void SetShadowSlopeBias(Entity e, float value)

Sets the Directional Light component's Shadow Slope Bias value on the entity.

methodstatic

#public static float GetShadowStrength(Entity e)

Reads the Directional Light component's Shadow Strength value of the entity.

methodstatic

#public static void SetShadowStrength(Entity e, float value)

Sets the Directional Light component's Shadow Strength value on the entity.

methodstatic

#public static float GetShadowMaxDistance(Entity e)

Reads the Directional Light component's Shadow Max Distance value of the entity.

methodstatic

#public static void SetShadowMaxDistance(Entity e, float value)

Sets the Directional Light component's Shadow Max Distance value on the entity.

methodstatic

#public static float GetShadowCascadeLambda(Entity e)

Reads the Directional Light component's Shadow Cascade Lambda value of the entity.

methodstatic

#public static void SetShadowCascadeLambda(Entity e, float value)

Sets the Directional Light component's Shadow Cascade Lambda value on the entity.

methodstatic

#public static uint GetShadowPcfRadius(Entity e)

Reads the Directional Light component's Shadow Pcf Radius value of the entity.

methodstatic

#public static void SetShadowPcfRadius(Entity e, uint value)

Sets the Directional Light component's Shadow Pcf Radius value on the entity.

methodstatic

#public static uint GetShadowResolution(Entity e)

Reads the Directional Light component's Shadow Resolution value of the entity.

methodstatic

#public static void SetShadowResolution(Entity e, uint value)

Sets the Directional Light component's Shadow Resolution value on the entity.

methodstatic

#public static uint GetShadowCascadeCount(Entity e)

Reads the Directional Light component's Shadow Cascade Count value of the entity.

methodstatic

#public static void SetShadowCascadeCount(Entity e, uint value)

Sets the Directional Light component's Shadow Cascade Count value on the entity.

methodstatic

Signatures

public static bool Has(Entity e)
public static bool IsEnabled(Entity e)
public static void SetEnabled(Entity e, bool value)
public static bool CastsShadows(Entity e)
public static void SetCastsShadows(Entity e, bool value)
public static bool ShowsCascadeDebug(Entity e)
public static void SetShowCascadeDebug(Entity e, bool value)
public static Vector3 GetColor(Entity e)
public static void SetColor(Entity e, Vector3 value)
public static float GetIntensity(Entity e)
public static void SetIntensity(Entity e, float value)
public static float GetShadowBias(Entity e)
public static void SetShadowBias(Entity e, float value)
public static float GetShadowNormalBias(Entity e)
public static void SetShadowNormalBias(Entity e, float value)
public static float GetShadowSlopeBias(Entity e)
public static void SetShadowSlopeBias(Entity e, float value)
public static float GetShadowStrength(Entity e)
public static void SetShadowStrength(Entity e, float value)
public static float GetShadowMaxDistance(Entity e)
public static void SetShadowMaxDistance(Entity e, float value)
public static float GetShadowCascadeLambda(Entity e)
public static void SetShadowCascadeLambda(Entity e, float value)
public static uint GetShadowPcfRadius(Entity e)
public static void SetShadowPcfRadius(Entity e, uint value)
public static uint GetShadowResolution(Entity e)
public static void SetShadowResolution(Entity e, uint value)
public static uint GetShadowCascadeCount(Entity e)
public static void SetShadowCascadeCount(Entity e, uint value)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.