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

See

Param: options

Application configuration options.

Hierarchy (view full)

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

_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

appId: number

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

_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

_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

#isAtBottom: boolean = true

A flag for whether the chat log is currently scrolled to the bottom

#jumpToBottomElement: any

A cache of the Jump to Bottom element

#renderingQueue: Semaphore = ...

A semaphore to queue rendering of Chat Messages.

#renderingBatch: boolean = false

Currently rendering the next batch?

MESSAGE_PATTERNS: {
    roll: RegExp;
    gmroll: RegExp;
    blindroll: RegExp;
    selfroll: RegExp;
    publicroll: RegExp;
    ic: RegExp;
    ooc: RegExp;
    emote: RegExp;
    whisper: RegExp;
    reply: RegExp;
    gm: RegExp;
    players: RegExp;
    macro: RegExp;
    invalid: RegExp;
} = ...

An enumeration of regular expression patterns used to match chat messages.

Type declaration

  • roll: RegExp
  • gmroll: RegExp
  • blindroll: RegExp
  • selfroll: RegExp
  • publicroll: RegExp
  • ic: RegExp
  • ooc: RegExp
  • emote: RegExp
  • whisper: RegExp
  • reply: RegExp
  • gm: RegExp
  • players: RegExp
  • macro: RegExp
  • invalid: RegExp
MULTILINE_COMMANDS: Set<string> = ...

The set of commands that can be processed over multiple lines.

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

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

Type declaration

  • ERROR: -3
  • CLOSING: -2
  • CLOSED: -1
  • NONE: 0
  • RENDERING: 1
  • RENDERED: 2

Accessors

  • get isAtBottom(): boolean
  • Returns if the chat log is currently scrolled to the bottom

    Returns boolean

  • get collection(): Messages
  • A reference to the Messages collection that the chat log displays

    Returns Messages

  • get id(): string
  • 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

