SCRIPTING API / Rendering and effects / Billboard

Billboard

Script access to an entity's Billboard: a camera-facing quad with a material.

Kindclass

NamespaceKroys.EngineScripting

Members17

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

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

Declaration

public static partial class Billboard

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Billboard component.

methodstatic

#public static bool IsVisible(Entity e)

Reads the Billboard component's Visible value of the entity.

methodstatic

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

Sets the Billboard component's Visible value on the entity.

methodstatic

#public static BillboardFacingMode GetFacingMode(Entity e)

Reads the Billboard component's Facing Mode value of the entity.

methodstatic

#public static void SetFacingMode(Entity e, BillboardFacingMode value)

Sets the Billboard component's Facing Mode value on the entity.

methodstatic

#public static Vector3 GetSize(Entity e)

Reads the Billboard component's Size value of the entity.

methodstatic

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

Sets the Billboard component's Size value on the entity.

methodstatic

#public static Vector3 GetPivot(Entity e)

Reads the Billboard component's Pivot value of the entity.

methodstatic

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

Sets the Billboard component's Pivot value on the entity.

methodstatic

#public static float GetRotationDegrees(Entity e)

Reads the Billboard component's Rotation Degrees value of the entity.

methodstatic

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

Sets the Billboard component's Rotation Degrees value on the entity.

methodstatic

#public static ulong GetMaterial(Entity e)

Reads the Billboard component's Material value of the entity.

methodstatic

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

Sets the Billboard component's Material value on the entity.

methodstatic

#public static bool GetAllowOcclusion(Entity e)

Reads the Billboard component's Allow Occlusion value of the entity.

methodstatic

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

Sets the Billboard component's Allow Occlusion value on the entity.

methodstatic

#public static float GetSortBias(Entity e)

Reads the Billboard component's Sort Bias value of the entity.

methodstatic

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

Sets the Billboard component's Sort Bias value on the entity.

methodstatic

Signatures

public static bool Has(Entity e)
public static bool IsVisible(Entity e)
public static void SetVisible(Entity e, bool value)
public static BillboardFacingMode GetFacingMode(Entity e)
public static void SetFacingMode(Entity e, BillboardFacingMode value)
public static Vector3 GetSize(Entity e)
public static void SetSize(Entity e, Vector3 value)
public static Vector3 GetPivot(Entity e)
public static void SetPivot(Entity e, Vector3 value)
public static float GetRotationDegrees(Entity e)
public static void SetRotationDegrees(Entity e, float value)
public static ulong GetMaterial(Entity e)
public static void SetMaterial(Entity e, ulong value)
public static bool GetAllowOcclusion(Entity e)
public static void SetAllowOcclusion(Entity e, bool value)
public static float GetSortBias(Entity e)
public static void SetSortBias(Entity e, float value)

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