Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InGameScreen

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

contextMenuOpen

contextMenuOpen: boolean = false

element

element: JQuery = $(this.selector())

elementActions

elementActions: JQuery

elementCanvas

elementCanvas: JQuery

elementContainerDialogs

elementContainerDialogs: JQuery[] = []

elementDialogCrafting

elementDialogCrafting: JQuery

elementDialogCraftingButton

elementDialogCraftingButton: JQuery

elementDialogCraftingContainer

elementDialogCraftingContainer: JQuery

elementDialogDismantleButton

elementDialogDismantleButton: JQuery

elementDialogDismantleContainer

elementDialogDismantleContainer: JQuery

elementDialogEquipment

elementDialogEquipment: JQuery

elementDialogEquipmentContainer

elementDialogEquipmentContainer: JQuery

elementDialogInventory

elementDialogInventory: JQuery

elementDialogInventoryContainer

elementDialogInventoryContainer: JQuery

elementDialogs

elementDialogs: JQuery

elementOtherDialogs

elementOtherDialogs: JQuery[] = []

elementQuickSlotsContainer

elementQuickSlotsContainer: JQuery

elementVersion

elementVersion: JQuery

elementVisibleInGame

elementVisibleInGame: JQuery

isQuickmoving

isQuickmoving: boolean = false

overlayBindCatcherId

overlayBindCatcherId: number

shouldCancelSorting

shouldCancelSorting: boolean = false

shouldResetMovement

shouldResetMovement: boolean = false

visible

visible: boolean = false

Methods

addItemToContainer

  • addItemToContainer(item: Item, container: IContainer, _internal?: boolean, isAddingMultipleItems?: boolean, updateTables?: boolean): void
  • Parameters

    • item: Item
    • container: IContainer
    • Default value _internal: boolean = false
    • Default value isAddingMultipleItems: boolean = false
    • Default value updateTables: boolean = true

    Returns void

addItemToFreeQuickSlot

  • addItemToFreeQuickSlot(itemId: number): void
  • Parameters

    • itemId: number

    Returns void

afterAddingMultipleItemsToContainer

  • afterAddingMultipleItemsToContainer(container: IContainer): void
  • Parameters

    Returns void

autoOpenDialog

  • autoOpenDialog(index: string | number, element: JQuery): boolean
  • Parameters

    • index: string | number
    • element: JQuery

    Returns boolean

bindElements

  • bindElements(): void

bindSortable

  • bindSortable(element: JQuery): void
  • Parameters

    Returns void

blurInputs

  • blurInputs(): void
  • Returns void

cancelSorting

  • cancelSorting(): void
  • Returns void

changeEquipmentOption

  • changeEquipmentOption(id: "leftHand" | "rightHand"): void
  • Parameters

    • id: "leftHand" | "rightHand"

    Returns void

clampDialogs

  • clampDialogs(): void
  • Returns void

clearQuickSlot

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

    • quickSlot: number
    • Default value internal: boolean = false

    Returns void

closeAllContainers

  • closeAllContainers(closeType?: "close" | "destroy"): boolean
  • Parameters

    • Default value closeType: "close" | "destroy" = "close"

    Returns boolean

closeAllDialogs

  • closeAllDialogs(): boolean
  • Returns boolean

closeContainer

  • Parameters

    Returns void

closeContainerDialog

  • closeContainerDialog(containerDialog?: JQuery, closeType?: "close" | "destroy"): void
  • Parameters

    • Optional containerDialog: JQuery
    • Default value closeType: "close" | "destroy" = "close"

    Returns void

closeDialog

  • closeDialog(dialog: JQuery): boolean
  • Parameters

    Returns boolean

closeStaticContainers

  • closeStaticContainers(): void
  • Returns void

craftItem

craftItemChecker

  • craftItemChecker(itemType: ItemType): void
  • Parameters

    Returns void

createCraftItemElements

  • Parameters

    Returns void

createItemString

  • createItemString(itemType: ItemType, item?: Item, extraClass?: string): string
  • Parameters

    • itemType: ItemType
    • Optional item: Item
    • Default value extraClass: string = ""

    Returns string

doHide

  • doHide(): void
  • Returns void

doShow

  • doShow(): void
  • Returns void

filterContainers

  • filterContainers(): void
  • Update the filtered items for each container, to be called when tables are updated. This does not update dismantle or crafting tabs.

    Returns void

focus

  • focus(): void
  • Returns void

getContainerId

  • getContainerId(containerElement: JQuery): string
  • Parameters

    Returns string

getDialogContainerElementForFilter

  • Gets the dialog container element for an inventory or item/doodad container.

    Parameters

    Returns JQuery | undefined

