Class default

Hierarchy

Constructors

constructor

Properties

actionBar attributes classes data dialogs entered event hasHiddenClass? interactionManager isOverlayScreen lastTooltipSource? log menuBar menus messages observing? quadrantComponentHeldQuadrants quadrantComponentQuadrants removed? rooted stats style type visibleDialogs worldTooltipHandler map

Accessors

childCount dataset element isObscured isTwoColumn selectable

Methods

addEventListener append appendTo closeContainerDialog closest contains create deregisterBindHandlers deregisterEventBusSubscriber dump executeAction exists furthest getActionUseContext getActionUsing getAs getBackground getBox getChildren getContainerBucket getContextMenu getContextMenuMacroMatches getDialog getIndex getMenu getNthChild getNthChildFromEnd getOffset getParent getPartialContextMenuMacros getQuadrantComponent getQuadrantComponentInQuadrant getQuadrantComponentQuadrants getQuadrantComponents getQuadrantContainer getScreen getSelectionTarget hasContextMenu hasContextMenuMacroPartialOrMatch hasOpenAncestorBuckets hasOpenContainerBucket hasPartialContextMenuMacro hide hideContextMenu isActionUsable isFocused isMouseWithin isSelectable isShowingTooltip isVisible matches mouseStartWasWithin observe onCalculateEquipmentStats onCancel onCloseAllDialogs onContextMenu onDie onDisableHealthVignette onEnter onEntityMoved onEquipItem onExploreAsGhost onGameStart onHide onInput onInspect onIslandTickEnd onItemBecomeDoodad onItemRevertFromDoodad onLeave onLoadedOnIsland onNightlyAlignmentChange onObscureOrReveal onOpenBook onReadMap1 onRemoveContainableFromContainer onResize onRespawn onSailOffMapEdge onScreenHide onScreenShow onScreenshotMode onZoom openContainerDialog prepend prependTo querySelectorAll queryX queryXAll reflow refreshTooltip regenerateBoxes registerBindHandlers registerEventBusSubscriber remove removeBackground removeEventListener removeTooltip repaint schedule scrollTo setBackground setContents setContextMenu setElement setHighlight setId setInert setInitialSelection setSelectable setTooltip show showTooltip siblings sleep store toggle toggleCinematicMode all append findDescendants get getSelectableLayer remove

Constructors

constructor

Properties

actionBar

actionBar: undefined | default

Readonly attributes

attributes: AttributeManipulator<default>

Readonly classes

classes: ClassManipulator<default>

Readonly data

data: DataManipulator<default>

dialogs

dialogs: default = ...

Protected entered

entered: boolean = false

event

event: IEventEmitter<default, IGameScreenEvents>

Protected Optional hasHiddenClass

hasHiddenClass?: boolean

interactionManager

interactionManager: default

isOverlayScreen

isOverlayScreen: boolean = false

Protected Optional lastTooltipSource

lastTooltipSource?: default<HTMLElement>

log

log: Log

menuBar

menuBar: default

Readonly menus

menus: default = ...

messages

messages: default

Optional observing

observing?: boolean

quadrantComponentHeldQuadrants

quadrantComponentHeldQuadrants: OptionalDescriptions<QuadrantComponentId, Quadrant> = {}

Saved/previous locations for quadrant components that were hidden

quadrantComponentQuadrants

quadrantComponentQuadrants: OptionalDescriptions<QuadrantComponentId, Quadrant> = {}

Current locations for visible quadrant components

Optional removed

removed?: string | boolean

rooted

rooted: boolean = false

stats

stats: default

Readonly style

style: StyleManipulator<default>

Readonly type

type: ScreenId

visibleDialogs

visibleDialogs: IDialogStates = ...

worldTooltipHandler

worldTooltipHandler: default

Static map

map: WeakMap<Element, default<HTMLElement>> = componentMap

Accessors

childCount

  • get childCount(): number

  • The number of child elements of this component.

    Returns number

dataset

  • get dataset(): DOMStringMap

  • The dataset of the internal element.

    Returns DOMStringMap

element

  • get element(): E

  • The element that this Component instance wraps.

    Returns E

