API Docs for: 1.4.0
Show:

Kiwi.HUD.HUDManager Class

Defined in: src\hud\HUDManager.ts:12
Module: HUD
Parent Module: Kiwi

This class manages all of the various HUDDisplays that are currently used on this Managers game. Using this class you can create/add and remove HUDDisplays from this game, change the HUDDisplay that is currently being display (also known as the currentHUD) and show/hide the currentHUD. Each HUDManager also has at least one HUDDisplay which is called the 'defaultHUD' you cannot remove, but you can reassign the defaultHUD to be a different HUDDisplay if you want.

Constructor

Kiwi.HUD.HUDManager

(
  • game
)
Kiwi.HUD.HUDManager

Defined in src\hud\HUDManager.ts:12

Parameters:

Returns:

Kiwi.HUD.HUDManager:

Methods

addToContainer

(
  • hud
)
private

Defined in src\hud\HUDManager.ts:250

Adds a HUDDisplays HTMLDivElement to this HUDManagers container element.

Parameters:

boot

() public

Defined in src\hud\HUDManager.ts:76

The DOM is ready, so if the current state is pending we can boot up the HUD now.

createHUD

(
  • name
  • [switchTo=false]
)
Kiwi.HUD.HUDDisplay public

Defined in src\hud\HUDManager.ts:195

Creates a new HUDDisplay on this HUDManager.

Parameters:

  • name String

    Name of the new HUDDisplay that is being creates.

  • [switchTo=false] Boolean optional

    Switch to the new HUD that was created. DE

Returns:

Kiwi.HUD.HUDDisplay:

The HUDDisplay that was created.

hideHUD

(
  • [hud=currentHUD]
)
public

Defined in src\hud\HUDManager.ts:185

Hides the currentHUD (if nothing is passed) or shows a HUDDisplay that is passed.

Parameters:

  • [hud=currentHUD] Kiwi.HUD.HUDDisplay optional

    The HUDDisplay you want to hude. Defaults to the currentHUD if nothing is passed.

objType

() String public

Defined in src\hud\HUDManager.ts:107

Returns the type of object this is.

Returns:

String:

"HUDManager"

removeFromContainer

(
  • hud
)
private

Defined in src\hud\HUDManager.ts:262

Removes the hud that is passed from this HUD Manager. Checks to see if that hud has this container as a parent first.

Parameters:

removeHUD

(
  • hud
)
Boolean public

Defined in src\hud\HUDManager.ts:220

Removes a HUDDisplay off this manager. Returns a boolean indicating whether or not this method was a success.

Parameters:

Returns:

Boolean:

If this method succeeded or not.

setHUD

(
  • hud
)
public

Defined in src\hud\HUDManager.ts:161

Changes the currentHUD that is being displayed to one that is passed.

Parameters:

showHUD

(
  • [hud=currentHUD]
)
public

Defined in src\hud\HUDManager.ts:175

Shows the currentHUD (if nothing is passed) or shows a HUDDisplay that is passed.

Parameters:

  • [hud=currentHUD] Kiwi.HUD.HUDDisplay optional

    The HUDDisplay you want to show. Defaults to the currentHUD if nothing is passed.

update

() public

Defined in src\hud\HUDManager.ts:277

Game loop

Properties

_currentHUD

Kiwi.HUD.HUDDisplay private

Defined in src\hud\HUDManager.ts:134

The currentHUD that is in use. Can be the same as the defaultHUD.

_defaultHUD

Kiwi.HUD.HUDDisplay private

Defined in src\hud\HUDManager.ts:125

The defaultHUD that is being used. The defaultHUD cannot be removed, but can be swapped out for another HUDDisplay.

_device

Number private

Defined in src\hud\HUDManager.ts:41

The device that this game is being target at. The same as the deviceTargetOption property on the root Game. This is needed as it detirmines if HUD is supported on the device or not and if so, how it is implemented.

_game

Kiwi.Game private

Defined in src\hud\HUDManager.ts:33

The game that this HUDManager belongs to.

_hudContainer

HTMLDivElement private

Defined in src\hud\HUDManager.ts:68

The HTMLDivElement that is being used as the container for the whole manager.

_huds

Array private

Defined in src\hud\HUDManager.ts:117

An array containing all of the HUDDisplays that are currently active on this HUDManager.

_supported

Boolean private

Defined in src\hud\HUDManager.ts:50

If the HUD is supported on the DEVICE that is being targeted. Gets set during the BOOT sequence.

defaultHUD

Kiwi.HUD.HUDDisplay public

Defined in src\hud\HUDManager.ts:142

The default HUDDisplay that is to be used. The defaultHUD cannot be removed, and a game (that supports HUDS) will always contain the defaultHUD.

supported

Boolean public

Defined in src\hud\HUDManager.ts:58

Returns the _supported property indicating whether HUD is supported or not.