getDialogElementFromContainer

  • Gets the dialog element for an item/doodad container (bags, backpacks, chests, etc.) and not inventories dialogs.

    Parameters

    Returns JQuery | undefined

getDialogIndex

  • getDialogIndex(dialogId: DialogId, customDialogInfo?: IDialogInfo): string
  • Parameters

    • dialogId: DialogId
    • Optional customDialogInfo: IDialogInfo

    Returns string

getEquipSlotItemElement

  • Parameters

    Returns JQuery

getFilterElement

  • Parameters

    Returns JQuery

getFilterText

  • getFilterText(containerElement: JQuery | undefined): any
  • Parameters

    • containerElement: JQuery | undefined

    Returns any

getFreeQuickSlots

  • getFreeQuickSlots(): number[]
  • Returns number[]

getInventoryItemsInOrder

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

getItemClass

  • Parameters

    Returns string

getItemIdInEquipSlot

  • getItemIdInEquipSlot(equip: EquipType): number | undefined
  • Parameters

    Returns number | undefined

getItemIdInQuickSlot

  • getItemIdInQuickSlot(quickSlot: number): number | undefined
  • Parameters

    • quickSlot: number

    Returns number | undefined

getMovementDirection

  • getMovementDirection(mouseX: number, mouseY: number): Direction
  • Parameters

    • mouseX: number
    • mouseY: number

    Returns Direction

getQuickSlotItemElement

  • getQuickSlotItemElement(quickSlot: number): JQuery
  • Parameters

    • quickSlot: number

    Returns JQuery

getTooltipHtml

  • getTooltipHtml(element: JQuery): string
  • Parameters

    Returns string

getUsedQuickSlots

  • getUsedQuickSlots(): number[]
  • Returns number[]

hide

  • hide(): void

hideActionsMenu

  • hideActionsMenu(): void
  • Returns void

hideContextMenu

  • hideContextMenu(): boolean
  • Returns boolean

highlightItemElementByItemId

  • highlightItemElementByItemId(itemId: number, highlight: boolean, force?: boolean, skipCount?: boolean): void
  • Parameters

    • itemId: number
    • highlight: boolean
    • Default value force: boolean = false
    • Default value skipCount: boolean = false

    Returns void

highlightItemElementByItemType

  • highlightItemElementByItemType(itemType: ItemType, highlight: boolean, force?: boolean, skipCount?: boolean): void
  • Parameters

    • itemType: ItemType
    • highlight: boolean
    • Default value force: boolean = false
    • Default value skipCount: boolean = false

    Returns void

highlightItemElementByItemTypeWithNoItemId

  • highlightItemElementByItemTypeWithNoItemId(itemType: ItemType, highlight: boolean, force?: boolean, skipCount?: boolean): void
  • Parameters

    • itemType: ItemType
    • highlight: boolean
    • Default value force: boolean = false
    • Default value skipCount: boolean = false

    Returns void

highlightItemElementBySelector

  • highlightItemElementBySelector(selector: string, highlight: boolean, force?: boolean, skipCount?: boolean): void
  • Parameters

    • selector: string
    • highlight: boolean
    • Default value force: boolean = false
    • Default value skipCount: boolean = false

    Returns void

initializeGameState

  • initializeGameState(): void
  • Returns void

insertItemStringToContainer

  • insertItemStringToContainer(itemElement: string | JQuery, containerElement: JQuery): void
  • Parameters

    Returns void

isContainerDialogOver

  • isContainerDialogOver(x: number, y: number): boolean
  • Parameters

    • x: number
    • y: number

    Returns boolean

isContainerOpen

  • Parameters

    Returns boolean

isSorting

  • isSorting(): boolean
  • Returns boolean

isVisible

  • isVisible(): boolean

loadQuickSlots

  • loadQuickSlots(): void
  • Returns void

makeTopDialog

  • makeTopDialog(dialog: JQuery): void
  • Parameters

    Returns void

onAddItemsToContainer

  • onAddItemsToContainer(containerElement: JQuery, containerDialogElement: JQuery | undefined, isInventoryContainer: boolean, updateTables?: boolean): void
  • Parameters

    • containerElement: JQuery
    • containerDialogElement: JQuery | undefined
    • isInventoryContainer: boolean
    • Default value updateTables: boolean = true

    Returns void

onCloseAllDialogs

  • onCloseAllDialogs(): boolean
  • Returns boolean

onContextMenu

  • Parameters

    Returns boolean

onContextMenuAction

onContextMenuReleased

  • Parameters

    Returns void

onDismantleItemClick

  • onDismantleItemClick(dismantleItem: Item | undefined): void
  • Parameters

    • dismantleItem: Item | undefined

    Returns void

onDismantleTab

  • onDismantleTab(): boolean
  • Returns boolean

