Returns if the chat log is currently scrolled to the bottom
A reference to the Messages collection that the chat log displays
The base name of this sidebar tab
Return the active application element, if it currently exists in the DOM
The path to the HTML template file which should be used to render the inner content of the app
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
Return a flag for whether the Application instance is currently rendered
Whether the Application is currently closing.
An Application window should define its own title definition logic which may be dynamic depending on its data
Delete a single message from the chat log
The ChatMessage document to remove from the log
Is this part of a flush operation to delete all messages?
Trigger a notification that alerts the user visually and audibly that a new chat log message has been posted
The message generating a notification
Post a single chat message to the log
A ChatMessage document instance to post to the log
Additional options for how the message is posted to the log
A Promise which resolves once the message is posted
Scroll the chat log to the bottom
Update the content of a previously posted message after its data has been replaced
The ChatMessage instance to update
Trigger a notification which shows the log as having a new unread message
Update the displayed timestamps for every displayed message in the chat log. Timestamps are displayed in a humanized "timesince" format.
After rendering, activate event listeners which provide interactivity for the Application. This is where user-defined Application subclasses should attach their event-handling logic.
Prepare the data object of chat message data depending on the type of message being posted
The original string of the message content
The prepared chat data object, or void if we were executing a macro instead
Activate this SidebarTab, switching focus to it
Create a second instance of this SidebarTab class which represents a singleton popped-out container
The popped out sidebar tab instance
Render the SidebarTab as a pop-out container
Handle lazy loading for sidebar images to only load them once they become observed
The entries which are now observed
The intersection observer instance
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
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.
Additional rendering options which are applied to customize the way that the Application is rendered in the DOM.
The rendered Application instance
Change the currently active tab
The target tab name to switch to
Options which configure changing the tab
A specific named tab group, useful if multiple sets of tabs are present
Whether to trigger tab-change callback functions
Bring the application to the top of the rendering stack
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
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
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.
Positional data
The left offset position in pixels
The top offset position in pixels
The application width in pixels
The application height in pixels
The application scale as a numeric factor where 1.0 is default
|void}
Persist the scroll positions of containers within the app before re-rendering the content
The HTML object being traversed
Restore the scroll positions of containers within the app after re-rendering the content
The HTML object being traversed
Render the outer application wrapper
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.
Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.
Handle changes to the active tab in a configured Tabs controller
A left click event
The Tabs controller
The new active tab name
Handle changes to search filtering controllers which are bound to the Application
The key-up event from keyboard input
The raw string input to the search field
The regular expression to test against
The HTML element which should be filtered
Define whether a user is able to begin a dragstart workflow for a given drag selector
The candidate HTML selector for dragging
Can the current user drag this selector?
Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector
The candidate HTML selector for the drop target
Can the current user drop on this selector?
Callback actions which occur at the beginning of a drag start workflow.
The originating DragEvent
Callback actions which occur when a dragged element is over a drop target.
The originating DragEvent
Callback actions which occur when a dragged element is dropped on a target.
The originating DragEvent
Wait for any images present in the Application to load.
A Promise that resolves when all images have loaded.
Render a batch of additional messages, prepending them to the top of the log
The rendered jQuery HTML object
The batch size to include
Process messages which are posted using a dice-roll command
The chat command type
Multi-line matched roll expressions
The initial chat data
Options used to create the message
Process messages which are posted using a chat whisper command
The chat command type
The matched RegExp expressions
The initial chat data
Options used to create the message
Process messages which are posted using a chat whisper command
The chat command type
The matched RegExp expressions
The initial chat data
Options used to create the message
Process messages which execute a macro.
The chat command typed.
The RegExp matches.
Add a sent message to an array of remembered messages to be re-sent if the user pages up with the up arrow key
The message text being remembered
Recall a previously sent message by incrementing up (1) or down (-1) through the sent messages array
The direction to recall, positive for older, negative for more recent
The recalled message, or an empty string
Get the ChatLog entry context options
The ChatLog entry context options
Handle keydown events in the chat entry textarea
Handle setting the preferred roll mode
Handle single message deletion workflow
Handle clicking of dice tooltip buttons
Handle click events to export the chat log
Handle click events to flush the chat log
Handle scroll events within the chat log container
The initial scroll event
Parse a chat string to identify the chat command (if any) which was used
The message to match
The identified command and regex match
Update roll mode select dropdowns when the setting is changed
The new roll mode setting
Handle dropping of transferred data onto the chat editor
The originating drop event which triggered the data transfer
Denote whether this is the original version of the sidebar tab, or a pop-out variant
The options provided to this application upon initialization
The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT
An internal reference to the HTML element this application renders
Track the current position and dimensions of the Application UI
DragDrop workflow handlers which are active for this Application
Tab navigation handlers which are active for this Application
SearchFilter handlers which are active for this Application
Track whether the Application is currently minimized
Track the most recent scroll positions for any vertically scrolling containers
A reference to the pop-out variant of this SidebarTab, if one exists
The current render state of the Application
The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.
A flag for whether the chat log is currently scrolled to the bottom
A cache of the Jump to Bottom element
An enumeration of regular expression patterns used to match chat messages.
The set of commands that can be processed over multiple lines.
The sequence of rendering states that track the Application life-cycle.
The sidebar directory which organizes and displays world-level ChatMessage documents.
{Sidebar}
Application configuration options.