isObscured

  • get isObscured(): boolean

  • Returns boolean

isTwoColumn

  • get isTwoColumn(): boolean

  • Returns boolean

selectable

  • get selectable(): false | SelectableLayer

  • The selectable layer of this element, or false if it is not selectable.

    Returns false | SelectableLayer

Methods

addEventListener

  • Alias of .element.addEventListener, except it returns this instead and prevents memory leaks

    Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns default

  • Parameters

    • type: string
    • listener: ((this: HTMLElement, ev: Event) => any)
        • (this: HTMLElement, ev: Event): any

        • Parameters

          • this: HTMLElement
          • ev: Event

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns default

append

  • Appends every element of a list of components/elements.

    Parameters

    • Rest ...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>

      A varargs list of elements or iterables of elements. Falsy values are skipped

    Returns default

  • Appends every element of a list of components/elements.

    Parameters

    • appendStrategy: AppendStrategy

      Where in this component to insert new components. See AppendStrategy

    • Rest ...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>

      A varargs list of elements or iterables of elements. Falsy values are skipped

    Returns default

appendTo

  • Appends this component to another element, by selector, element, or component.

    Parameters

    • Optional where: null | string | HTMLElement | default<HTMLElement>

      A CSS selector, an element, or a component to append this component to.

    • Optional appendStrategy: AppendStrategy

      Where in the new container to insert this component. See AppendStrategy

    Returns default

closeContainerDialog

  • Parameters

    Returns boolean

closest

  • An alias for element.closest(selector)

    Parameters

    • selector: string

    Returns undefined | Element

contains

  • Returns whether this component contains the given element.

    Parameters

    • Optional what: null | string | Node | default<HTMLElement>

    Returns boolean

Protected create

  • Returns void

deregisterBindHandlers

deregisterEventBusSubscriber

dump

  • Removes all children.

    Returns default

  • Removes all children that are not filtered out with the given filter function.

    Parameters

    • Optional filter: ((element: HTMLElement, component?: default<HTMLElement>) => boolean)

      A function that returns true if the child should be kept.

        • (element: HTMLElement, component?: default<HTMLElement>): boolean

        • Parameters

          • element: HTMLElement
          • Optional component: default<HTMLElement>

          Returns boolean

    Returns default

executeAction

exists

  • Returns boolean

furthest

  • An alias for element.closest(selector)

    Parameters

    • selector: string

    Returns undefined | HTMLElement

getActionUseContext

getActionUsing

getAs

  • Type Parameters

    Parameters

    • cls: AnyClass<C>

    Returns undefined | C

getBackground

getBox

  • A cached alias for element.getBoundingClientRect(). Boxes are updated or regenerated as ancestors shift.

    Parameters

    • regenIfZero: boolean = true
    • forceRegen: boolean = false

    Returns default

getChildren

  • Returns a stream of this component's child components. Child elements that don't have associated components will be undefined.

    Type Parameters

    Parameters

    • Optional selector: string

      A selector that each element must match to be included in the result stream

    Returns Stream<C>

getContainerBucket

  • Parameters

    Returns undefined | default

getContextMenu

  • Returns undefined | default<string | number | symbol>

getContextMenuMacroMatches

getDialog

  • Returns this component's containing dialog, if it exists.

    Type Parameters

    Returns undefined | D

getIndex

  • Returns the index of this component amongst its sibling nodes. If it has no parent, it returns undefined.

    Parameters

    • elementsOnly: boolean = false

    Returns undefined | number

getMenu

  • Returns this component's containing menu, if it exists.

    Type Parameters

    Returns undefined | M

getNthChild

  • Returns the nth child, defaulting to the first child

    Type Parameters

    • C extends undefined | default<HTMLElement> = undefined | default<HTMLElement>

    Parameters

    • nth: number = 0

    Returns undefined | C

getNthChildFromEnd

  • Returns the nth child from the end, defaulting to the last child

    Type Parameters

    • C extends undefined | default<HTMLElement> = undefined | default<HTMLElement>

    Parameters

    • nth: number = 0

    Returns undefined | C