onDropItem

  • Parameters

    Returns boolean

onFilterInput

  • onFilterInput(containerElement: JQuery, updateOnBlank?: undefined | false | true): void
  • Filtering for containers, inventory, crafting, etc.

    Parameters

    • containerElement: JQuery

      The jQuery element matching the container to filter.

    • Optional updateOnBlank: undefined | false | true

      True if items should be filtered when filter text is blank (useful for updates versus user input).

    Returns void

onGameEnd

  • onGameEnd(): void
  • Returns void

onGlobalMouseMove

  • Parameters

    Returns void

onGlobalMouseUpdateTarget

  • onGlobalMouseUpdateTarget(mouse: GlobalMouseInfo, target?: HTMLElement): void
  • Parameters

    Returns void

onHandToggle

  • Parameters

    Returns boolean

onHide

  • onHide(): void
  • Returns void

onInput

  • Parameters

    Returns void

onItemEquipToggle

  • Parameters

    Returns boolean

onItemMenu

  • Parameters

    Returns boolean

onItemMove

  • Parameters

    Returns boolean

onItemProtectToggle

  • Parameters

    Returns boolean

onItemQuickMove

  • Parameters

    Returns boolean

onKeyDown

  • onKeyDown(_event: JQueryEventObject, _keyCode: number, _blockable: boolean): boolean | undefined
  • Parameters

    Returns boolean | undefined

onKeyUp

  • onKeyUp(_event: JQueryEventObject, _keyCode: number, _blockable: boolean): boolean | undefined
  • Parameters

    Returns boolean | undefined

onMenuCancel

  • onMenuCancel(): boolean
  • Returns boolean

onMoreInformation

  • Parameters

    Returns boolean

onMouseDown

onMouseMove

onMouseScroll

onMouseUpOrLeave

onMove

  • onMove(): void
  • Returns void

onOpenDialog

  • onOpenDialog(dialog: JQuery): void
  • Parameters

    Returns void

onQuickSlot

  • Parameters

    Returns boolean

onQuickSlotClear

  • Parameters

    Returns boolean

onQuickSlotToggle

  • Parameters

    Returns boolean

onReleaseDrop

  • onReleaseDrop(): void
  • Returns void

onShow

  • onShow(): void
  • Returns void

onSortableItemReceive

  • Parameters

    Returns void

onStopItemMove

  • Parameters

    Returns void

onStopItemQuickMove

  • onStopItemQuickMove(): boolean
  • Returns boolean

onUpdateContainer

  • onUpdateContainer(containerElement: JQuery, activeSort: boolean): void
  • Parameters

    • containerElement: JQuery
    • activeSort: boolean

    Returns void

onUpdateDirection

  • onUpdateDirection(): void
  • Returns void

onUpdateQuickSlotsOrEquips

  • onUpdateQuickSlotsOrEquips(): void
  • Returns void

openContainer

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

    • container: IContainer
    • Optional containerName: undefined | string

    Returns void

openDialog

  • openDialog(dialog: JQuery): boolean
  • Parameters

    Returns boolean

openDialogs

  • openDialogs(): void
  • Returns void

pressHotKey

  • pressHotKey(hotKeyNumber: number): boolean
  • Parameters

    • hotKeyNumber: number

    Returns boolean

refreshContainerName

  • refreshContainerName(container: IContainer): void
  • Parameters

    Returns void

refreshQuickSlots

  • refreshQuickSlots(): void
  • Returns void

removeItemFromContainer

  • Parameters

    Returns void

removeItemFromEquipSlot

  • removeItemFromEquipSlot(equip: EquipType): void
  • Parameters

    Returns void

removeItemFromQuickSlot

  • removeItemFromQuickSlot(itemId?: undefined | number, skipSync?: undefined | false | true): void
  • Parameters

    • Optional itemId: undefined | number
    • Optional skipSync: undefined | false | true

    Returns void

runContextMenuAction

  • runContextMenuAction(itemId: number, action: IContextMenuAction, skipSound?: undefined | false | true, usedFromQuickSlot?: undefined | false | true): boolean
  • Parameters

    • itemId: number
    • action: IContextMenuAction
    • Optional skipSound: undefined | false | true
    • Optional usedFromQuickSlot: undefined | false | true

    Returns boolean

runGlobalSortableAction

  • runGlobalSortableAction(action: string, ...data: any[]): void
  • Parameters

    • action: string
    • Rest ...data: any[]

    Returns void

runSortableAction

  • runSortableAction(sortable: JQuery, action: string, ...data: any[]): void
  • Parameters

    • sortable: JQuery
    • action: string
    • Rest ...data: any[]

    Returns void

saveItemOrder

  • saveItemOrder(containerElement: JQuery): void
  • Parameters

    Returns void

