SCRIPTING API / Rendering and effects / SpotLight

SpotLight

Script access to an entity's Spot Light: colour, intensity, range, cone angles and shadows.

Kindclass

NamespaceKroys.EngineScripting

Members33

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

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

Declaration

public static partial class SpotLight

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Spot Light component.

methodstatic

#public static bool IsEnabled(Entity e)

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

methodstatic

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

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

methodstatic

#public static bool CastsShadows(Entity e)

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

methodstatic

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

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

methodstatic

#public static Vector3 GetColor(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetIntensity(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetRange(Entity e)

Reads the Spot Light component's Range value of the entity.

methodstatic

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

Sets the Spot Light component's Range value on the entity.

methodstatic

#public static float GetInnerAngle(Entity e)

Reads the Spot Light component's Inner Angle value of the entity.

methodstatic

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

Sets the Spot Light component's Inner Angle value on the entity.

methodstatic

#public static float GetOuterAngle(Entity e)

Reads the Spot Light component's Outer Angle value of the entity.

methodstatic

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

Sets the Spot Light component's Outer Angle value on the entity.

methodstatic

#public static float GetShadowBias(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetShadowNormalBias(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetShadowSlopeBias(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetShadowStrength(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetShadowNearPlane(Entity e)

Reads the Spot Light component's Shadow Near Plane value of the entity.

methodstatic

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

Sets the Spot Light component's Shadow Near Plane value on the entity.

methodstatic

#public static float GetShadowFarPlane(Entity e)

Reads the Spot Light component's Shadow Far Plane value of the entity.

methodstatic

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

Sets the Spot Light component's Shadow Far Plane value on the entity.

methodstatic

#public static uint GetShadowPcfRadius(Entity e)

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

methodstatic

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

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

methodstatic

#public static uint GetShadowResolution(Entity e)

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

methodstatic

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

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

methodstatic

#public static bool GetInverseSquareFalloff(Entity e)

Reads the Spot Light component's Inverse Square Falloff value of the entity.

methodstatic

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

Sets the Spot Light component's Inverse Square Falloff 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 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 GetRange(Entity e)
public static void SetRange(Entity e, float value)
public static float GetInnerAngle(Entity e)
public static void SetInnerAngle(Entity e, float value)
public static float GetOuterAngle(Entity e)
public static void SetOuterAngle(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 GetShadowNearPlane(Entity e)
public static void SetShadowNearPlane(Entity e, float value)
public static float GetShadowFarPlane(Entity e)
public static void SetShadowFarPlane(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 bool GetInverseSquareFalloff(Entity e)
public static void SetInverseSquareFalloff(Entity e, bool value)

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