Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IUi

Hierarchy

Implemented by

Index

Properties

Methods

Properties

containerSortInfo

containerSortInfo: object

Type declaration

dialogContainerInfo

dialogContainerInfo: IDialogInfo[]

dialogInfo

dialogInfo: object

Type declaration

quickSlotInfo

quickSlotInfo: IQuickSlotInfo[]

Methods

addButton

  • addButton(elementId: string, buttonName: string, imagePath: string, tooltip: string, keyBind?: number): JQuery
  • Parameters

    • elementId: string
    • buttonName: string
    • imagePath: string
    • tooltip: 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

addOptionsSection

  • addOptionsSection(elementId: string, sectionName: string): JQuery
  • Parameters

    • elementId: string
    • sectionName: string

    Returns JQuery

afterAddingMultipleItemsToContainer

  • afterAddingMultipleItemsToContainer(container: IContainer): void
  • Parameters

    Returns void

appendStyle

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

    • id: string
    • styleContent: string

    Returns void

cancelFullscreen

  • cancelFullscreen(): void
  • Returns void

clearBind

  • Parameters

    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

displayConfirmDialog

  • displayConfirmDialog(message: string, buttons: UiMessage[], callback?: function, force?: boolean): void
  • Parameters

    • message: string
    • buttons: UiMessage[]
    • Optional callback: function
    • Optional force: boolean

    Returns void

displayHint

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

    Returns void

displayInputDialog

  • displayInputDialog(message: UiMessage, buttonText: UiMessage, inputText: string, placeholder: string, callback?: function): void
  • Parameters

    • message: UiMessage
    • buttonText: UiMessage
    • inputText: string
    • placeholder: string
    • Optional callback: function
        • (input: string): void
        • Parameters

          • input: string

          Returns void

    Returns void

displayMessage

  • Parameters

    Returns void

displayMessagePack

getBind

  • Parameters

    Returns IBind

getBindDownTime

  • getBindDownTime(key: KeyBind): number | undefined
  • Parameters

    Returns number | undefined

getBody

  • getBody(): JQuery
  • Returns JQuery

getCurrentHint

  • Returns HintType

getDialogInfo

getHeight

  • getHeight(): number
  • Returns number

getInventoryItemOrder

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

getKeyBind

  • getKeyBind(key: KeyBind): number | null
  • Parameters

    Returns number | null

getMessageCount

  • getMessageCount(): number
  • Returns number

getMessageHtml

  • Parameters

    Returns string

getMouseBind

  • getMouseBind(key: KeyBind): number | null
  • Parameters

    Returns number | null

getMousePositionFromMouseEvent

  • getMousePositionFromMouseEvent(event: any): object
  • Parameters

    • event: any

    Returns object

    • x: number
    • y: number

getRebindingKeyElement

  • getRebindingKeyElement(): JQuery | null
  • Returns JQuery | null

getSerializationProperties

  • getSerializationProperties(_: string): string[]

getStringForKeyBind

  • getStringForKeyBind(key: KeyBind): string
  • Parameters

    Returns string

getWidth

  • getWidth(): number
  • Returns number

hideActionsMenu

  • hideActionsMenu(): void
  • Returns void

hideHelpScreen

  • hideHelpScreen(): void
  • Returns void

hideLoadingScreen

  • hideLoadingScreen(): void
  • Returns void

hideOptionsScreen

  • hideOptionsScreen(): void
  • Returns void

highlight

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

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

    Returns void

initialize

  • initialize(): void
  • Returns void

initializeGameState

  • initializeGameState(): void
  • Returns void

isBindDown

  • isBindDown(key: KeyBind): boolean
  • Parameters

    Returns boolean

isBindPressed

  • Parameters

    Returns boolean

isConfirmOverlayEnabled

  • isConfirmOverlayEnabled(): boolean
  • Returns boolean

isConfirmOverlayShown

  • isConfirmOverlayShown(): boolean
  • Returns boolean

isContainerOpen

  • Parameters

    Returns boolean

isHelpOverlayEnabled

  • isHelpOverlayEnabled(): boolean
  • Returns boolean

isHelpOverlayShown

  • isHelpOverlayShown(): boolean
  • Returns boolean

isInGameScreenShown

  • isInGameScreenShown(): boolean
  • Returns boolean

isInputOverlayEnabled

  • isInputOverlayEnabled(): boolean
  • Returns boolean

isInputOverlayShown

  • isInputOverlayShown(): boolean
  • Returns boolean

isLoadingScreenShown

  • isLoadingScreenShown(): boolean
  • Returns boolean

isManageModsVisible

  • isManageModsVisible(): boolean
  • Returns boolean

isMouseMovementBlockerVisible

  • isMouseMovementBlockerVisible(): boolean
  • Returns boolean

isOptionsOverlayEnabled

  • isOptionsOverlayEnabled(): boolean
  • Returns boolean

isOptionsOverlayShown

  • isOptionsOverlayShown(): boolean
  • Returns boolean

