import {HUDSandboxController} from 'shapez.io/js/game/hud/parts/sandbox_controller.js'HUDSandboxController
Extends:
Method Summary
| Public Methods | ||
| public |
createElements(parent: *) |
|
| public |
|
|
| public |
|
|
| public |
|
|
| public |
modifyLevel(amount: *) |
|
| public |
modifyUpgrade(id: *, amount: *) |
|
| public |
toggle() |
|
| public |
update() |
|
Inherited Summary
| From class BaseHUDPart | ||
| public |
|
|
| public |
root: * |
|
| public |
cleanup() Cleans up the hud element, if overridden make sure to call super.cleanup |
|
| public |
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 |
Should initialize the element, called after the elements have been created |
|
| public |
Should return true if this overlay is open and currently blocking any user interaction |
|
| public |
Registers a new click detector |
|
| public |
Should return false if the game should be paused |
|
| public |
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 Methods
public createElements(parent: *) source
Should create all require elements
Override:
BaseHUDPart#createElementsParams:
| Name | Type | Attribute | Description |
| parent | * |
public giveBlueprints() source
public initialize() source
Should initialize the element, called after the elements have been created
Override:
BaseHUDPart#initializepublic maxOutAll() source
public modifyLevel(amount: *) source
Params:
| Name | Type | Attribute | Description |
| amount | * |
public modifyUpgrade(id: *, amount: *) source
Params:
| Name | Type | Attribute | Description |
| id | * | ||
| amount | * |