import {HUDBuildingPlacer} from 'shapez.io/js/game/hud/parts/building_placer.js'

public class | source

HUDBuildingPlacer

Extends:

BaseHUDPart → HUDBuildingPlacerLogic → HUDBuildingPlacer

Member Summary

Public Members
public	buildingInfoElements: {}
public	currentInterpolatedCornerTile: *
public	domAttach: *
public	element: *
public	lockIndicatorSprites: {}
public	variantClickDetectors: Array<ClickDetectorConstructorArgs> Stores the click detectors for the variants so we can clean them up later
public	variantsAttach: *
public	variantsElement: *

Method Summary

Public Methods
public	cleanup()
public	cleanupVariantClickDetectors() Cleans up all variant click detectors
public	createElements(parent: HTMLElement)
public	draw(parameters: DrawParameters)
public	drawDirectionLock(parameters: DrawParameters)
public	drawLayerPeek(parameters: DrawParameters)
public	drawMatchingAcceptorsAndEjectors(parameters: DrawParameters)
public	drawRegularPlacement(parameters: DrawParameters)
public	initialize()
public	makeLockIndicatorSprite(layer: Layer): * Makes the lock indicator sprite for the given layer
public	rerenderInfoDialog() Rerenders the building info dialog
public	rerenderVariants() Rerenders the variants displayed

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

From class HUDBuildingPlacerLogic
public get	currentBaseRotation: number: * Returns the current base rotation for the current meta-building.
public set	currentBaseRotation(rotation: number) Sets the base rotation for the current meta-building.
public get	currentDirectionLockCorner: Vector \| null: * Returns the current direction lock corner, that is, the corner between mouse and original start point
public get	isDirectionLockActive: boolean: * Returns if the direction lock is currently active
public	currentBaseRotationGeneral: number The current rotation
public	currentDirectionLockSide: number The side for direction lock
public	currentDirectionLockSideIndeterminate: boolean Whether the side for direction lock has not yet been determined.
public	currentMetaBuilding: TypedTrackedState<MetaBuilding> The current building
public	currentVariant: TypedTrackedState<string> Current building variant
public	currentlyDeleting: boolean Whether we are currently drag-deleting
public	currentlyDragging: boolean Whether we are currently dragging
public	fakeEntity: Entity We use a fake entity to get information about how a building will look once placed
public	initialPlacementVector: *
public	lastDragTile: Vector The tile we last dragged from
public	preferredBaseRotations: {} The current rotation preference for each building.
public	preferredVariants: Object<string, string> Stores which variants for each building we prefer, this is based on what the user last selected
public	signals: {"variantChanged": , "draggingStarted": }
public	abortDragging() Aborts any dragging
public	abortPlacement(): * Aborts the placement
public	checkForDirectionLockSwitch(args: any) Checks if the direction lock key got released and if such, resets the placement
public	computeDirectionLockPath(): Array<{tile: Vector, rotation: number}> Finds the path which the current direction lock will use
public	cycleVariants() Cycles through the variants
public	deleteBelowCursor(): boolean Tries to delete the building under the mouse
public	executeDirectionLockedPlacement() Performs the direction locked placement between two points after releasing the mouse
public	initialize() Initializes the logic
public	initializeBindings() Initializes all bindings
public	onEditModeChanged(layer: Layer) Called when the edit mode got changed
public	onMouseDown(pos: Vector, button: enumMouseButton): * mouse down pre handler
public	onMouseMove(pos: Vector): * mouse move pre handler
public	onMouseUp() Mouse up handler
public	onSelectedMetaBuildingChanged(metaBuilding: MetaBuilding) Called when the selected buildings changed
public	setVariant(variant: string) Sets the current variant to the given variant
public	startPipette() Starts the pipette function
public	startSelection(metaBuilding: MetaBuilding) Selects a given building
public	switchDirectionLockSide() Switches the side for the direction lock manually
public	tryPlaceCurrentBuildingAt(tile: Vector): boolean Tries to place the current building at the given tile
public	tryRotate() Tries to rotate the current building
public	update()

Public Members

public buildingInfoElements: {} source

public currentInterpolatedCornerTile: * source

public domAttach: * source

public element: * source

public lockIndicatorSprites: {} source

public variantClickDetectors: Array<ClickDetectorConstructorArgs> source

Stores the click detectors for the variants so we can clean them up later

public variantsAttach: * source

public variantsElement: * source

Public Methods

public cleanup() source

Cleans up the hud element, if overridden make sure to call super.cleanup

Override:

BaseHUDPart#cleanup

public cleanupVariantClickDetectors() source

Cleans up all variant click detectors

public createElements(parent: HTMLElement) source

Should create all require elements

Override:

BaseHUDPart#createElements

Params:

Name	Type	Attribute	Description
parent	HTMLElement

public draw(parameters: DrawParameters) source

Should draw the hud

Override:

BaseHUDPart#draw

Params:

Name	Type	Attribute	Description
parameters	DrawParameters

public drawDirectionLock(parameters: DrawParameters) source

Params:

Name	Type	Attribute	Description
parameters	DrawParameters

public drawLayerPeek(parameters: DrawParameters) source

Params:

Name	Type	Attribute	Description
parameters	DrawParameters

public drawMatchingAcceptorsAndEjectors(parameters: DrawParameters) source

Params:

Name	Type	Attribute	Description
parameters	DrawParameters

public drawRegularPlacement(parameters: DrawParameters) source

Params:

Name	Type	Attribute	Description
parameters	DrawParameters

public initialize() source

Initializes the logic

Override:

HUDBuildingPlacerLogic#initialize

public makeLockIndicatorSprite(layer: Layer): * source

Makes the lock indicator sprite for the given layer

Params:

Name	Type	Attribute	Description
layer	Layer

HUDBuildingPlacer

Extends:

Member Summary

Method Summary

Inherited Summary

Public Members

public buildingInfoElements: {} source

public currentInterpolatedCornerTile: * source

public domAttach: * source

public element: * source

public lockIndicatorSprites: {} source

public variantClickDetectors: Array<ClickDetectorConstructorArgs> source

public variantsAttach: * source

public variantsElement: * source

Public Methods

public cleanup() source

Override:

public cleanupVariantClickDetectors() source

public createElements(parent: HTMLElement) source

Override:

Params:

public draw(parameters: DrawParameters) source

Override:

Params:

public drawDirectionLock(parameters: DrawParameters) source

Params:

public drawLayerPeek(parameters: DrawParameters) source

Params:

public drawMatchingAcceptorsAndEjectors(parameters: DrawParameters) source

Params:

public drawRegularPlacement(parameters: DrawParameters) source

Params:

public initialize() source

Override:

public makeLockIndicatorSprite(layer: Layer): * source

Params:

Return:

public rerenderInfoDialog() source

public rerenderVariants() source