isOverlayShown

  • isOverlayShown(): boolean
  • Returns boolean

launchFullScreen

  • launchFullScreen(): void
  • Returns void

loadQuickSlots

  • loadQuickSlots(): void
  • Returns void

messageIdToText

  • messageIdToText(message: Message): string
  • Parameters

    Returns string

onGameEnd

  • onGameEnd(showBlocker: boolean): void
  • Parameters

    • showBlocker: boolean

    Returns void

onKeyDown

  • onKeyDown(event: JQueryEventObject): void
  • Parameters

    • event: JQueryEventObject

    Returns void

onKeyUp

  • onKeyUp(event: JQueryEventObject): void
  • Parameters

    • event: JQueryEventObject

    Returns void

onMouseDown

  • onMouseDown(event: JQueryEventObject): void
  • Parameters

    • event: JQueryEventObject

    Returns void

onMouseMove

  • onMouseMove(event: JQueryEventObject): void
  • Parameters

    • event: JQueryEventObject

    Returns void

onMouseScroll

  • onMouseScroll(event: JQueryEventObject): void
  • Parameters

    • event: JQueryEventObject

    Returns void

onMouseUpOrLeave

  • onMouseUpOrLeave(event: JQueryEventObject): void
  • Parameters

    • event: JQueryEventObject

    Returns void

onMove

  • onMove(): void
  • Returns void

onUpdateWindowMode

  • onUpdateWindowMode(): void
  • Returns void

onWindowResize

  • onWindowResize(): void
  • Returns void

openContainer

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

    • container: IContainer
    • Optional containerName: string | null

    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

pressHotKey

  • pressHotKey(hotKeyNumber: number): boolean
  • Parameters

    • hotKeyNumber: number

    Returns boolean

refreshAttributes

  • refreshAttributes(): void
  • Returns void

refreshModManager

  • refreshModManager(): any
  • Returns any

refreshQuickSlots

  • refreshQuickSlots(): void
  • Returns void

refreshSlots

  • refreshSlots(): void
  • Returns void

refreshStats

  • refreshStats(): void
  • Returns void

refreshWorldTooltips

  • refreshWorldTooltips(): void
  • Returns void

removeButton

  • removeButton(buttonName: string): void
  • Parameters

    • buttonName: string

    Returns void

removeHighlights

  • removeHighlights(): void
  • 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

removeOptionsSection

  • removeOptionsSection(sectionName: string): void
  • Parameters

    • sectionName: string

    Returns void

runHotKeys

  • runHotKeys(): void
  • Returns void

setBind

  • Parameters

    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

setLoadingMessage

  • setLoadingMessage(message: UiMessage): void
  • Parameters

    Returns void

setLoadingType

  • Parameters

    Returns void

setObjectUrl

  • setObjectUrl(objectUrl: string): void
  • Parameters

    • objectUrl: string

    Returns void

setOpacity

  • setOpacity(): void
  • Returns void

setQuickSlot

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

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

    Returns void

setRangeValue

  • setRangeValue(id: string, value: number): void
  • Parameters

    • id: string
    • value: number

    Returns void

setRebindingKey

  • setRebindingKey(key: KeyBind | null, element: JQuery | null): void
  • Parameters

    • key: KeyBind | null
    • element: JQuery | null

    Returns void

setVersionExtra

  • setVersionExtra(msg: string): void
  • Parameters

    • msg: string

    Returns void

setupButtons

  • setupButtons(): void
  • Returns void

setupItemBackgrounds

  • setupItemBackgrounds(): void
  • Returns void

showLoadingScreen

  • Parameters

    Returns void

showLoadingScreenAround

  • showLoadingScreenAround(func: function): void
  • showLoadingScreenAround(message: UiMessage, func: function): void
  • Parameters

    • func: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    • message: UiMessage
    • func: function
        • (): void
        • Returns void

    Returns void

showOptionsScreen

  • showOptionsScreen(): void
  • Returns void

showTitleScreen

  • showTitleScreen(): void
  • Returns void

switchToScreen

  • 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

updateCraftingDialog

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

    Returns void

updateDismantleTab

updateInventorySort

  • updateInventorySort(): void
  • Returns void

updateItem

  • updateItem(item: IItem): void
  • Parameters

    Returns void

updateKeybind

  • updateKeybind(key: KeyBind, element: JQuery): void
  • Parameters

    Returns void

updateMilestonesDialog

  • updateMilestonesDialog(): void
  • Returns void

updateMultiplayerElements

  • updateMultiplayerElements(isConnected: boolean): void
  • Parameters

    • isConnected: boolean

    Returns void

updateScrollableContainer

  • updateScrollableContainer(this: Element): void
  • Parameters

    • this: Element

    Returns void

updateScrollableContainersList

  • updateScrollableContainersList(): void
  • Returns void

updateSkillsDialog

  • updateSkillsDialog(): void
  • Returns void

updateWindowMode

  • updateWindowMode(): void
  • Returns void

Generated using TypeDoc