Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HUDMinimap

typedef

{{ expireTime: number, tile: Vector, element: Element }} MinimapAlert

Hierarchy

Index

Constructors

constructor

Methods

cleanup

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

    Returns void

close

  • close(): void
  • Should close the element, in case its supported

    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

handleMinimapDown

  • handleMinimapDown(event: any): void
  • Parameters

    • event: any

    Returns void

handleMousemove

  • handleMousemove(event: any): void
  • Parameters

    • event: any

    Returns void

handleMouseup

  • handleMouseup(event: any): void
  • Parameters

    • event: any

    Returns void

initCanvas

  • initCanvas(): void
  • Returns void

initDragging

  • initDragging(): void
  • Returns void

initZooming

  • initZooming(): void
  • Returns void

initialize

  • initialize(): void

isBlockingOverlay

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

    Returns boolean

onStructureDestroyed

  • onStructureDestroyed(entity: any): void
  • Handles a destroyed structure

    Parameters

    • entity: any

    Returns void

queueRerender

  • queueRerender(): void
  • Marks the map as dirty so that the resources will be rerendered

    Returns void

registerClickDetector

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

    Parameters

    • detector: any

    Returns void

rerenderMap

  • rerenderMap(): void
  • Rerenders the map structures

    Returns void

rerenderViewport

  • rerenderViewport(): void
  • Rerenders the viewport and copies the map structures below

    Returns void

shouldPauseGame

  • shouldPauseGame(): boolean
  • Should return false if the game should be paused

    Returns boolean

shouldPauseRendering

  • shouldPauseRendering(): boolean
  • Should return true if the widget has a modal dialog opened and thus the game does not need to update / redraw

    Returns boolean

spawnAlert

  • spawnAlert(durationSeconds: any, tile: any): void
  • Spawns a new alert

    Parameters

    • durationSeconds: any

      How long to show it

    • tile: any

      On which tile to show it

    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

transformScreenToMinimap

  • transformScreenToMinimap(x: any, y: any): Vector
  • Transforms from screen space into minimap space (0 .. 1)

    Parameters

    • x: any
    • y: any

    Returns Vector

transformScreenToMinimapToWorld

  • transformScreenToMinimapToWorld(x: any, y: any): Vector
  • Transforms from screen space into minimap space (0 .. 1)

    Parameters

    • x: any
    • y: any

    Returns Vector

update

  • update(): void
  • Updates the minimap, checks for changes

    Returns void

updateCanZoomIn

  • updateCanZoomIn(canZoom: any): void
  • Parameters

    • canZoom: any

    Returns void

updateCanZoomOut

  • updateCanZoomOut(canZoom: any): void
  • Parameters

    • canZoom: any

    Returns void

updateIsZoomed

  • updateIsZoomed(zoomed: any): void
  • Internal change handler when the map is zoomed flag changed

    Parameters

    • zoomed: any

    Returns void

zoomIn

  • zoomIn(): void
  • Zooms in

    Returns void

zoomOut

  • zoomOut(): void
  • Zooms out

    Returns void