selector

  • selector(): string

setEquipSlot

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

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

    Returns void

setItemQuickslot

  • setItemQuickslot(item: Item, quickSlot: number | undefined): void
  • Parameters

    • item: Item
    • quickSlot: number | undefined

    Returns void

setQuickSlot

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

    • quickSlot: number
    • Optional itemId: undefined | number
    • Default value internal: boolean = false

    Returns boolean

setQuickSlotByItemType

  • setQuickSlotByItemType(quickSlot: number, itemType: ItemType, disabled: boolean, item?: Item | undefined): void
  • Parameters

    • quickSlot: number
    • itemType: ItemType
    • disabled: boolean
    • Optional item: Item | undefined

    Returns void

setupContextMenu

  • setupContextMenu(): any
  • Returns any

setupDialog

  • Parameters

    • dialogId: DialogId
    • Optional highlightItemId: undefined | number
    • Optional customDialogInfo: IDialogInfo

    Returns DialogOptions

show

  • show(data?: any): void
  • Parameters

    • Optional data: any

    Returns void

showActionsMenu

  • showActionsMenu(center?: boolean, updatePosition?: boolean, skipSound?: undefined | false | true): void
  • Parameters

    • Default value center: boolean = false
    • Default value updatePosition: boolean = true
    • Optional skipSound: undefined | false | true

    Returns void

showItemContextMenu

  • showItemContextMenu(element: JQuery, skipSound?: undefined | false | true): void
  • Parameters

    • element: JQuery
    • Optional skipSound: undefined | false | true

    Returns void

showSortContextMenu

  • Parameters

    Returns void

sortItems

  • sortItems(containerElement: JQuery, sortType: SortType, messageType?: Message, canReverse?: boolean): void
  • Parameters

    • containerElement: JQuery
    • sortType: SortType
    • Optional messageType: Message
    • Default value canReverse: boolean = true

    Returns void

syncDamagedDecayed

  • syncDamagedDecayed(item: Item, element: JQuery): void
  • Parameters

    Returns void

syncDecayBar

  • syncDecayBar(item: Item, syncDamage?: undefined | false | true, force?: boolean): void
  • Parameters

    • item: Item
    • Optional syncDamage: undefined | false | true
    • Default value force: boolean = false

    Returns void

syncItemElements

  • syncItemElements(itemId?: undefined | number, selector?: JQuery, forceSyncDecay?: boolean): void
  • Parameters

    • Optional itemId: undefined | number
    • Optional selector: JQuery
    • Default value forceSyncDecay: boolean = false

    Returns void

toggleActionsMenu

  • toggleActionsMenu(center?: boolean): void
  • Parameters

    • Default value center: boolean = false

    Returns void

toggleCraftingTab

  • toggleCraftingTab(which: "crafting" | "dismantle", canClose?: boolean): void
  • Parameters

    • which: "crafting" | "dismantle"
    • Default value canClose: boolean = true

    Returns void

toggleCraftingTabElements

  • toggleCraftingTabElements(which: "crafting" | "dismantle"): void
  • Parameters

    • which: "crafting" | "dismantle"

    Returns void

toggleDialog

  • toggleDialog(dialog: JQuery): boolean
  • Parameters

    Returns boolean

tooltipDisable

  • tooltipDisable(): void
  • Returns void

tooltipEnable

  • tooltipEnable(): void
  • Returns void

tooltipHide

  • tooltipHide(): void
  • Returns void

tooltipRefresh

  • tooltipRefresh(): void
  • Returns void

unSelectElements

  • unSelectElements(): void
  • Returns void

unbindElements

  • unbindElements(): void

updateActiveContainer

  • updateActiveContainer(): void
  • Returns void

updateContainerName

  • updateContainerName(containerDialogElement: JQuery): void
  • Parameters

    • containerDialogElement: JQuery

    Returns void

updateCraftingDialog

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

    Returns void

updateDismantleTab

  • Parameters

    Returns void

updateInventorySort

  • updateInventorySort(): void
  • Returns void

updateItem

  • updateItem(item: Item, updateChildren?: undefined | false | true): void
  • Parameters

    • item: Item
    • Optional updateChildren: undefined | false | true

    Returns void

updateQuickSlotItem

  • updateQuickSlotItem(quickSlot: number): boolean
  • Parameters

    • quickSlot: number

    Returns boolean

updateSort

  • updateSort(containerElement: JQuery, activeSort: boolean): void
  • Parameters

    • containerElement: JQuery
    • activeSort: boolean

    Returns void

useQuickSlot

  • useQuickSlot(slot: number): boolean
  • Parameters

    • slot: number

    Returns boolean

Generated using TypeDoc