Class Ui

Hierarchy

Host<IUiEvents>
- Ui

Index

Constructors

Properties

event focus highlights hudWidth itemStylesheetHandler loadingBridge promptsBridge saveDropHandler scale screens selection serverJoinHandler tooltips versionText viewport

Accessors

primaryScreenId windowHeight windowWidth

Constructors

constructor

new Ui(): Ui
Returns Ui
Overrides EventEmitter.Host<IUiEvents>.constructor
- Defined in src/game/ui/Ui.ts:113

Properties

`Readonly` event

event: IEventEmitter<Ui, IUiEvents>

`Readonly` focus

focus: default = ...

`Readonly` highlights

highlights: default = ...

`Readonly` hudWidth

hudWidth: default = ...

`Readonly` itemStylesheetHandler

itemStylesheetHandler: default = ...

`Readonly` loadingBridge

loadingBridge: default = ...

`Readonly` promptsBridge

promptsBridge: default = ...

`Readonly` saveDropHandler

saveDropHandler: default = ...

`Readonly` scale

scale: default = ...

`Readonly` screens

screens: default = ...

`Readonly` selection

selection: default = ...

`Readonly` serverJoinHandler

serverJoinHandler: default = ...

`Readonly` tooltips

tooltips: default = ...

`Readonly` versionText

versionText: undefined | default<HTMLElement> = ...

`Readonly` viewport

viewport: default = ...

Accessors

primaryScreenId

get primaryScreenId(): ScreenId
Screen id used while in game / playing

Returns ScreenId
- Defined in src/game/ui/Ui.ts:557

windowHeight

get windowHeight(): number
Returns number
- Defined in src/game/ui/Ui.ts:103

windowWidth

get windowWidth(): number
Returns number
- Defined in src/game/ui/Ui.ts:100

Methods

addStylesheet

addStylesheet(path: string): void
Parameters
- path: string
Returns void
- Defined in src/game/ui/Ui.ts:434

deregisterDataHost

deregisterDataHost(id: string | number, host: any): boolean
Parameters
- id: string | number
- host: any
Returns boolean
- Defined in src/game/ui/Ui.ts:336

enableCustomTitleBar

