import {HUDBlueprintPlacer} from 'shapez.io/js/game/hud/parts/blueprint_placer.js'

public class | source

HUDBlueprintPlacer

Extends:

BaseHUDPart → HUDBlueprintPlacer

Member Summary

Public Members
public	costDisplayParent: *
public	costDisplayText: *
public	currentBlueprint: TypedTrackedState<Blueprint>
public	domAttach: *
public	lastBlueprintUsed: Blueprint
public	trackedCanAfford: *

Method Summary

Public Methods
public	abortPlacement(): *
public	createBlueprintFromBuildings(uids: Array<number>) Called when an array of bulidings was selected
public	createElements(parent: *)
public	draw(parameters: DrawParameters)
public	initialize()
public	onBlueprintChanged(blueprint: Blueprint) Called when the blueprint was changed
public	onCanAffordChanged(canAfford: boolean) Called when the blueprint is now affordable or not
public	onEditModeChanged(layer: Layer) Called when the layer was changed
public	onMouseDown(pos: Vector, button: enumMouseButton): * mouse down pre handler
public	onMouseMove(): * Mose move handler
public	pasteBlueprint() Attempts to paste the last blueprint
public	rotateBlueprint() Attempts to rotate the current blueprint
public	update()

Inherited Summary

From class BaseHUDPart
public	clickDetectors: Array<ClickDetectorConstructorArgs>
public	root: *
public	cleanup() Cleans up the hud element, if overridden make sure to call super.cleanup
public	cleanupClickDetectors() Cleans up all click detectors
public	close() Should close the element, in case its supported
public	closeOnBackgroundClick(element: HTMLElement, closeMethod: function) Closes this element when its background is clicked
public	createElements(parent: HTMLElement) Should create all require elements
public	draw(parameters: DrawParameters) Should draw the hud
public	drawOverlays(parameters: DrawParameters) Should draw any overlays (screen space)
public	forwardGameSpeedKeybindings(sourceMapper: KeyActionMapper) Forwards the game speed keybindings so you can toggle pause / Fastforward in the building tooltip and such
public	forwardMapMovementKeybindings(sourceMapper: KeyActionMapper) Forwards the map movement keybindings so you can move the map with the arrow keys
public	initialize() Should initialize the element, called after the elements have been created
public	isBlockingOverlay(): boolean Should return true if this overlay is open and currently blocking any user interaction
public	registerClickDetector(detector: ClickDetectorConstructorArgs) Registers a new click detector
public	shouldPauseGame(): boolean Should return false if the game should be paused
public	shouldPauseRendering(): boolean Should return true if the widget has a modal dialog opened and thus the game does not need to update / redraw
public	trackClicks(element: Element, handler: function, args: import("../../core/click_detector").ClickDetectorConstructorArgs=) Helper method to construct a new click detector
public	update() Should update any required logic

Public Members

public costDisplayParent: * source

public costDisplayText: * source

public currentBlueprint: TypedTrackedState<Blueprint> source

public domAttach: * source

public lastBlueprintUsed: Blueprint source

public trackedCanAfford: * source

Public Methods

public abortPlacement(): * source

Return:

public createBlueprintFromBuildings(uids: Array<number>) source

Called when an array of bulidings was selected

Params:

Name	Type	Attribute	Description
uids	Array<number>

public createElements(parent: *) source

Should create all require elements

Override:

BaseHUDPart#createElements

Params:

Name	Type	Attribute	Description
parent	*

public draw(parameters: DrawParameters) source

Should draw the hud

Override:

BaseHUDPart#draw

Params:

Name	Type	Attribute	Description
parameters	DrawParameters

public initialize() source

Should initialize the element, called after the elements have been created

Override:

BaseHUDPart#initialize

public onBlueprintChanged(blueprint: Blueprint) source

Called when the blueprint was changed

Params:

Name	Type	Attribute	Description
blueprint	Blueprint

public onCanAffordChanged(canAfford: boolean) source

Called when the blueprint is now affordable or not

Params:

Name	Type	Attribute	Description
canAfford	boolean

public onEditModeChanged(layer: Layer) source

Called when the layer was changed

Params:

Name	Type	Attribute	Description
layer	Layer

public onMouseDown(pos: Vector, button: enumMouseButton): * source

mouse down pre handler

Params:

Name	Type	Attribute	Description
pos	Vector
button	enumMouseButton

Return:

public onMouseMove(): * source

Mose move handler

Return:

public pasteBlueprint() source

Attempts to paste the last blueprint

public rotateBlueprint() source

Attempts to rotate the current blueprint

public update() source

Should update any required logic

Override:

BaseHUDPart#update