Options
All
  • Public
  • Public/Protected
  • All
Menu

The sidebar tab which displays various game settings, help messages, and configuration options. The Settings sidebar is the furthest-to-right using a triple-cogs icon.

Hierarchy

Index

Constructors

Methods

  • getData(options?: {}): Promise<any>
  • activateListeners(html: any): 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>

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

      Returns SidebarTab

      The popped out sidebar tab instance

    • 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}

    • _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

    • Specify the set of config buttons which should appear in the Application header. Buttons should be returned as an Array of objects. The header buttons which are added to the application can be modified by the getApplicationHeaderButtons hook.

      fires

      getApplicationHeaderButtons

      Returns ApplicationHeaderButton[]

    • _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

    • _waitForImages(): Promise<void>
    • Wait for any images present in the Application to load.

      Returns Promise<void>

      A Promise that resolves when all images have loaded.

    • _onSettingsButton(event: MouseEvent): any
    • Delegate different actions for different settings buttons

      Parameters

      • event: MouseEvent

        The originating click event

      Returns any

    • _onUpdateNotificationClick(event: MouseEvent): void
    • Executes with the update notification pip is clicked

      Parameters

      • event: MouseEvent

        The originating click event

      Returns void

    Properties

    _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

    • get id(): string
    • override

      Returns string

    • get tabName(): string
    • The base name of this sidebar tab

      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 closing(): boolean
    • Whether the Application is currently closing.

      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
    • override

      Returns any