getOffset

  • Returns an object containing HTMLElement.offsetTop and HTMLElement.offsetLeft

    Returns {
        left: number;
        top: number;
    }

    • left: number
    • top: number

getParent

  • Returns this component's parent component, if it exists.

    Type Parameters

    • C extends undefined | default<HTMLElement> = undefined | default<HTMLElement>

    Returns null | C

getPartialContextMenuMacros

getQuadrantComponent

getQuadrantComponentInQuadrant

  • Parameters

    • quadrant: Quadrant
    • includeHeldLocations: boolean
    • Optional includePlaceholders: false

    Returns undefined | default

  • Parameters

    • quadrant: Quadrant
    • includeHeldLocations: boolean
    • Optional includePlaceholders: boolean

    Returns undefined | default | default

getQuadrantComponentQuadrants

getQuadrantComponents

  • Returns Stream<default>

getQuadrantContainer

  • Returns default<HTMLElement>

getScreen

  • Returns this component's containing dialog, if it exists.

    Type Parameters

    Returns undefined | S

getSelectionTarget

hasContextMenu

  • Returns boolean

hasContextMenuMacroPartialOrMatch

hasOpenAncestorBuckets

  • Parameters

    Returns boolean

hasOpenContainerBucket

  • Parameters

    Returns boolean

hasPartialContextMenuMacro

hide

  • Hides the element. If a tooltip is shown for this element, hides that as well.

    Parameters

    • trustInternalState: boolean = false

    Returns default

hideContextMenu

  • Hides the currently visible context menu.

    Parameters

    • Optional contextMenu: default<string | number | symbol>

    Returns boolean

isActionUsable

isFocused

  • Returns boolean

isMouseWithin

  • Returns undefined | default<HTMLElement>

isSelectable

  • Returns boolean

isShowingTooltip

  • Returns boolean

isVisible

  • Returns whether the element is visible.

    Parameters

    • trustInternalState: boolean = false

    Returns boolean

matches

  • Parameters

    • selector: string

    Returns boolean

mouseStartWasWithin

  • Parameters

    Returns undefined | boolean

observe

  • Enables a intersection observe on this component and fires an observe event once when the element is first observed

    Returns void

onCalculateEquipmentStats

  • Notee: calculateEquipmentStats is always ran after calculateStats is called, so this will work

    Returns void

Protected onCancel

  • Returns boolean

Protected onCloseAllDialogs

  • Returns boolean

Protected onContextMenu

Protected onDie

  • Parameters

    • player: default
    • Optional showingGameEndScreen: boolean

    Returns void

Protected onDisableHealthVignette

  • Returns void

Protected onEnter

  • Parameters

    • reason: "focus" | "mouse"

    Returns void

Protected onEntityMoved

Protected onEquipItem

  • Returns void

onExploreAsGhost

  • Returns void

onGameStart

  • Parameters

    • game: Game
    • _isLoadingSave: boolean
    • _playedCount: number

    Returns void

Protected onHide

  • Returns void

Protected onInput

Protected onInspect

onIslandTickEnd

Protected onItemBecomeDoodad

  • Parameters

    Returns void

Protected onItemRevertFromDoodad

  • Parameters

    Returns void

Protected onLeave

  • Parameters

    • reason: "remove" | "focus" | "mouse"

    Returns void

onLoadedOnIsland

  • Parameters

    Returns void

onNightlyAlignmentChange

  • Returns Promise<void>

Protected onObscureOrReveal

  • Returns void

onOpenBook

Protected onReadMap1

Protected onRemoveContainableFromContainer

  • Parameters

    Returns void

Protected onResize

  • Returns void

Protected onRespawn

  • Returns void

Protected onSailOffMapEdge

  • Parameters

    Returns void

Protected onScreenHide

  • Returns void

Protected onScreenShow

  • Returns void

Protected onScreenshotMode

  • Returns boolean

Protected onZoom

openContainerDialog

prepend

  • Appends every element of a list of components/elements.

    Parameters

    • Rest ...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>

      A varargs list of elements or iterables of elements. Falsy values are skipped

    Returns default

