Options
All
  • Public
  • Public/Protected
  • All
Menu

The sidebar directory which organizes and displays world-level Combat documents.

Hierarchy

Index

Constructors

Properties

viewed: Combat

Record the currently tracked Combat encounter

_clickTime: number
tabName: string

The base name of this sidebar tab

_original: SidebarTab

Denote whether this is the original version of the sidebar tab, or a pop-out variant

options: any

The options provided to this application upon initialization

appId: number

The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT

_element: jQuery

An internal reference to the HTML element this application renders

position: any

Track the current position and dimensions of the Application UI

_dragDrop: DragDrop[]

DragDrop workflow handlers which are active for this Application

_tabs: Tabs[]

Tab navigation handlers which are active for this Application

_searchFilters: SearchFilter[]

SearchFilter handlers which are active for this Application

_minimized: boolean

Track whether the Application is currently minimized

_scrollPositions: any

Track the most recent scroll positions for any vertically scrolling containers

_popout: SidebarTab

A reference to the pop-out variant of this SidebarTab, if one exists

_state: number

The current render state of the Application

see

{Application.RENDER_STATES}

_priorState: number

The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.

see

{Application.RENDER_STATES}

RENDER_STATES: Readonly<{ CLOSING: -2; CLOSED: -1; NONE: 0; RENDERING: 1; RENDERED: 2; ERROR: 3 }> = ...

The sequence of rendering states that track the Application life-cycle.

Accessors

  • Return an array of Combat encounters which occur within the current Scene.

    Returns Combat[]

  • get id(): string
  • override

    Returns string

  • get element(): jQuery
  • Return the active application element, if it currently exists in the DOM

    Returns jQuery

  • get template(): string
  • The path to the HTML template file which should be used to render the inner content of the app

    Returns string

  • get popOut(): boolean
  • Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered

    Returns boolean

  • get rendered(): boolean
  • Return a flag for whether the Application instance is currently rendered

    Returns boolean

  • get title(): string
  • An Application window should define its own title definition logic which may be dynamic depending on its data

    Returns string

  • get defaultOptions(): any
  • inheritdoc

    Returns any

