Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HUDIntroduction

Hierarchy

Index

Constructors

constructor

Methods

checkShow

  • checkShow(): void
  • Returns void

cleanup

  • cleanup(): void
  • Cleans up the hud element, if overridden make sure to call super.cleanups

    Returns void

close

  • close(): void
  • Returns void

closeOnBackgroundClick

  • closeOnBackgroundClick(element: any, closeMethod?: any): void
  • Closes this element when its background is clicked

    Parameters

    • element: any
    • Default value closeMethod: any = null

    Returns void

closeOnOverlayOpen

  • closeOnOverlayOpen(closeMethod?: any): void
  • Calls closeMethod if an overlay is opened

    Parameters

    • Default value closeMethod: any = null

    Returns void

createElements

  • createElements(parent: any): void

draw

  • draw(parameters: any): void
  • Should draw the hud

    Parameters

    • parameters: any

    Returns void

drawOverlays

  • drawOverlays(parameters: any): void
  • Should draw any overlays (screen space)

    Parameters

    • parameters: any

    Returns void

forwardGameSpeedKeybindings

  • forwardGameSpeedKeybindings(sourceMapper: any): void
  • Forwards the game speed keybindings so you can toggle pause / Fastforward in the building tooltip and such

    Parameters

    • sourceMapper: any

    Returns void

forwardMapMovementKeybindings

  • forwardMapMovementKeybindings(sourceMapper: any): void
  • Forwards the map movement keybindings so you can move the map with the arrow keys

    Parameters

    • sourceMapper: any

    Returns void

forwardSidebarKeybindings

  • forwardSidebarKeybindings(sourceMapper: any): void
  • Forwards the game speed keybindings so you can toggle pause / Fastforward in the building tooltip and such

    Parameters

    • sourceMapper: any

    Returns void

initialize

  • initialize(): void

isBlockingOverlay

  • isBlockingOverlay(): boolean
  • Should return true if this overlay is open and currently blocking any user interaction

    Returns boolean

isVisible

  • isVisible(): any
  • Returns any

registerClickDetector

  • registerClickDetector(detector: any): void
  • Registers a new click detector

    Parameters

    • detector: any

    Returns void

shouldPauseGame

  • shouldPauseGame(): any

shouldPauseRendering

  • shouldPauseRendering(): any

trackClicks

  • trackClicks(element: any, handler: any, args?: object): void
  • Helper method to construct a new click detector

    Parameters

    • element: any

      The element to listen on

    • handler: any

      The handler to call on this object

    • Default value args: object = {}

      Click detector arguments

    Returns void

tryClose

  • tryClose(): void
  • Returns void

update

  • update(): void
  • Returns void