prependTo

  • Appends this component to another element, by selector, element, or component.

    Parameters

    • Optional where: null | string | HTMLElement | default<HTMLElement>

      A CSS selector, an element, or a component to append this component to.

    Returns default

querySelectorAll

  • An alias for element.querySelectorAll(selector)

    Type Parameters

    • E extends HTMLElement<E> = HTMLElement

    Parameters

    • selector: string

    Returns NodeListOf<E>

queryX

  • Type Parameters

    • N extends Node<N> = Node

    Parameters

    • selector: string

    Returns null | N

queryXAll

  • Type Parameters

    • N extends Node<N> = Node

    Parameters

    • selector: string

    Returns N[]

reflow

  • Parameters

    • reason: string

    Returns void

refreshTooltip

  • Returns void

regenerateBoxes

  • Forcibly regenerates the cached result of Component.getBox for this component and all descendants.

    Parameters

    • descendants: boolean = true

    Returns void

registerBindHandlers

registerEventBusSubscriber

remove

  • Removes this element and all descendants.

    Returns default

removeBackground

removeEventListener

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    Returns default

removeTooltip

  • Returns void

repaint

  • Triggers a repaint on this element.

    Returns void

schedule

  • Runs the given callback with the given arguments. this and the first argument are this element.

    Type Parameters

    • A extends any[]

    Parameters

    • Optional cb: ((this: default, component: default, ...args: A) => any)

      The callback to run.

    • Rest ...args: A

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments. this and the first argument are this element.

    Parameters

    • Optional cb: ((this: default, component: default) => any)

      The callback to run.

    • Rest ...args: any[]

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Type Parameters

    • A extends any[]

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • cb: ((this: default, component: default, ...args: A) => any)

      The callback to run.

    • Rest ...args: A

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • Optional cb: ((this: default, component: default) => any)

      The callback to run.

    • Rest ...args: any[]

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Type Parameters

    • A extends any[]

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • debounce: number

      The span of time to debounce in. (If this callback was scheduled again in this time, skip this earlier call)

    • cb: ((this: default, component: default, ...args: A) => any)

      The callback to run.

    • Rest ...args: A

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • debounce: number

      The span of time to debounce in. (If this callback was scheduled again in this time, skip this earlier call)

    • Optional cb: ((this: default, component: default) => any)

      The callback to run.

    • Rest ...args: any[]

      The arguments with which to call the callback.

    Returns default

scrollTo

  • Scrolls this element so the given child is at the top of the viewport.

    Parameters

    • Optional child: HTMLElement | default<HTMLElement>

      The child to scroll to

    • Optional ms: number

      The time to take, defaulting to 1000 (1 second)

    Returns void

  • Scrolls this element so the given child is at the top of the viewport.

    Parameters

    • child: undefined | HTMLElement | default<HTMLElement>

      The child to scroll to

    • offsetTop: number

      An offset for the position to scroll to, relative to the position of the child

    • Optional ms: number

      The time to take, defaulting to 1000 (1 second)

    Returns void

setBackground

setContents

  • Sets the contents of this element using innerHTML.

    Parameters

    • html: string

      The content, an HTML string. Script tags will not be executed, as per the normal functionality of innerHTML

    • escape: boolean = false

      Only the text within the HTML will be appended, not the tags.

    Returns default

setContextMenu

  • Remove the context menu from this element

    Returns default

  • Set the context menu for this element

    Parameters

    • generator: ((contextMenu: default<string | number | symbol>) => default<string | number | symbol>)
        • (contextMenu: default<string | number | symbol>): default<string | number | symbol>

        • Parameters

          • contextMenu: default<string | number | symbol>

          Returns default<string | number | symbol>

    Returns default

  • Remove any current context menu and set the visible context menu for this screen to the given context menu

    Parameters

    • contextMenu: default<string | number | symbol>

    Returns default

  • Parameters

    • Optional generatorOrContextMenu: default<string | number | symbol> | ((contextMenu: default<string | number | symbol>) => default<string | number | symbol>)

    Returns default

setElement

  • Warning: This method will replace the internal element backing this component.

    Only call this directly after constructing the element.

    Parameters

    • element: HTMLElement

    Returns default

  • Warning: This method will replace the internal element backing this component.

    Only call this directly after constructing the element.

    Parameters

    • Optional elementType: string
    • Optional namespace: SVG

    Returns default

