Record the currently tracked Combat encounter
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.
The sequence of rendering states that track the Application life-cycle.
Return an array of Combat encounters which occur within the current Scene.
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
Create a second instance of this SidebarTab class which represents a singleton popped-out container
The popped out sidebar tab instance
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.
Additional options to configure behavior.
Scroll the combat log container to ensure the current Combatant turn is centered vertically
After rendering, activate event listeners which provide interactivity for the Application. This is where user-defined Application subclasses should attach their event-handling logic.
Highlight a hovered combatant in the tracker.
The Combatant
Whether they are being hovered in or out.
Activate this SidebarTab, switching focus to it
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}
Retrieve a source image for a combatant.
The combatant queried for image.
The source image attributed for this combatant.
Handle pinging a combatant Token
The combatant data
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.
Handle new Combat creation request
Handle a Combat cycle request
Handle click events on Combat control buttons
The originating mousedown event
Handle a Combatant control toggle
The originating mousedown event
Handle toggling the defeated status effect on a combatant Token
The combatant data being modified
A Promise that resolves after all operations are complete
Handle mouse-down event on a combatant name in the tracker
The originating mousedown event
A Promise that resolves once the pan is complete
Handle mouse-hover events on a combatant in the tracker
Handle mouse-unhover events for a combatant in the tracker
Get the Combatant entry context options
The Combatant entry context options
Display a dialog which prompts the user to enter a new initiative value for a Combatant
The sidebar directory which organizes and displays world-level Combat documents.