Home Reference Source
import {GameHUD} from 'shapez.io/js/game/hud/hud.js'
public class | source

GameHUD

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

parts: {"buildingsToolbar": *, "wiresToolbar": *, "layerToolbars": *, "blueprintPlacer": *, "buildingPlacer": *, "unlockNotification": *, "gameMenu": *, "massSelector": *, "shop": *, "statistics": *, "waypoints": *, "wireInfo": *, "leverToggle": *, "constantSignalEdit": *, "pinnedShapes": *, "notifications": *, "settingsMenu": *, "debugInfo": *, "dialogs": *, "screenshotExporter": *, "shapeViewer": *, "wiresOverlay": *, "layerPreview": *, "minerHighlight": *, "tutorialVideoOffer": *, "changesDebugger": *}

public

root: *

public

signals: {"buildingSelectedForPlacement": *, "selectedPlacementBuildingChanged": *, "shapePinRequested": *, "shapeUnpinRequested": *, "notification": *, "buildingsSelectedForCopy": *, "pasteBlueprintRequested": *, "viewShapeDetailsRequested": *, "unlockNotificationFinished": *}

public

Method Summary

Public Methods
public

Cleans up everything

public

Attempts to close all overlays

public

draw(parameters: DrawParameters)

Draws all parts

public

Draws all part overlays

public

Returns true if the rendering can be paused

public

Initializes the hud parts

public

Returns true if the game logic should be paused

public

Returns true if the rendering can be paused

public

Toggles the ui

public

update()

Updates all parts

Public Constructors

public constructor(root: GameRoot) source

Params:

NameTypeAttributeDescription
root GameRoot

Public Members

public parts: {"buildingsToolbar": *, "wiresToolbar": *, "layerToolbars": *, "blueprintPlacer": *, "buildingPlacer": *, "unlockNotification": *, "gameMenu": *, "massSelector": *, "shop": *, "statistics": *, "waypoints": *, "wireInfo": *, "leverToggle": *, "constantSignalEdit": *, "pinnedShapes": *, "notifications": *, "settingsMenu": *, "debugInfo": *, "dialogs": *, "screenshotExporter": *, "shapeViewer": *, "wiresOverlay": *, "layerPreview": *, "minerHighlight": *, "tutorialVideoOffer": *, "changesDebugger": *} source

public root: * source

public signals: {"buildingSelectedForPlacement": *, "selectedPlacementBuildingChanged": *, "shapePinRequested": *, "shapeUnpinRequested": *, "notification": *, "buildingsSelectedForCopy": *, "pasteBlueprintRequested": *, "viewShapeDetailsRequested": *, "unlockNotificationFinished": *} source

public trailerMaker: * source

Public Methods

public cleanup() source

Cleans up everything

public closeAllOverlays() source

Attempts to close all overlays

public draw(parameters: DrawParameters) source

Draws all parts

Params:

NameTypeAttributeDescription
parameters DrawParameters

public drawOverlays(parameters: DrawParameters) source

Draws all part overlays

Params:

NameTypeAttributeDescription
parameters DrawParameters

public hasBlockingOverlayOpen(): boolean source

Returns true if the rendering can be paused

Return:

boolean

public initialize() source

Initializes the hud parts

public shouldPauseGame(): boolean source

Returns true if the game logic should be paused

Return:

boolean

public shouldPauseRendering(): boolean source

Returns true if the rendering can be paused

Return:

boolean

public toggleUi() source

Toggles the ui

public update() source

Updates all parts