SCRIPTING API / Other / ProbeVolume

ProbeVolume

Script access to an entity's Probe Volume: enable it, scale its light, and request a new bake of its probes for the running game with SetBakeRequested(entity, true) (the flag clears when it starts).

Kindclass

NamespaceKroys.EngineScripting

Members25

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

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

Declaration

public static partial class ProbeVolume

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Probe Volume component.

methodstatic

#public static bool IsEnabled(Entity e)

Reads the Probe Volume component's Enabled value of the entity.

methodstatic

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

Sets the Probe Volume component's Enabled value on the entity.

methodstatic

#public static float GetIntensity(Entity e)

Reads the Probe Volume component's Intensity value of the entity.

methodstatic

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

Sets the Probe Volume component's Intensity value on the entity.

methodstatic

#public static bool IsBakeRequested(Entity e)

Reads the Probe Volume component's Bake Requested value of the entity.

methodstatic

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

Sets the Probe Volume component's Bake Requested value on the entity.

methodstatic

#public static Vector3 GetBoxExtents(Entity e)

Reads the Probe Volume component's Box Extents value of the entity.

methodstatic

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

Sets the Probe Volume component's Box Extents value on the entity.

methodstatic

#public static Vector3 GetBoxOffset(Entity e)

Reads the Probe Volume component's Box Offset value of the entity.

methodstatic

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

Sets the Probe Volume component's Box Offset value on the entity.

methodstatic

#public static int GetProbeCountX(Entity e)

Reads the Probe Volume component's Probe Count X value of the entity.

methodstatic

#public static void SetProbeCountX(Entity e, int value)

Sets the Probe Volume component's Probe Count X value on the entity.

methodstatic

#public static int GetProbeCountY(Entity e)

Reads the Probe Volume component's Probe Count Y value of the entity.

methodstatic

#public static void SetProbeCountY(Entity e, int value)

Sets the Probe Volume component's Probe Count Y value on the entity.

methodstatic

#public static int GetProbeCountZ(Entity e)

Reads the Probe Volume component's Probe Count Z value of the entity.

methodstatic

#public static void SetProbeCountZ(Entity e, int value)

Sets the Probe Volume component's Probe Count Z value on the entity.

methodstatic

#public static float GetBlendDistance(Entity e)

Reads the Probe Volume component's Blend Distance value of the entity.

methodstatic

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

Sets the Probe Volume component's Blend Distance value on the entity.

methodstatic

#public static float GetNormalBias(Entity e)

Reads the Probe Volume component's Normal Bias value of the entity.

methodstatic

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

Sets the Probe Volume component's Normal Bias value on the entity.

methodstatic

#public static int GetPriority(Entity e)

Reads the Probe Volume component's Priority value of the entity.

methodstatic

#public static void SetPriority(Entity e, int value)

Sets the Probe Volume component's Priority value on the entity.

methodstatic

#public static ulong GetBakedData(Entity e)

Reads the Probe Volume component's Baked Data value of the entity.

methodstatic

#public static void SetBakedData(Entity e, ulong value)

Sets the Probe Volume component's Baked Data 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 float GetIntensity(Entity e)
public static void SetIntensity(Entity e, float value)
public static bool IsBakeRequested(Entity e)
public static void SetBakeRequested(Entity e, bool value)
public static Vector3 GetBoxExtents(Entity e)
public static void SetBoxExtents(Entity e, Vector3 value)
public static Vector3 GetBoxOffset(Entity e)
public static void SetBoxOffset(Entity e, Vector3 value)
public static int GetProbeCountX(Entity e)
public static void SetProbeCountX(Entity e, int value)
public static int GetProbeCountY(Entity e)
public static void SetProbeCountY(Entity e, int value)
public static int GetProbeCountZ(Entity e)
public static void SetProbeCountZ(Entity e, int value)
public static float GetBlendDistance(Entity e)
public static void SetBlendDistance(Entity e, float value)
public static float GetNormalBias(Entity e)
public static void SetNormalBias(Entity e, float value)
public static int GetPriority(Entity e)
public static void SetPriority(Entity e, int value)
public static ulong GetBakedData(Entity e)
public static void SetBakedData(Entity e, ulong value)

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