Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IUi

Hierarchy

Implemented by

Index

Properties

screenInGame

screenInGame: IUiScreen

Methods

addButton

  • addButton(translationId: string, imagePath: string, keyBind?: number): JQuery
  • Parameters

    • translationId: string
    • imagePath: string
    • Optional keyBind: number

    Returns JQuery

addItemToContainer

  • addItemToContainer(item: IItem, container: IContainer, internal?: boolean, isAddingMultipleItems?: boolean): void
  • Parameters

    • item: IItem
    • container: IContainer
    • Optional internal: boolean
    • Optional isAddingMultipleItems: boolean

    Returns void

afterAddingMultipleItemsToContainer

  • afterAddingMultipleItemsToContainer(container: IContainer): void
  • Parameters

    Returns void

appendStyle

  • appendStyle(id: string, styleContent: string): void
  • Parameters

    • id: string
    • styleContent: string

    Returns void

cancel

  • cancel(events: string | number | Array<string | number>, cb?: function): void
  • Parameters

    • events: string | number | Array<string | number>
    • Optional cb: function
        • (emitter: this, ...data: any[]): any
        • Parameters

          • emitter: this
          • Rest ...data: any[]

          Returns any

    Returns void

cancelAll

  • cancelAll(): void
  • Returns void

changeEquipmentOption

  • changeEquipmentOption(id: string): void
  • Parameters

    • id: string

    Returns void

closeAllContainers

  • closeAllContainers(): void
  • Returns void

closeContainer

  • Parameters

    Returns void

closeDialog

  • closeDialog(dialog: JQuery): boolean
  • Parameters

    • dialog: JQuery

    Returns boolean

closeMapDialog

  • closeMapDialog(): void
  • Returns void

createDialog

  • createDialog(container: JQuery, dialogInfo: IDialogInfo): JQuery
  • Parameters

    Returns JQuery

displayChatMessage

  • displayChatMessage(player: IPlayer, message: string): void
  • Parameters

    Returns void

displayHint

  • displayHint(player: IPlayer | undefined, hintType: HintType, force?: boolean): boolean
  • Parameters

    Returns boolean

displayMessage

  • Parameters

    Returns void

displayMessagePack

getBody

  • getBody(): JQuery
  • Returns JQuery

getCurrentHint

  • Returns HintType

getDialogInfo

getHeight

  • getHeight(): number
  • Returns number

getInventoryItemOrder

  • getInventoryItemOrder(): any[]
  • Returns any[]

getMessageCount

  • getMessageCount(): number
  • Returns number

getMessageHtml

  • Parameters

    Returns string

getSerializationProperties

  • getSerializationProperties(_: string): string[]

getWidth

  • getWidth(): number
  • Returns number

hideActionsMenu

  • hideActionsMenu(): void
  • Returns void

hideContextMenu

  • hideContextMenu(): void
  • Returns void

hideHelpScreen

  • hideHelpScreen(): void
  • Returns void

highlight

  • highlight(selector?: string[] | undefined, onlyFirstElement?: boolean, timeout?: number): void
  • Parameters

    • Optional selector: string[] | undefined
    • Optional onlyFirstElement: boolean
    • Optional timeout: number

    Returns void

initialize

  • initialize(): void
  • Returns void

initializeGameState

  • initializeGameState(): void
  • Returns void

isContainerOpen

  • Parameters

    Returns boolean

isContextMenuOpen

  • isContextMenuOpen(): boolean
  • Returns boolean

isHelpOverlayEnabled

  • isHelpOverlayEnabled(): boolean
  • Returns boolean

isHelpOverlayShown

  • isHelpOverlayShown(): boolean
  • Returns boolean

isInGameScreenShown

  • isInGameScreenShown(): boolean
  • Returns boolean

isOptionsOverlayEnabled

  • isOptionsOverlayEnabled(): boolean
  • Returns boolean

isOptionsOverlayShown

  • isOptionsOverlayShown(): boolean
  • Returns boolean

loadQuickSlots

  • loadQuickSlots(): void
  • Returns void

messageIdToText

  • messageIdToText(message: Message): string
  • Parameters

    Returns string

on

  • on(events: string | number | Array<string | number>, cb: function): this
  • Parameters

    • events: string | number | Array<string | number>
    • cb: function
        • (emitter: this, ...data: any[]): any
        • Parameters

          • emitter: this
          • Rest ...data: any[]

          Returns any

    Returns this

onBindLoop

onGameEnd

  • onGameEnd(showBlocker: boolean): void
  • Parameters

    • showBlocker: boolean

    Returns void

onMove

  • onMove(): void
  • Returns void

onUpdateDirection

  • onUpdateDirection(): void
  • Returns void

onWindowResize

  • onWindowResize(): void
  • Returns void

