Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InGameScreen

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

element

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

elementActions

elementActions: JQuery

elementAttributeAttack

elementAttributeAttack: JQuery

elementAttributeDefense

elementAttributeDefense: JQuery

elementAttributeReputation

elementAttributeReputation: JQuery

elementAttributeWeight

elementAttributeWeight: JQuery

elementBlocker

elementBlocker: JQuery

elementBlockerMouse

elementBlockerMouse: JQuery

elementButtons

elementButtons: JQuery

elementContainerDialogs

elementContainerDialogs: JQuery[] = []

elementContainers

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

elementDialogMap

elementDialogMap: JQuery

elementDialogMessages

elementDialogMessages: JQuery

elementDialogMessagesChatInput

elementDialogMessagesChatInput: JQuery

elementDialogMessagesContainer

elementDialogMessagesContainer: JQuery

elementDialogMilestones

elementDialogMilestones: JQuery

elementDialogMilestonesContainer

elementDialogMilestonesContainer: JQuery

elementDialogSkills

elementDialogSkills: JQuery

elementDialogSkillsContainer

elementDialogSkillsContainer: JQuery

elementDialogs

elementDialogs: JQuery

elementMessagesChatInput

elementMessagesChatInput: JQuery

elementMessagesOverlay

elementMessagesOverlay: JQuery

elementOtherDialogs

elementOtherDialogs: JQuery[] = []

elementQuickSlotsContainer

elementQuickSlotsContainer: JQuery

elementReputationBenignity

elementReputationBenignity: JQuery

elementReputationMalignity

elementReputationMalignity: JQuery

elementStatBleed

elementStatBleed: JQuery

elementStatBurn

elementStatBurn: JQuery

elementStatHealth

elementStatHealth: JQuery

elementStatHunger

elementStatHunger: JQuery

elementStatPoison

elementStatPoison: JQuery

elementStatStamina

elementStatStamina: JQuery

elementStatThirst

elementStatThirst: JQuery

elementStats

elementStats: JQuery

elementVersion

elementVersion: JQuery

elementVisibleInGame

elementVisibleInGame: JQuery

visible

visible: boolean = false

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

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

    • element: JQuery

    Returns void

blurInputs

  • blurInputs(): void
  • Returns void

canUseHotkeys

  • canUseHotkeys(): boolean
  • Returns boolean

cancelSorting

  • cancelSorting(): void
  • Returns void

changeEquipmentOption

  • changeEquipmentOption(element: JQuery, id: string): void
  • Parameters

    • element: JQuery
    • id: string

    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(): boolean
  • Returns boolean

closeAllDialogs

  • closeAllDialogs(): boolean
  • Returns boolean

closeContainer

  • Parameters

    Returns void

closeContainerDialog

  • closeContainerDialog(containerDialog?: JQuery): void
  • Parameters

    • Optional containerDialog: JQuery

    Returns void

closeDialog

  • closeDialog(dialog: JQuery): boolean
  • Parameters

    • dialog: JQuery

    Returns boolean

closeMapDialog

  • closeMapDialog(): void
  • Returns void

closeStaticContainers

  • closeStaticContainers(): void
  • Returns void

completeBlockerMouseMovement

  • completeBlockerMouseMovement(): void
  • Returns void

createCraftItemElements

  • createCraftItemElements(sortType: SortType): void
  • Parameters

    Returns void

createDialog

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

    Returns JQuery

createItemElementByItem

  • createItemElementByItem(item: IItem): JQuery | undefined
  • Parameters

    Returns JQuery | undefined

createItemElementByItemType

  • createItemElementByItemType(itemType: ItemType, item?: IItem): JQuery
  • Parameters

    Returns JQuery

displayChatMessage

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

    Returns void

displayMessagePack

  • Parameters

    Returns void

doHide

  • doHide(): void
  • Returns void

doShow

  • doShow(): void
  • Returns void

generateDismantleItems

  • generateDismantleItems(): void
  • Returns void

getDialogElementForContainer

  • getDialogElementForContainer(container: IContainer): JQuery | undefined
  • Parameters

    Returns JQuery | undefined

getDialogIndex

  • Parameters

    Returns string

getEquipSlotItemElement

  • getEquipSlotItemElement(equip: EquipType): JQuery
  • Parameters

    Returns JQuery

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

getMessageCount

  • getMessageCount(): number
  • Returns number

getMovementDirection

  • Parameters

    • event: any

    Returns FacingDirection

