Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Ui

Hierarchy

  • Ui

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Ui(): Ui
  • Returns Ui

Properties

containerSortInfo

containerSortInfo: object

Type declaration

currentHint

currentHint: HintType

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
    • Default value internal: boolean = false
    • Default value isAddingMultipleItems: boolean = false

    Returns void

addOptionsSection

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

    • elementId: string
    • sectionName: string

    Returns JQuery

afterAddingMultipleItemsToContainer

  • afterAddingMultipleItemsToContainer(container: IContainer): void

appendStyle

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

    • id: string
    • styleContent: string

    Returns void

cancelFullscreen

  • cancelFullscreen(): void

clearBind

closeContainer

closeDialog

  • closeDialog(dialog: JQuery): boolean
  • Parameters

    • dialog: JQuery

    Returns boolean

closeMapDialog

  • closeMapDialog(): void

createDialog

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

displayChatMessage

  • displayChatMessage(player: IPlayer, message: string): 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

    • player: IPlayer | undefined
    • hintType: HintType
    • Default value force: boolean = false

    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

displayMessagePack

getBind

getBindDownTime

  • getBindDownTime(key: KeyBind): number | undefined

getBody

  • getBody(): JQuery
  • Returns JQuery

getCurrentHint

getDialogInfo

getHeight

  • getHeight(): number
  • Returns number

getInventoryItemOrder

  • getInventoryItemOrder(): any[]

getKeyBind

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

    Returns number | null

getKeyBindFromKeyCode

  • getKeyBindFromKeyCode(keyCode: number): KeyBind | undefined
  • Parameters

    • keyCode: number

    Returns KeyBind | undefined

getMessageCount

  • getMessageCount(): number

getMessageHtml

  • Parameters

    • messagePack: IMessagePack
    • Default value tag: string = "p"
    • Default value textCase: SentenceCaseStyle = SentenceCaseStyle.Sentence
    • Default value log: boolean = true
    • Optional addedClass: string

    Returns string

getMouseBind

  • getMouseBind(key: KeyBind): number | null

getMousePositionFromMouseEvent

  • getMousePositionFromMouseEvent(event: any): object

getRebindingKeyElement

  • getRebindingKeyElement(): JQuery

getSerializationProperties

  • getSerializationProperties(_: string): string[]

getStringForKeyBind

  • getStringForKeyBind(key: KeyBind): string

getWidth

  • getWidth(): number
  • Returns number

hideActionsMenu

  • hideActionsMenu(): void

hideHelpScreen

  • hideHelpScreen(): void

hideLoadingScreen

  • hideLoadingScreen(): void

hideOptionsScreen

  • hideOptionsScreen(): void

highlight

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

    • Default value selector: string[] | null = null
    • Default value onlyFirstElement: boolean = true
    • Default value timeout: number = 10000

    Returns void

initialize

  • initialize(): void
  • Returns void

initializeGameState

  • initializeGameState(): void

isBindDown

  • isBindDown(key: KeyBind): boolean

isBindPressed

isConfirmOverlayEnabled

  • isConfirmOverlayEnabled(): boolean

isConfirmOverlayShown

  • isConfirmOverlayShown(): boolean

isContainerOpen

isHelpOverlayEnabled

  • isHelpOverlayEnabled(): boolean

isHelpOverlayShown

  • isHelpOverlayShown(): boolean

isInGameScreenShown

  • isInGameScreenShown(): boolean

isInputOverlayEnabled

  • isInputOverlayEnabled(): boolean

isInputOverlayShown

  • isInputOverlayShown(): boolean

isLoadingScreenShown

  • isLoadingScreenShown(): boolean

isManageModsVisible

  • isManageModsVisible(): boolean

isMouseMovementBlockerVisible

  • isMouseMovementBlockerVisible(): boolean

isOptionsOverlayEnabled

  • isOptionsOverlayEnabled(): boolean

isOptionsOverlayShown

  • isOptionsOverlayShown(): boolean

isOverlayShown

  • isOverlayShown(): boolean

launchFullScreen

  • launchFullScreen(): void

loadQuickSlots

  • loadQuickSlots(): void

messageIdToText

  • messageIdToText(message: Message): 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

onWindowResize

  • onWindowResize(): void

openContainer

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

    • container: IContainer
    • Default value containerName: string | null = null

    Returns void

openDialog

  • openDialog(dialog: JQuery): boolean
  • Parameters

    • dialog: JQuery

    Returns boolean

openDialogs

  • openDialogs(): void
  • Returns void

openMapDialog

  • openMapDialog(): void

playClickSound

  • playClickSound(): void

pressHotKey

  • pressHotKey(hotKeyNumber: number): boolean
  • Parameters

    • hotKeyNumber: number

    Returns boolean

refreshAttributes

  • refreshAttributes(): void

refreshButtonTooltip

  • refreshButtonTooltip(buttonName: string, tooltip: string, keyBind: number): void
  • Parameters

    • buttonName: string
    • tooltip: string
    • keyBind: number

    Returns void

refreshModManager

  • refreshModManager(): any

refreshQuickSlots

  • refreshQuickSlots(): void

refreshSlots

  • refreshSlots(): void

refreshStats

  • refreshStats(): void

refreshWorldTooltips

  • refreshWorldTooltips(): void

removeButton

  • removeButton(buttonName: string): void
  • Parameters

    • buttonName: string

    Returns void

removeHighlights

  • removeHighlights(): void

removeItemFromContainer

removeItemFromEquipSlot

  • removeItemFromEquipSlot(equip: EquipType): void

removeItemFromQuickSlot

  • removeItemFromQuickSlot(itemId: number): void

removeOldestMessage

  • removeOldestMessage(): void

removeOptionsSection

  • removeOptionsSection(sectionName: string): void

runHotKeys

  • runHotKeys(): void
  • Returns void

setBind

setCheckboxValue

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

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

    Returns void

setCurrentHint

  • setCurrentHint(hintType: HintType): void

setEquipSlot

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

    • equip: EquipType
    • itemId: number
    • Default value internal: boolean = false

    Returns void

setFontStyle

  • setFontStyle(): void

setLoadingMessage

  • setLoadingMessage(message: UiMessage): void

setLoadingType

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
    • Default value internal: boolean = false

    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

setupItemBackgrounds

  • setupItemBackgrounds(): void

showLoadingScreen

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

showTitleScreen

  • showTitleScreen(): void

switchToScreen

toggleDialog

  • toggleDialog(dialog: JQuery): boolean
  • Parameters

    • dialog: JQuery

    Returns boolean

toggleHelp

  • toggleHelp(): void
  • Returns void

toggleOptions

  • toggleOptions(): void

toggleUIDisplay

  • toggleUIDisplay(): void

tooltipRefresh

  • tooltipRefresh(): void

updateCraftingDialog

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

updateDismantleTab

updateInventorySort

  • updateInventorySort(): void

updateItem

  • updateItem(item: IItem): void
  • Parameters

    Returns void

updateKeybind

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

    Returns void

updateMilestonesDialog

  • updateMilestonesDialog(): void

updateMultiplayerElements

  • updateMultiplayerElements(isConnected: boolean): void

updateScrollableContainer

  • updateScrollableContainer(this: Element): void

updateScrollableContainersList

  • updateScrollableContainersList(): void

updateSkillsDialog

  • updateSkillsDialog(): void

updateWindowMode

  • updateWindowMode(): void

Generated using TypeDoc