Skip to content

Class: UI

UI is a component for marking an entity as part of the UI, this changes how it is rendered, and how any transform attached to it is interpreted. When attached will cause the entity to be rendered relative to the camera, rather than in world space.

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new UI(camera: IEntity): UI

Parameters:

Name Type
camera IEntity

Returns: UI

Inherited from: Component

Properties

camera

camera: IEntity

Entity of the camera to render this UI element on.


key

key: string

Inherited from: Component.key


KEY

Readonly Static KEY: ui= "ui"

Key of the UI component.


MESSAGE_ADD

Readonly Static MESSAGE_ADD: component_add= "component_add"

Inherited from: Component.MESSAGE_ADD


MESSAGE_REMOVE

Readonly Static MESSAGE_REMOVE: component_remove= "component_remove"

Inherited from: Component.MESSAGE_REMOVE

Methods

Free

Free(): void

Returns: void

Inherited from: Component