getQuickSlotItemElement

  • getQuickSlotItemElement(quickSlot: number): JQuery
  • Parameters

    • quickSlot: number

    Returns JQuery

getTooltipHtml

  • getTooltipHtml(element: JQuery): string
  • Parameters

    • element: JQuery

    Returns string

getTooltipHtmlForItem

  • getTooltipHtmlForItem(item: IItem, itemType: ItemType, isQuickSlot: boolean): string
  • Parameters

    Returns string

getTooltipHtmlForTile

  • getTooltipHtmlForTile(tile: ITile): 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

insertItemElementToContainer

  • insertItemElementToContainer(itemElement: JQuery, containerElement: JQuery): void
  • Parameters

    • itemElement: JQuery
    • containerElement: JQuery

    Returns void

isContainerDialogOver

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

    • x: number
    • y: number

    Returns boolean

isContainerOpen

  • Parameters

    Returns boolean

isMouseMovementBlockerVisible

  • isMouseMovementBlockerVisible(): boolean
  • Returns boolean

isSorting

  • isSorting(): boolean
  • Returns boolean

isVisible

  • isVisible(): boolean

loadQuickSlots

  • loadQuickSlots(): void
  • Returns void

onAddItemsToContainer

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

    • containerElement: JQuery
    • containerDialogElement: JQuery | undefined
    • isInventoryContainer: boolean

    Returns void

onBlockerMouseMove

  • onBlockerMouseMove(event: JQueryEventObject): void
  • Parameters

    • event: JQueryEventObject

    Returns void

onButtonBarClick

  • onButtonBarClick(button: string): void
  • Parameters

    • button: string

    Returns void

onChatEnter

  • onChatEnter(chatElement: JQuery): void
  • Parameters

    • chatElement: JQuery

    Returns void

onClearMessages

  • onClearMessages(): void
  • Returns void

onContainerItemRightClick

  • onContainerItemRightClick(element: JQuery, bypassAll?: boolean): void
  • Parameters

    • element: JQuery
    • Optional bypassAll: boolean

    Returns void

onContextMenuAction

  • onContextMenuAction(element: JQuery, action: IContextMenuAction, toElement?: JQuery): boolean
  • Parameters

    Returns boolean

onCraftingItemClick

  • onCraftingItemClick(element: JQuery): void
  • Parameters

    • element: JQuery

    Returns void

onDismantleHover

  • onDismantleHover(element: JQuery, hover: boolean): void
  • Parameters

    • element: JQuery
    • hover: boolean

    Returns void

onDismantleItemClick

  • onDismantleItemClick(element: JQuery): void
  • Parameters

    • element: JQuery

    Returns void

onEquipmentItemRightClick

  • onEquipmentItemRightClick(element: JQuery): void
  • Parameters

    • element: JQuery

    Returns void

onFilterInput

  • onFilterInput(containerElement: JQuery): void
  • Parameters

    • containerElement: JQuery

    Returns void

onGameEnd

  • onGameEnd(showBlocker: boolean): void

onHide

  • onHide(): void
  • Returns void

onInventoryItemRightClick

  • onInventoryItemRightClick(element: JQuery, bypassAll?: boolean): void
  • Parameters

    • element: JQuery
    • Optional bypassAll: boolean

    Returns void

onKeyDown

  • onKeyDown(_: JQueryEventObject, keyCode: number, blockable: boolean): boolean | undefined
  • Parameters

    • _: JQueryEventObject
    • keyCode: number
    • blockable: boolean

    Returns boolean | undefined

onKeyUp

  • onKeyUp(event: JQueryEventObject): boolean | undefined
  • Parameters

    • event: JQueryEventObject

    Returns boolean | undefined

onMouseDown

  • onMouseDown(event: JQueryEventObject): void

onMouseMove

  • onMouseMove(event: JQueryEventObject): void

onMouseScroll

  • onMouseScroll(event: JQueryEventObject): void

onMouseUpOrLeave

  • onMouseUpOrLeave(event: JQueryEventObject): void

onMove

  • onMove(): void
  • Returns void

onOtherClick

  • onOtherClick(event: JQueryEventObject): void
  • Parameters

    • event: JQueryEventObject

    Returns void

onQuickSlotItemRightClick

  • onQuickSlotItemRightClick(element: JQuery): void
  • Parameters

    • element: JQuery

    Returns void

onShow

  • onShow(): void
  • Returns void

onSortableItemReceive

  • Parameters

    Returns void

onTooltipClose

  • onTooltipClose(): void
  • Returns void

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

