API Docs for: 1.4.0
Show:

Kiwi.HUD.HUDDisplay Class

Defined in: src\hud\HUDDisplay.ts:10
Module: HUD
Parent Module: Kiwi

A HUDDisplay is a container for which you can add/removes widget on, and is more used to manage the widgets that are being displayed on it. A HUDDisplay is created through a games HUDManager and is NOT directly instantiated. Each game can contain multiple HUDDisplay's and each HUDDisplay can contain multiple HUDWidgets.

Constructor

Kiwi.HUD.HUDDisplay

(
  • game
  • name
)

Defined in src\hud\HUDDisplay.ts:10

Parameters:

  • game Kiwi.Game

    The game that this HUD Display belongs to.

  • name String

    The name of this display.

Returns:

HUDDisplay

Methods

addWidget

(
  • widget
)
Boolean public

Defined in src\hud\HUDDisplay.ts:108

Adds a widget to the HUDDisplay. Returns a boolean as an indication of whether or not it was successful.

Parameters:

Returns:

Boolean:

If it was successful or not.

hide

() public

Defined in src\hud\HUDDisplay.ts:206

Hides the current HUD Display from the screen.

objType

() String public

Defined in src\hud\HUDDisplay.ts:48

Returns the type of object that this is.

Returns:

String:

"HUDDisplay"

removeAllWidgets

() public

Defined in src\hud\HUDDisplay.ts:153

Removes all of the widgets on this display.

removeFromContainer

(
  • widget
)
Boolean

Defined in src\hud\HUDDisplay.ts:166

Removes a widget from on the HUDDisplay.

Parameters:

Returns:

Boolean:

removeWidget

(
  • widget
)
Boolean public

Defined in src\hud\HUDDisplay.ts:128

Removes a singular widget from the display. Returns a boolean as an indication of if anything happened or not.

Parameters:

Returns:

Boolean:

If it was successful or not.

show

() public

Defined in src\hud\HUDDisplay.ts:197

Shows displays the HUD Display on screen.

update

() public

Defined in src\hud\HUDDisplay.ts:186

Update loop.

Properties

_device

Number private

Defined in src\hud\HUDDisplay.ts:58

The type of device that is being targeted for the game. This is the same as games deviceTargetOption Needed as the type of device will detiremine how the items will be added to game or whether it will even work.

_game

Kiwi.Game private

Defined in src\hud\HUDDisplay.ts:92

The game that this HUD Display is on.

_manager

Kiwi.HUD.HUDManager private

Defined in src\hud\HUDDisplay.ts:68

The HUD Manager that this Display belongs to.

_widgets

Array private

Defined in src\hud\HUDDisplay.ts:100

Contains a list of the widgets that are contained in this HUDDisplay. Each member is of the type Kiwi.HUD.HUDWidget.

class

String public

Defined in src\hud\HUDDisplay.ts:215

The class name that the container element that this HUDWidget current has.

container

HTMLDivElement public

Defined in src\hud\HUDDisplay.ts:76

Holds the container HTMLDivElement.

name

String public

Defined in src\hud\HUDDisplay.ts:84

The name of this HUD Display.