once

  • once(event: string | number, cb: function): this
  • Parameters

    • event: string | number
    • cb: function
        • (emitter: this, ...data: any[]): any
        • Parameters

          • emitter: this
          • Rest ...data: any[]

          Returns any

    Returns this

openBookDialog

  • openBookDialog(title: string, content: string): void
  • Parameters

    • title: string
    • content: string

    Returns void

openContainer

  • openContainer(container: IContainer, containerName?: string): void
  • Parameters

    • container: IContainer
    • Optional containerName: string

    Returns void

openDialog

  • openDialog(dialog: JQuery): boolean
  • Parameters

    • dialog: JQuery

    Returns boolean

openDialogs

  • openDialogs(): void
  • Returns void

openMapDialog

  • openMapDialog(): void
  • Returns void

playClickSound

  • playClickSound(): void
  • Returns void

refreshAttributes

  • refreshAttributes(): void
  • Returns void

refreshQuickSlots

  • refreshQuickSlots(): void
  • Returns void

refreshStats

  • refreshStats(): void
  • Returns void

refreshWorldTooltips

  • refreshWorldTooltips(): void
  • Returns void

removeButton

  • removeButton(button: JQuery): void
  • Parameters

    • button: JQuery

    Returns void

removeItemFromContainer

  • Parameters

    Returns void

removeItemFromEquipSlot

  • removeItemFromEquipSlot(equip: EquipType): void
  • Parameters

    Returns void

removeItemFromQuickSlot

  • removeItemFromQuickSlot(itemId: number): void
  • Parameters

    • itemId: number

    Returns void

removeOldestMessage

  • removeOldestMessage(): void
  • Returns void

removeStyle

  • removeStyle(id: string): void
  • Parameters

    • id: string

    Returns void

resetHelpHeight

  • resetHelpHeight(): void
  • Returns void

setCheckboxValue

  • setCheckboxValue(element: JQuery, id: string, checked: boolean): void
  • Parameters

    • element: JQuery
    • id: string
    • checked: boolean

    Returns void

setCurrentHint

  • setCurrentHint(hintType: HintType): void
  • Parameters

    Returns void

setEquipSlot

  • setEquipSlot(equip: EquipType, itemId: number, internal?: boolean): void
  • Parameters

    • equip: EquipType
    • itemId: number
    • Optional internal: boolean

    Returns void

setFontStyle

  • setFontStyle(): void
  • Returns void

setObjectUrl

  • setObjectUrl(objectUrl: string): void
  • Parameters

    • objectUrl: string

    Returns void

setQuickSlot

  • setQuickSlot(quickSlot: number, itemId: number, internal?: boolean): void
  • Parameters

    • quickSlot: number
    • itemId: number
    • Optional internal: boolean

    Returns void

setVersionExtra

  • setVersionExtra(msg: string): void
  • Parameters

    • msg: string

    Returns void

setupButtons

  • setupButtons(): void
  • Returns void

setupItemBackgrounds

  • setupItemBackgrounds(): void
  • Returns void

shakeStat

  • Parameters

    Returns void

shouldRefreshMods

  • shouldRefreshMods(): boolean
  • Returns boolean

showOptionsScreen

  • showOptionsScreen(): Promise<void>
  • Returns Promise<void>

switchToScreen

  • switchToScreen(screenId: ScreenId, menuId?: MenuId, ...args: any[]): void
  • Parameters

    Returns void

toggleDialog

  • toggleDialog(dialog: JQuery): boolean
  • Parameters

    • dialog: JQuery

    Returns boolean

toggleHelp

  • toggleHelp(): void
  • Returns void

toggleOptions

  • toggleOptions(): void
  • Returns void

toggleUIDisplay

  • toggleUIDisplay(): void
  • Returns void

tooltipRefresh

  • tooltipRefresh(): void
  • Returns void

trigger

  • trigger(event: string | number, ...data: any[]): Promise<any[]>
  • Parameters

    • event: string | number
    • Rest ...data: any[]

    Returns Promise<any[]>

updateCraftingDialog

  • updateCraftingDialog(craftableItemTypes: ItemType[], nonCraftableItemTypes: ItemType[]): void
  • Parameters

    Returns void

updateDismantleTab

updateInventorySort

  • updateInventorySort(): void
  • Returns void

updateItem

  • updateItem(item: IItem): void
  • Parameters

    Returns void

updateMilestonesDialog

  • updateMilestonesDialog(): void
  • Returns void

updateScrollableContainer

  • updateScrollableContainer(this: Element): void
  • Parameters

    • this: Element

    Returns void

updateScrollableContainersList

  • updateScrollableContainersList(): void
  • Returns void

updateSkillsDialog

  • updateSkillsDialog(): void
  • Returns void

waitUntil

  • waitUntil(event: string | number): Promise<Object>
  • Parameters

    • event: string | number

    Returns Promise<Object>

Generated using TypeDoc