Methods

  • Create a second instance of this SidebarTab class which represents a singleton popped-out container

    Returns SidebarTab

    The popped out sidebar tab instance

  • initialize([options]?: { combat: Combat; render: boolean }): void
  • Initialize the combat tracker to display a specific combat encounter. If no encounter is provided, the tracker will be initialized with the first encounter in the viewed scene.

    Parameters

    • [options]: { combat: Combat; render: boolean } = {}

      Additional options to configure behavior.

    Returns void

  • scrollToTurn(): void
  • Scroll the combat log container to ensure the current Combatant turn is centered vertically

    Returns void

  • getData(options: any): Promise<any>
  • activateListeners(html: any): void
  • After rendering, activate event listeners which provide interactivity for the Application. This is where user-defined Application subclasses should attach their event-handling logic.

    Parameters

    • html: any

    Returns void

  • hoverCombatant(combatant: Combatant, hover: boolean): void
  • Highlight a hovered combatant in the tracker.

    Parameters

    • combatant: Combatant

      The Combatant

    • hover: boolean

      Whether they are being hovered in or out.

    Returns void

  • _contextMenu(html: any): void
  • inheritdoc

    Parameters

    • html: any

    Returns void

  • _render(force?: boolean, options?: {}): Promise<void>
  • override

    Parameters

    • force: boolean = false
    • options: {} = {}

      Returns Promise<void>

    • _renderInner(data: any): Promise<jQuery>
    • activate(): void
    • Activate this SidebarTab, switching focus to it

      Returns void

    • close(options: any): Promise<void>
    • override

      Parameters

      • options: any

      Returns Promise<void>

    • renderPopout(): void
    • _onLazyLoadImage(entries: HTMLElement[], observer: IntersectionObserver): void
    • Handle lazy loading for sidebar images to only load them once they become observed

      Parameters

      • entries: HTMLElement[]

        The entries which are now observed

      • observer: IntersectionObserver

        The intersection observer instance

      Returns void

    • render(force?: boolean, options?: { left: number; top: number; width: number; height: number; scale: number; focus: boolean; renderContext: string; renderData: any }): Application
    • Render the Application by evaluating it's HTML template against the object of data provided by the getData method If the Application is rendered as a pop-out window, wrap the contained HTML in an outer frame with window controls

      Parameters

      • force: boolean = false

        Add the rendered application to the DOM if it is not already present. If false, the Application will only be re-rendered if it is already present.

      • options: { left: number; top: number; width: number; height: number; scale: number; focus: boolean; renderContext: string; renderData: any } = {}

        Additional rendering options which are applied to customize the way that the Application is rendered in the DOM.

        • left: number
        • top: number
        • width: number
        • height: number
        • scale: number
        • focus: boolean
        • renderContext: string
        • renderData: any

      Returns Application

      The rendered Application instance

    • activateTab(tabName: string, options?: { group: string; triggerCallback: boolean }): void
    • Change the currently active tab

      Parameters

      • tabName: string

        The target tab name to switch to

      • options: { group: string; triggerCallback: boolean } = {}

        Options which configure changing the tab

        • group: string

          A specific named tab group, useful if multiple sets of tabs are present

        • triggerCallback: boolean

          Whether to trigger tab-change callback functions

      Returns void

    • bringToTop(): void
    • Bring the application to the top of the rendering stack

      Returns void

    • minimize(): Promise<void>
    • Minimize the pop-out window, collapsing it to a small tab Take no action for applications which are not of the pop-out variety or apps which are already minimized

      Returns Promise<void>

      A Promise which resolves once the minimization action has completed

    • maximize(): Promise<void>
    • Maximize the pop-out window, expanding it to its original size Take no action for applications which are not of the pop-out variety or are already maximized

      Returns Promise<void>

      A Promise which resolves once the maximization action has completed

    • setPosition(position?: { left: number; top: number; width: number; height: string | number; scale: number }): void | { left: number; top: number; width: number; height: number; scale: number }
    • Set the application position and store its new location. Returns the updated position object for the application containing the new values.

      Parameters

      • position: { left: number; top: number; width: number; height: string | number; scale: number } = {}

        Positional data

        • left: number

          The left offset position in pixels

        • top: number

          The top offset position in pixels

        • width: number

          The application width in pixels

        • height: string | number

          The application height in pixels

        • scale: number

          The application scale as a numeric factor where 1.0 is default

      Returns void | { left: number; top: number; width: number; height: number; scale: number }

      |void}

    • _onPingCombatant(combatant: Combatant): Promise<any>
    • Handle pinging a combatant Token

      Parameters

      Returns Promise<any>

    • _saveScrollPositions(html: jQuery): void
    • Persist the scroll positions of containers within the app before re-rendering the content

      Parameters

      • html: jQuery

        The HTML object being traversed

      Returns void

    • _restoreScrollPositions(html: jQuery): void
    • Restore the scroll positions of containers within the app after re-rendering the content

      Parameters

      • html: jQuery

        The HTML object being traversed

      Returns void

    • _renderOuter(): Promise<jQuery>
    • Render the outer application wrapper

      Returns Promise<jQuery>

      A promise resolving to the constructed jQuery object

    • _activateCoreListeners(html: jQuery): void
    • Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.

      Parameters

      • html: jQuery

      Returns void

    • _onChangeTab(event: MouseEvent, tabs: Tabs, active: string): void
    • Handle changes to the active tab in a configured Tabs controller

      Parameters

      • event: MouseEvent

        A left click event

      • tabs: Tabs

        The Tabs controller

      • active: string

        The new active tab name

      Returns void

    • _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void
    • Handle changes to search filtering controllers which are bound to the Application

      Parameters

      • event: KeyboardEvent

        The key-up event from keyboard input

      • query: string

        The raw string input to the search field

      • rgx: RegExp

        The regular expression to test against

      • html: HTMLElement

        The HTML element which should be filtered

      Returns void

    • _canDragStart(selector: string): boolean
    • Define whether a user is able to begin a dragstart workflow for a given drag selector

      Parameters

      • selector: string

        The candidate HTML selector for dragging

      Returns boolean

      Can the current user drag this selector?

    • _canDragDrop(selector: string): boolean
    • Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector

      Parameters

      • selector: string

        The candidate HTML selector for the drop target

      Returns boolean

      Can the current user drop on this selector?

    • _onDragStart(event: DragEvent): void
    • Callback actions which occur at the beginning of a drag start workflow.

      Parameters

      • event: DragEvent

        The originating DragEvent

      Returns void

    • _onDragOver(event: DragEvent): void
    • Callback actions which occur when a dragged element is over a drop target.

      Parameters

      • event: DragEvent

        The originating DragEvent

      Returns void

    • _onDrop(event: DragEvent): void
    • Callback actions which occur when a dragged element is dropped on a target.

      Parameters

      • event: DragEvent

        The originating DragEvent

      Returns void

    • _onCombatCreate(event: Event): Promise<void>
    • Handle new Combat creation request

      Parameters

      • event: Event

      Returns Promise<void>

    • _onCombatCycle(event: Event): Promise<void>
    • Handle a Combat cycle request

      Parameters

      • event: Event

      Returns Promise<void>

    • _onCombatControl(event: Event): Promise<void>
    • Handle click events on Combat control buttons

      Parameters

      • event: Event

        The originating mousedown event

      Returns Promise<void>

    • _onCombatantControl(event: Event): Promise<any>
    • Handle a Combatant control toggle

      Parameters

      • event: Event

        The originating mousedown event

      Returns Promise<any>

    • _onToggleDefeatedStatus(combatant: Combatant): Promise<any>
    • Handle toggling the defeated status effect on a combatant Token

      Parameters

      • combatant: Combatant

        The combatant data being modified

      Returns Promise<any>

      A Promise that resolves after all operations are complete

    • _onCombatantMouseDown(event: Event): Promise<any>
    • Handle mouse-down event on a combatant name in the tracker

      Parameters

      • event: Event

        The originating mousedown event

      Returns Promise<any>

      A Promise that resolves once the pan is complete

    • _onCombatantHoverIn(event: any): void
    • Handle mouse-hover events on a combatant in the tracker

      Parameters

      • event: any

      Returns void

    • _onCombatantHoverOut(event: any): void
    • Handle mouse-unhover events for a combatant in the tracker

      Parameters

      • event: any

      Returns void

    • _getEntryContextOptions(): any[]
    • Get the Combatant entry context options

      Returns any[]

      The Combatant entry context options

    • _onConfigureCombatant(li: jQuery): void
    • Display a dialog which prompts the user to enter a new initiative value for a Combatant

      Parameters

      • li: jQuery

      Returns void