Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HUDBuildingsCategoryDialog

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

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

  • Parameters

    • parent: any

    Returns 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

getCurrentCategory

  • getCurrentCategory(): any

  • Returns the current category id

    Returns any

getElementForBuilding

  • getElementForBuilding(metaClass: any): any

  • Returns the element for the given building

    Parameters

    • metaClass: any

    Returns any

initialize

  • initialize(): void

  • Returns void

isBlockingOverlay

  • isBlockingOverlay(): boolean

  • Should return true if this overlay is open and currently blocking any user interaction

    Returns boolean

isOpen

  • isOpen(): any

  • Returns if the dialog is currently open

    Returns any

onBuildingSelected

  • onBuildingSelected(metaBuilding: any): boolean

  • Parameters

    • metaBuilding: any

    Returns boolean

refreshAvailabilities

  • refreshAvailabilities(): void

  • Returns void

registerClickDetector

  • registerClickDetector(detector: any): void

  • Registers a new click detector

    Parameters

    • detector: any

    Returns void

shouldPauseGame

  • shouldPauseGame(): any

shouldPauseRendering

  • shouldPauseRendering(): any

showForCategory

  • showForCategory(category: any): void

  • Parameters

    • category: any

    Returns void

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

update

  • update(): void

  • Returns void