SCRIPTING API / UI / UICanvas

UICanvas

Script access to an entity's UI Canvas: the UI document it shows, screen or world space, and input.

Kindclass

NamespaceKroys.EngineScripting

Members13

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

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

Declaration

public static partial class UICanvas

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a UI Canvas component.

methodstatic

#public static bool IsVisible(Entity e)

Reads the UI Canvas component's Visible value of the entity.

methodstatic

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

Sets the UI Canvas component's Visible value on the entity.

methodstatic

#public static bool ReceivesInput(Entity e)

Reads the UI Canvas component's receives input flag of the entity.

methodstatic

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

Sets the UI Canvas component's Receive Input value on the entity.

methodstatic

#public static UICanvasSpace GetSpace(Entity e)

Reads the UI Canvas component's Space value of the entity.

methodstatic

#public static void SetSpace(Entity e, UICanvasSpace value)

Sets the UI Canvas component's Space value on the entity.

methodstatic

#public static Vector3 GetScreenOffset(Entity e)

Reads the UI Canvas component's Screen Offset value of the entity.

methodstatic

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

Sets the UI Canvas component's Screen Offset value on the entity.

methodstatic

#public static Vector3 GetWorldSize(Entity e)

Reads the UI Canvas component's World Size value of the entity.

methodstatic

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

Sets the UI Canvas component's World Size value on the entity.

methodstatic

#public static ulong GetDocument(Entity e)

Reads the UI Canvas component's Document value of the entity.

methodstatic

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

Sets the UI Canvas component's Document 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 bool ReceivesInput(Entity e)
public static void SetReceiveInput(Entity e, bool value)
public static UICanvasSpace GetSpace(Entity e)
public static void SetSpace(Entity e, UICanvasSpace value)
public static Vector3 GetScreenOffset(Entity e)
public static void SetScreenOffset(Entity e, Vector3 value)
public static Vector3 GetWorldSize(Entity e)
public static void SetWorldSize(Entity e, Vector3 value)
public static ulong GetDocument(Entity e)
public static void SetDocument(Entity e, ulong value)

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