pressHotKey

  • pressHotKey(hotKeyNumber: number): boolean
  • Parameters

    • hotKeyNumber: number

    Returns boolean

refreshAttributes

  • refreshAttributes(): void
  • Returns void

refreshButtonTooltip

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

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

    Returns void

refreshQuickSlots

  • refreshQuickSlots(): void
  • Returns void

refreshStats

  • refreshStats(): void
  • Returns void

refreshWorldTooltips

  • refreshWorldTooltips(): void
  • Returns void

removeButton

  • removeButton(buttonName: string): void
  • Parameters

    • buttonName: string

    Returns void

removeItemFromContainer

  • Parameters

    Returns void

removeItemFromEquipSlot

  • removeItemFromEquipSlot(equip: EquipType): void
  • Parameters

    Returns void

removeItemFromQuickSlot

  • removeItemFromQuickSlot(itemId?: number, skipSync?: boolean): void
  • Parameters

    • Optional itemId: number
    • Optional skipSync: boolean

    Returns void

removeOldestMessage

  • removeOldestMessage(): void
  • Returns void

runBind

  • runBind(bind: IBind): boolean | undefined
  • Parameters

    Returns boolean | undefined

runContextMenuAction

  • runContextMenuAction(itemId: number, containerId: number | undefined, action: IContextMenuAction): boolean
  • Parameters

    Returns boolean

runSortableAction

  • runSortableAction(action: string): void
  • Parameters

    • action: string

    Returns void

saveItemOrder

  • saveItemOrder(containerElement: JQuery): void
  • Parameters

    • containerElement: JQuery

    Returns void

selector

  • selector(): string

setEquipSlot

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

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

    Returns void

setQuickSlot

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

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

    Returns boolean

setQuickSlotByItemType

  • setQuickSlotByItemType(quickSlot: number, itemType: ItemType, disabled: boolean): JQuery
  • Parameters

    • quickSlot: number
    • itemType: ItemType
    • disabled: boolean

    Returns JQuery

setupContextMenu

  • setupContextMenu(): any
  • Returns any

setupDialog

  • setupDialog(dialogId: DialogId, highlightItemId?: number, customDialogInfo?: IDialogInfo): DialogOptions
  • Parameters

    Returns DialogOptions

shakeStat

  • Parameters

    Returns void

show

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

    • Optional data: any

    Returns void

showActionsMenu

  • showActionsMenu(center?: boolean, updatePosition?: boolean): void
  • Parameters

    • Default value center: boolean = false
    • Default value updatePosition: boolean = true

    Returns void

showItemContextMenu

  • showItemContextMenu(element: JQuery, isContainer?: boolean): void
  • Parameters

    • element: JQuery
    • Default value isContainer: boolean = false

    Returns void

showSortContextMenu

  • showSortContextMenu(element: JQuery, container: JQuery, messageType: Message): void
  • Parameters

    • element: JQuery
    • container: JQuery
    • messageType: Message

    Returns void

sortItemElements

  • 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: IItem, element: JQuery): void
  • Parameters

    • item: IItem
    • element: JQuery

    Returns void

syncItemElements

  • syncItemElements(itemId: number, selector?: JQuery): void
  • Parameters

    • itemId: number
    • Optional selector: JQuery

    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

    • dialog: JQuery

    Returns boolean

tooltipDisable

  • tooltipDisable(): void
  • Returns void

tooltipEnable

  • tooltipEnable(): void
  • Returns void

tooltipHide

  • tooltipHide(): void
  • Returns void

tooltipRefresh

  • tooltipRefresh(): 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: IItem): void
  • Parameters

    Returns void

updateMilestonesDialog

  • updateMilestonesDialog(): void
  • Returns void

updateMultiplayerElements

  • updateMultiplayerElements(isConnected: boolean): void
  • Parameters

    • isConnected: boolean

    Returns void

updateQuickSlotItem

  • updateQuickSlotItem(quickSlot: number): boolean
  • Parameters

    • quickSlot: number

    Returns boolean

updateSkillsDialog

  • updateSkillsDialog(): void
  • Returns void

updateSort

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

    • container: JQuery
    • activeSort: boolean

    Returns void

updateTextIfChanged

  • updateTextIfChanged(id: TextElementId, element: JQuery, text: string): void
  • Parameters

    Returns void

useQuickSlot

  • useQuickSlot(slot: number): boolean
  • Parameters

    • slot: number

    Returns boolean

Generated using TypeDoc