import {HUDEntityDebugger} from 'shapez.io/js/game/hud/parts/entity_debugger.js'

public class | source

HUDEntityDebugger

Extends:

BaseHUDPart → HUDEntityDebugger

Allows to inspect entities by pressing F8 while hovering them

Member Summary

Public Members
public	componentsElem: *
public	domAttach: *
public	element: *
public	lastUpdate: number
public	selectedEntity: Entity The currently selected entity

Method Summary

Public Methods
public	createElements(parent: *)
public	initialize()
public	pickEntity()
public	propertyToHTML(name: string, val: any, indent: number, recursion: Array): string
public	rerenderFull(entity: Entity) Rerenders the whole container
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 componentsElem: * source

public domAttach: * source

public element: * source

public lastUpdate: number source

public selectedEntity: Entity source

The currently selected entity

Public Methods

public createElements(parent: *) source

Should create all require elements

Override:

BaseHUDPart#createElements

Params:

Name	Type	Attribute	Description
parent	*

public initialize() source

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

Override:

BaseHUDPart#initialize

public pickEntity() source

public propertyToHTML(name: string, val: any, indent: number, recursion: Array): string source

Params:

Name	Type	Attribute	Description
name	string
val	any
indent	number
recursion	Array

Return:

string

public rerenderFull(entity: Entity) source

Rerenders the whole container

Params:

Name	Type	Attribute	Description
entity	Entity

public update() source

Should update any required logic

Override:

BaseHUDPart#update