import {HUDDebugInfo} from 'shapez.io/js/game/hud/parts/debug_info.js'

public class | source

HUDDebugInfo

Extends:

BaseHUDPart → HUDDebugInfo

Member Summary

Public Members
public	domAttach: *
public	element: *
public	lastTick: number
public	trackedCameraPosition: *
public	trackedFPS: *
public	trackedMode: *
public	trackedMousePosition: *
public	trackedTickDuration: *
public	trackedTickRate: *
public	versionElement: *

Method Summary

Public Methods
public	createElements(parent: *)
public	cycleModes() Cycles through the different modes
public	initialize()
public	onModeChanged(mode: enumDebugOverlayMode) Called when the mode changed
public	update()
public	updateDetailedInformation() Updates the detailed information
public	updateLabels() Updates the labels

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 domAttach: * source

public element: * source

public lastTick: number source

public trackedCameraPosition: * source

public trackedFPS: * source

public trackedMode: * source

public trackedMousePosition: * source

public trackedTickDuration: * source

public trackedTickRate: * source

public versionElement: * source

Public Methods

public createElements(parent: *) source

Should create all require elements

Override:

BaseHUDPart#createElements

Params:

Name	Type	Attribute	Description
parent	*

public cycleModes() source

Cycles through the different modes

public initialize() source

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

Override:

BaseHUDPart#initialize

public onModeChanged(mode: enumDebugOverlayMode) source

Called when the mode changed

Params:

Name	Type	Attribute	Description
mode	enumDebugOverlayMode

public update() source

Should update any required logic

Override:

BaseHUDPart#update

public updateDetailedInformation() source

Updates the detailed information

public updateLabels() source

Updates the labels