setHighlight

setId

  • Sets the ID of this component's element.

    Parameters

    • id: string

    Returns default

setInert

  • Parameters

    • inert: boolean = true

    Returns default

setInitialSelection

  • Parameters

    • initialSelection: boolean = true

    Returns default

setSelectable

setTooltip

  • Sets the tooltip options for this element. Setting the tooltip to undefined, or not providing the argument removes the tooltip options.

    Type Parameters

    • ARGS extends any[]

    Parameters

    • Optional initializer: ((tooltip: default, ...args: ARGS) => any)
        • (tooltip: default, ...args: ARGS): any

        • Parameters

          • tooltip: default
          • Rest ...args: ARGS

          Returns any

    • Rest ...args: ARGS

    Returns default

show

  • Shows the element.

    Parameters

    • trustInternalState: boolean = false

    Returns default

showTooltip

  • Returns void

siblings

  • Returns a stream of this component's sibling components. Child elements that don't have associated components will be undefined.

    Type Parameters

    Parameters

    • Optional selector: string

      A selector that each element must match to be included in the result stream

    Returns Stream<C>

sleep

  • Returns

    a promise that resolves when either the given time has passed, or this component has been removed. Returns true if this component exists, false if it has been removed.

    Parameters

    • ms: number

    Returns Promise<boolean>

store

  • Moves this element to a hidden element, in order to retain any information the element had. This allows the element to be re-appended later without re-adding event handlers, CSS, or any other data.

    Parameters

    Returns default

toggle

  • Toggles the visibility of this element. Internally uses show and hide.

    Parameters

    • Optional visible: boolean

      The new visiblity of this element.

    • trustInternalState: boolean = false

    Returns default

toggleCinematicMode

  • Parameters

    • enabled: boolean
    • reason: string

    Returns default

Static all

  • Parameters

    • selector: string

    Returns Stream<default<HTMLElement>>

Static append

  • Parameters

    • elementToMove: string | HTMLElement | default<HTMLElement>
    • placeToAppendTo: string | HTMLElement | default<HTMLElement>
    • strategy: AppendStrategy = "append"

    Returns void

Static findDescendants

  • Parameters

    • inElement: HTMLElement | default<HTMLElement>
    • selector: string
    • includeSelf: boolean = false

    Returns HTMLElement[]

Static get

  • Parameters

    • selector: string

    Returns undefined | default<HTMLElement>

  • Parameters

    • element: Element | default<HTMLElement>

    Returns default<HTMLElement>

  • Parameters

    • event: Event

    Returns default<HTMLElement>

  • Parameters

    • element: undefined | null | false | Element | default<HTMLElement>

    Returns undefined | default<HTMLElement>

  • Parameters

    • selector: string
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Parameters

    • element: Element | default<HTMLElement>
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Parameters

    • event: Event
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Parameters

    • element: undefined | null | false | Element | default<HTMLElement>
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Type Parameters

    Parameters

    • selector: string

    Returns undefined | C

  • Type Parameters

    Parameters

    • element: Element | C

    Returns C

  • Type Parameters

    Parameters

    • event: Event

    Returns C

  • Type Parameters

    Parameters

    • element: undefined | null | false | Element | C

    Returns undefined | C

  • Type Parameters

    Parameters

    • selector: string
    • create: undefined | false

    Returns undefined | C

  • Type Parameters

    Parameters

    • element: Element | C
    • create: undefined | false

    Returns undefined | C

  • Type Parameters

    Parameters

    • event: Event
    • create: undefined | false

    Returns undefined | C

  • Type Parameters

    Parameters

    • element: undefined | null | false | Element | C
    • create: undefined | false

    Returns undefined | C

Static getSelectableLayer

  • Parameters

    • element: HTMLElement | default<HTMLElement>

    Returns number | false

Static remove

  • Parameters

    • elementToRemove: null | string | Element | default<HTMLElement> | ChildNode
    • force: boolean = false
    • uncacheSiblingsAndAncestors: boolean = true

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc