SCRIPTING API / Other / ReflectionProbe

ReflectionProbe

Script access to an entity's Reflection Probe: enable it, scale its light, and request a new capture with SetBakeRequested(entity, true) (taken over the next frames; the flag clears when it starts).

Kindclass

NamespaceKroys.EngineScripting

Members21

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

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

Declaration

public static partial class ReflectionProbe

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Reflection Probe component.

methodstatic

#public static bool IsEnabled(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetIntensity(Entity e)

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

methodstatic

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

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

methodstatic

#public static bool IsBakeRequested(Entity e)

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

methodstatic

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

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

methodstatic

#public static Vector3 GetBoxExtents(Entity e)

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

methodstatic

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

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

methodstatic

#public static Vector3 GetBoxOffset(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetBlendDistance(Entity e)

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

methodstatic

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

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

methodstatic

#public static int GetPriority(Entity e)

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

methodstatic

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

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

methodstatic

#public static bool GetParallaxCorrection(Entity e)

Reads the Reflection Probe component's Parallax Correction value of the entity.

methodstatic

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

Sets the Reflection Probe component's Parallax Correction value on the entity.

methodstatic

#public static bool GetBakeOnStart(Entity e)

Reads the Reflection Probe component's Bake On Start value of the entity.

methodstatic

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

Sets the Reflection Probe component's Bake On Start value on the entity.

methodstatic

#public static ulong GetBakedTexture(Entity e)

Reads the Reflection Probe component's Baked Texture value of the entity.

methodstatic

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

Sets the Reflection Probe component's Baked Texture 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 float GetBlendDistance(Entity e)
public static void SetBlendDistance(Entity e, float value)
public static int GetPriority(Entity e)
public static void SetPriority(Entity e, int value)
public static bool GetParallaxCorrection(Entity e)
public static void SetParallaxCorrection(Entity e, bool value)
public static bool GetBakeOnStart(Entity e)
public static void SetBakeOnStart(Entity e, bool value)
public static ulong GetBakedTexture(Entity e)
public static void SetBakedTexture(Entity e, ulong value)

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