import {HUDWiresOverlay} from 'shapez.io/js/game/hud/parts/wires_overlay.js'

public class | source

HUDWiresOverlay

Extends:

BaseHUDPart → HUDWiresOverlay

Member Summary

Public Members
public	cachedPatternBackground: *
public	currentAlpha: number
public	tilePatternCanvas: *

Method Summary

Public Methods
public	copyWireValue() Copies the wires value below the cursor
public	createElements(parent: *)
public	draw(parameters: DrawParameters)
public	generateTilePattern() Generates the background pattern for the wires overlay
public	initialize()
public	switchLayers() Switches between layers
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 cachedPatternBackground: * source

public currentAlpha: number source

public tilePatternCanvas: * source

Public Methods

public copyWireValue() source

Copies the wires value below the cursor

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 generateTilePattern() source

Generates the background pattern for the wires overlay

public initialize() source

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

Override:

BaseHUDPart#initialize

public switchLayers() source

Switches between layers

public update() source

Should update any required logic

Override:

BaseHUDPart#update