import {HUDModalDialogs} from 'shapez.io/js/game/hud/parts/modal_dialogs.js'

public class | source

HUDModalDialogs

Extends:

BaseHUDPart → HUDModalDialogs

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	app: Application
public	dialogParent: *
public	dialogStack: *[]
public	domWatcher: *

Method Summary

Public Methods
public	cleanup()
public	close()
public	closeDialog(dialog: *)
public	createElements(parent: ):
public	initialize()
public	initializeToElement(element: *)
public	internalShowDialog(dialog: *)
public	isBlockingOverlay(): *
public	shouldPauseGame(): *
public	shouldPauseRendering(): *
public	showFeatureRestrictionInfo(feature: string, textPrefab: string): *
public	showInfo(title: string, text: string, buttons: Array<string>): *
public	showLoadingDialog(): *
public	showOptionChooser(title: , options: ): *
public	showWarning(title: string, text: string, buttons: Array<string>): *
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 Constructors

public constructor() source

Override:

BaseHUDPart#constructor

Public Members

public app: Application source

public dialogParent: * source

public dialogStack: *[] source

public domWatcher: * source

Public Methods

public cleanup() source

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

Override:

BaseHUDPart#cleanup

public close() source

Should close the element, in case its supported

Override:

BaseHUDPart#close

public closeDialog(dialog: *) source

Params:

Name	Type	Attribute	Description
dialog	*

public createElements(parent: ): source

Should create all require elements

Override:

BaseHUDPart#createElements

Params:

Name	Type	Attribute	Description
parent	*

Return:

public initialize() source

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

Override:

BaseHUDPart#initialize

public initializeToElement(element: *) source

Params:

Name	Type	Attribute	Description
element	*

public internalShowDialog(dialog: *) source

Params:

Name	Type	Attribute	Description
dialog	*

public isBlockingOverlay(): * source

Should return true if this overlay is open and currently blocking any user interaction

Override:

BaseHUDPart#isBlockingOverlay

Return:

public shouldPauseGame(): * source

Should return false if the game should be paused

Override:

BaseHUDPart#shouldPauseGame

Return:

public shouldPauseRendering(): * source

Should return true if the widget has a modal dialog opened and thus the game does not need to update / redraw

Override:

BaseHUDPart#shouldPauseRendering

Return:

public showFeatureRestrictionInfo(feature: string, textPrefab: string): * source

Params:

Name	Type	Attribute	Description
feature	string
textPrefab	string

Return:

public showInfo(title: string, text: string, buttons: Array<string>): * source

Params:

Name	Type	Attribute	Description
title	string
text	string
buttons	Array<string>

Return:

public showLoadingDialog(): * source

Return:

public showOptionChooser(title: , options: ): * source

Params:

Name	Type	Attribute	Description
title	*
options	*

Return:

public showWarning(title: string, text: string, buttons: Array<string>): * source

Params:

Name	Type	Attribute	Description
title	string
text	string
buttons	Array<string>

HUDModalDialogs

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Members

public app: Application source

public dialogParent: * source

public dialogStack: *[] source

public domWatcher: * source

Public Methods

public cleanup() source

Override:

public close() source

Override:

public closeDialog(dialog: *) source

Params:

public createElements(parent: *): * source

Override:

Params:

Return:

public initialize() source

Override:

public initializeToElement(element: *) source

Params:

public internalShowDialog(dialog: *) source

Params:

public isBlockingOverlay(): * source

Override:

Return:

public shouldPauseGame(): * source

Override:

Return:

public shouldPauseRendering(): * source

Override:

Return:

public showFeatureRestrictionInfo(feature: string, textPrefab: string): * source

Params:

Return:

public showInfo(title: string, text: string, buttons: Array<string>): * source

Params:

Return:

public showLoadingDialog(): * source

Return:

public showOptionChooser(title: *, options: *): * source

Params:

Return:

public showWarning(title: string, text: string, buttons: Array<string>): * source

Params:

Return:

public update() source

Override:

public createElements(parent: ): source

public showOptionChooser(title: , options: ): * source