enableCustomTitleBar(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in src/game/ui/Ui.ts:411

getPercentageFromPixels

getPercentageFromPixels(axis: Axis, pixels: number): number
Returns a percentage of the screen based on the given number of pixels on the given Axis.
Parameters
- axis: Axis
- pixels: number
Returns number
- Defined in src/game/ui/Ui.ts:697

getPixelsFromPercentage

getPixelsFromPercentage(axis: Axis, percentage: number): number
Returns a number of pixels based on the given percentage of the screen on the given Axis.
Parameters
- axis: Axis
- percentage: number
Returns number
- Defined in src/game/ui/Ui.ts:706

getTitleBarHeight

getTitleBarHeight(): 0 | 30
Returns 0 | 30
- Defined in src/game/ui/Ui.ts:419

getTooltipVisibility

getTooltipVisibility(): TooltipVisibilityOption
Returns TooltipVisibilityOption
- Defined in src/game/ui/Ui.ts:359

inspectReference

inspectReference(reference: Reference, context?: InfoProviderContext): boolean
Parameters
- reference: Reference
- Optional context: InfoProviderContext
Returns boolean
- Defined in src/game/ui/Ui.ts:712

`Protected` onChangeInformationVisibility

onChangeInformationVisibility(): void
Returns void
- Defined in src/game/ui/Ui.ts:364

`Protected` onFullscreen

onFullscreen(): boolean
Returns boolean
- Defined in src/game/ui/Ui.ts:615

`Protected` onGlobalSlotReady

onGlobalSlotReady(): void
Returns void
- Defined in src/game/ui/Ui.ts:526

`Protected` onInterruptClosed

onInterruptClosed(): void
Returns void
- Defined in src/game/ui/Ui.ts:578

`Protected` onLanguageChange

onLanguageChange(_: any, language: string): void
Parameters
- _: any
- language: string
Returns void
- Defined in src/game/ui/Ui.ts:587

`Protected` onPlay

onPlay(): void
Returns void
- Defined in src/game/ui/Ui.ts:561

`Protected` onReload

onReload(api: IBindHandlerApi): boolean
Parameters
- api: IBindHandlerApi
Returns boolean
- Defined in src/game/ui/Ui.ts:631

`Protected` onReloadStylesheets

onReloadStylesheets(): boolean
Returns boolean
- Defined in src/game/ui/Ui.ts:662

`Protected` onReloadTextures

onReloadTextures(): boolean
Returns boolean
- Defined in src/game/ui/Ui.ts:668

`Protected` onReloadWithoutSaving

onReloadWithoutSaving(api: IBindHandlerApi): boolean
Parameters
- api: IBindHandlerApi
Returns boolean
- Defined in src/game/ui/Ui.ts:639

`Protected` onScaleDown

onScaleDown(api: IBindHandlerApi): boolean
Parameters
- api: IBindHandlerApi
Returns boolean
- Defined in src/game/ui/Ui.ts:674

`Protected` onScaleUp

onScaleUp(api: IBindHandlerApi): boolean
Parameters
- api: IBindHandlerApi
Returns boolean
- Defined in src/game/ui/Ui.ts:684

`Protected` onShowMoreInfo

onShowMoreInfo(): void
Returns void
- Defined in src/game/ui/Ui.ts:597

`Protected` onStopPlay

onStopPlay(game: Game, state: PlayerState): void
Parameters
- game: Game
- state: PlayerState
Returns void
- Defined in src/game/ui/Ui.ts:573

`Protected` onStoppingPlay

onStoppingPlay(game: Game, state: PlayerState): Promise<void>
Parameters
- game: Game
- state: PlayerState
Returns Promise<void>
- Defined in src/game/ui/Ui.ts:567

`Protected` onToggleDevMode

onToggleDevMode(): boolean
Returns boolean
- Defined in src/game/ui/Ui.ts:625

`Protected` onToggleDevTools

onToggleDevTools(): boolean
Returns boolean
- Defined in src/game/ui/Ui.ts:652

`Protected` onToggleScreen

onToggleScreen(): void
Returns void
- Defined in src/game/ui/Ui.ts:593

`Protected` onTooltipsToggle

onTooltipsToggle(): boolean
Returns boolean
- Defined in src/game/ui/Ui.ts:609

`Protected` onUnshowMoreInfo

onUnshowMoreInfo(): void
Returns void
- Defined in src/game/ui/Ui.ts:603

playSound

playSound(sound: SfxType | "sort" | "equip" | "unequip" | "activate" | "choose" | "close" | "disable" | "enable" | "input" | "inputdelete" | "invalid" | "open" | "opensmall" | "protect" | "reorder" | "select" | "stack" | "trade" | "unprotect" | "unstack"): void
Parameters
- sound: SfxType | "sort" | "equip" | "unequip" | "activate" | "choose" | "close" | "disable" | "enable" | "input" | "inputdelete" | "invalid" | "open" | "opensmall" | "protect" | "reorder" | "select" | "stack" | "trade" | "unprotect" | "unstack"
Returns void
- Defined in src/game/ui/Ui.ts:351

refreshTranslations

refreshTranslations(...elements: (undefined | HTMLElement | default<HTMLElement>)[]): void
Parameters
- Rest ...elements: (undefined | HTMLElement | default<HTMLElement>)[]
  
  The elements to refresh translations inside
Returns void
- Defined in src/game/ui/Ui.ts:159

registerDataHost

registerDataHost(id: string | number, host: any): void
Registers an object as a "data host", which allows its fields to be saved to saveData or saveDataGlobal
Parameters
- id: string | number
- host: any
Returns void
- Defined in src/game/ui/Ui.ts:212

reloadStylesheets

reloadStylesheets(): void
Returns void
- Defined in src/game/ui/Ui.ts:477

reloadTextures

reloadTextures(): void
Returns void
- Defined in src/game/ui/Ui.ts:487

removeStylesheet

removeStylesheet(path: string): void
Parameters
- path: string
Returns void
- Defined in src/game/ui/Ui.ts:460

setDialogOpacity

setDialogOpacity(opacity?: number, save?: boolean): void
Parameters
- opacity: number = ...
- save: boolean = true
  
  Whether or not to save the new scale into options. Defaults to true.
Returns void
- Defined in src/game/ui/Ui.ts:426

storeElements

storeElements(owner: default<HTMLElement>, ...components: default<HTMLElement>[]): void
Parameters
- owner: default<HTMLElement>
- Rest ...components: default<HTMLElement>[]
Returns void
- Defined in src/game/ui/Ui.ts:176

toggleDeveloperMode

toggleDeveloperMode(enabled: boolean): Ui
Parameters
- enabled: boolean
Returns Ui
- Defined in src/game/ui/Ui.ts:519

toggleFullscreen

toggleFullscreen(): void
Toggles fullscreen

Returns void
- Defined in src/game/ui/Ui.ts:383
toggleFullscreen(fullscreen?: boolean): void
Parameters
- Optional fullscreen: boolean
  
  Whether or not fullscreen is enabled
Returns void
- Defined in src/game/ui/Ui.ts:387

toggleHealthVignette

toggleHealthVignette(healthVignette: boolean): void
Toggle health vignette
Parameters
- healthVignette: boolean
Returns void
- Defined in src/game/ui/Ui.ts:373

updateAcrylicTransparency

updateAcrylicTransparency(): void
Returns void
- Defined in src/game/ui/Ui.ts:510

updateFontStyle

updateFontStyle(): void
Returns void
- Defined in src/game/ui/Ui.ts:494

updatePowerMode

updatePowerMode(): void
Returns void
- Defined in src/game/ui/Ui.ts:515

updateUIAnimations

updateUIAnimations(): void
Returns void
- Defined in src/game/ui/Ui.ts:501

updateUIOpacity

updateUIOpacity(): void
Returns void
- Defined in src/game/ui/Ui.ts:505

Generated using TypeDoc