Methods

  • Parameters

    • options: {} = {}

      Returns Promise<any>

    • Parameters

      • force: any
      • options: any

      Returns Promise<void>

    • Parameters

      • data: any

      Returns Promise<jQuery>

    • Delete a single message from the chat log

      Parameters

      • messageId: string

        The ChatMessage document to remove from the log

      • Optional deleteAll: boolean = {}

        Is this part of a flush operation to delete all messages?

      Returns any

    • Trigger a notification that alerts the user visually and audibly that a new chat log message has been posted

      Parameters

      • message: ChatMessage

        The message generating a notification

      Returns void

    • Post a single chat message to the log

      Parameters

      • message: ChatMessage

        A ChatMessage document instance to post to the log

      • Optional options: {
            before: string;
            notify: boolean;
        } = {}

        Additional options for how the message is posted to the log

        • before: string

          An existing message ID to append the message before, by default the new message is appended to the end of the log.

        • notify: boolean

          Trigger a notification which shows the log as having a new unread message.

      Returns Promise<void>

      A Promise which resolves once the message is posted

    • Scroll the chat log to the bottom

      Parameters

      • Optional options: {
            popout: boolean;
            waitImages: boolean;
            scrollOptions: ScrollIntoViewOptions;
        } = {}
        • popout: boolean

          If a popout exists, scroll it to the bottom too.

        • waitImages: boolean

          Wait for any images embedded in the chat log to load first before scrolling?

        • scrollOptions: ScrollIntoViewOptions

          Options to configure scrolling behaviour.

      Returns Promise<void>

    • Update the content of a previously posted message after its data has been replaced

      Parameters

      • message: ChatMessage

        The ChatMessage instance to update

      • notify: boolean = false

        Trigger a notification which shows the log as having a new unread message

      Returns Promise<void>

    • Update the displayed timestamps for every displayed message in the chat log. Timestamps are displayed in a humanized "timesince" format.

      Returns 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

    • Prepare the data object of chat message data depending on the type of message being posted

      Parameters

      • message: string

        The original string of the message content

      • Optional options: {
            speaker: ChatSpeakerData;
        } = {}

        Additional options

        • speaker: ChatSpeakerData

          The speaker data

      Returns Promise<any>

      The prepared chat data object, or void if we were executing a macro instead

    • Parameters

      • html: any

      Returns void

      Inherit Doc

    • Activate this SidebarTab, switching focus to it

      Returns void

    • 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

    • Render the SidebarTab as a pop-out container

      Returns 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 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

          The left positioning attribute

        • top: number

          The top positioning attribute

        • width: number

          The rendered width

        • height: number

          The rendered height

        • scale: number

          The rendered transformation scale

        • focus: boolean

          Apply focus to the application, maximizing it and bringing it to the top of the vertical stack.

        • renderContext: string

          A context-providing string which suggests what event triggered the render

        • renderData: any

          The data change which motivated the render request

      Returns Application

      The rendered Application instance

    • 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

    • Bring the application to the top of the rendering stack

      Returns 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 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

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

    • Protected Internal

      Call all hooks for all applications in the inheritance chain.

      Parameters

      • hookName: string | ((className) => string)

        The hook being triggered, which formatted with the Application class name

      • Rest ...hookArgs: any[]

        The arguments passed to the hook calls

      Returns void

    • Protected

      Persist the scroll positions of containers within the app before re-rendering the content

      Parameters

      • html: jQuery

        The HTML object being traversed

      Returns void

    • Protected

      Restore the scroll positions of containers within the app after re-rendering the content

      Parameters

      • html: jQuery

        The HTML object being traversed

      Returns void

    • Protected

      Render the outer application wrapper

      Returns Promise<jQuery>

      A promise resolving to the constructed jQuery object

    • Protected

      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.

      Returns ApplicationHeaderButton[]

      Fires

      getApplicationHeaderButtons

    • Protected

      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

    • Protected

      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

    • Protected

      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

    • Protected

      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?

    • Protected

      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?

    • Protected

      Callback actions which occur at the beginning of a drag start workflow.

      Parameters

      • event: DragEvent

        The originating DragEvent

      Returns void

    • Protected

      Callback actions which occur when a dragged element is over a drop target.

      Parameters

      • event: DragEvent

        The originating DragEvent

      Returns void

    • Protected

      Callback actions which occur when a dragged element is dropped on a target.

      Parameters

      • event: DragEvent

        The originating DragEvent

      Returns void

    • Protected

      Wait for any images present in the Application to load.

      Returns Promise<void>

      A Promise that resolves when all images have loaded.

    • Private

      Render a batch of additional messages, prepending them to the top of the log

      Parameters

      • html: jQuery

        The rendered jQuery HTML object

      • size: number

        The batch size to include

      Returns Promise<void>

    • Private

      Process messages which are posted using a dice-roll command

      Parameters

      • command: string

        The chat command type

      • matches: RegExpMatchArray[]

        Multi-line matched roll expressions

      • chatData: any

        The initial chat data

      • createOptions: any

        Options used to create the message

      Returns Promise<void>

    • Private

      Process messages which are posted using a chat whisper command

      Parameters

      • command: string

        The chat command type

      • match: RegExpMatchArray

        The matched RegExp expressions

      • chatData: any

        The initial chat data

      • createOptions: any

        Options used to create the message

      Returns void

    • Private

      Process messages which are posted using a chat whisper command

      Parameters

      • command: string

        The chat command type

      • match: RegExpMatchArray

        The matched RegExp expressions

      • chatData: any

        The initial chat data

      • createOptions: any

        Options used to create the message

      Returns void

    • Private

      Process messages which execute a macro.

      Parameters

      • command: string

        The chat command typed.

      • match: RegExpMatchArray

        The RegExp matches.

      Returns any

    • Private

      Add a sent message to an array of remembered messages to be re-sent if the user pages up with the up arrow key

      Parameters

      • message: string

        The message text being remembered

      Returns void

    • Private

      Recall a previously sent message by incrementing up (1) or down (-1) through the sent messages array

      Parameters

      • direction: number

        The direction to recall, positive for older, negative for more recent

      Returns string

      The recalled message, or an empty string

    • Private

      Get the ChatLog entry context options

      Returns any[]

      The ChatLog entry context options

    • Private

      Handle keydown events in the chat entry textarea

      Parameters

      • event: KeyboardEvent

      Returns Promise<void>

    • Private

      Handle setting the preferred roll mode

      Parameters

      • event: Event

      Returns void

    • Private

      Handle single message deletion workflow

      Parameters

      • event: Event

      Returns any

    • Private

      Handle clicking of dice tooltip buttons

      Parameters

      • event: Event

      Returns void

    • Private

      Handle click events to export the chat log

      Parameters

      • event: Event

      Returns void

    • Private

      Handle click events to flush the chat log

      Parameters

      • event: Event

      Returns void

    • Private

      Handle scroll events within the chat log container

      Parameters

      • event: UIEvent

        The initial scroll event

      Returns Promise<void>

    • Parse a chat string to identify the chat command (if any) which was used

      Parameters

      • message: string

        The message to match

      Returns string[]

      The identified command and regex match

    • Update roll mode select dropdowns when the setting is changed

      Parameters

      • mode: string

        The new roll mode setting

      Returns void

    • Private

      Handle dropping of transferred data onto the chat editor

      Parameters

      • event: DragEvent

        The originating drop event which triggered the data transfer

      Returns Promise<void>