HUD Module

Defined in: src\hud\HUDWidget.ts:9

The HUD (Heads Up Display) is a section that handles the displayment of information that you always want visible to user. This section is managed differently to normal GameObjects, where the difference being that HUD items aren't added to a Canvas but are DOM elements instead. Since they DOM elements you can style these elements using a CSS sheet if you wish.

This module provides the following classes:

This module is a rollup of the following modules:

HUDComponents
HUDComponents are a space where components that are specific to HUDWidgets are kept. This are seperated from the normal Components section as the implementation of these are unique and only make sense when implemented on HUDWidgets, otherwise the concepts behind these are the same as normal Components.
Widget
HUD Widgets are objects that are generally placed on to a HUD Display for displaying and managing information that the user would always need to see. An example of such information would be: the Health remaining, amount of ammo left, time they have left, e.t.c. And each one of those examples would have its own widget.

APIs

HUD Module