Class Ui

Hierarchy

Host<IUiEvents>
- Ui

Index

Constructors

Properties

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

Accessors

primaryScreenId windowHeight windowWidth

Constructors

constructor

new Ui(): Ui
Returns Ui
Overrides Host.constructor
- Defined in src/game/ui/Ui.ts:99

Properties

`Readonly` event

event: IEventEmitter<Ui, IUiEvents> = ...

`Readonly` highlights

highlights: default = ...

`Readonly` hudWidth

hudWidth: 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(): DedicatedServer | Game
Screen id used while in game / playing

Returns DedicatedServer | Game
- Defined in src/game/ui/Ui.ts:459

windowHeight

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

windowWidth

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

Methods

addStylesheet

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

enableCustomTitleBar

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

getTitleBarHeight

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

getTooltipVisibility

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

`Protected` onChangeInformationVisibility

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

`Protected` onFullscreen

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

`Protected` onGlobalSlotLoaded

onGlobalSlotLoaded(): void
Returns void
- Defined in src/game/ui/Ui.ts:428

`Protected` onInterruptClosed

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

`Protected` onLanguageChange

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

`Protected` onPlay

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

`Protected` onReload

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

`Protected` onReloadStylesheets

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

`Protected` onReloadVariableUIImages

onReloadVariableUIImages(): boolean
Returns boolean
- Defined in src/game/ui/Ui.ts:553

`Protected` onShowMoreInfo

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

`Protected` onStopPlay

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

`Protected` onToggleDevMode

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

`Protected` onToggleDevTools

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

`Protected` onToggleScreen

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

`Protected` onUnshowMoreInfo

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

playSound

playSound(sound: "input" | "open" | "select" | "close" | "invalid" | SfxType | "activate" | "choose" | "disable" | "enable" | "inputdelete" | "opensmall" | "protect" | "unprotect"): void
Parameters
- sound: "input" | "open" | "select" | "close" | "invalid" | SfxType | "activate" | "choose" | "disable" | "enable" | "inputdelete" | "opensmall" | "protect" | "unprotect"
Returns void
- Defined in src/game/ui/Ui.ts:278

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:142

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:195

reloadStylesheets

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

reloadVariableUIImages

reloadVariableUIImages(): void
Returns void
- Defined in src/game/ui/Ui.ts:391

removeStylesheet

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

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:353

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:159

toggleDeveloperMode

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

toggleFullscreen

toggleFullscreen(): void
Toggles fullscreen

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

toggleHealthVignette

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

updateAcrylicTransparency

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

updateFontStyle

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

updatePowerMode

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

updateUIAnimations

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

updateUIOpacity

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

Generated using TypeDoc