The currently viewed macro page
The currently displayed set of macros
Track collapsed state
Track which hotbar slot is the current hover target, if any
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
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.
Collapse the Hotbar, minimizing its display.
A promise which resolves once the collapse animation completes
Expand the Hotbar, displaying it normally.
A promise which resolves once the expand animation completes
Change to a specific numbered page from 1 to 5
The page number to change to.
Change the page of the hotbar by cycling up (positive) or down (negative)
The direction to cycle
Create a ContextMenu for this Application.
The Application's HTML.
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
Close the application and un-register references to it within UI mappings This function returns a Promise which resolves once the window closing animation concludes
A Promise which resolves once the application is closed
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.
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
Handle left-click events to
The originating click event
Create a Macro document which can be used to toggle display of a Journal Entry.
A Document which should be toggled
A created Macro document to add to the bar
An asynchronous inner function which handles the rendering of the Application
Render and display the application even if it is not currently displayed.
Additional options which update the current values of the Application#options object
A Promise that resolves to the Application once rendering is complete
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
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
Callback actions which occur when a dragged element is over a drop target.
The originating DragEvent
Get the Array of Macro (or null) values that should be displayed on a numbered page of the bar
Get the Macro entry context options
The Macro entry context options
Handle pagination controls
The originating click event
Handle click events to toggle display of the macro bar
Handle toggling a document sheet.
The Document UUID to display
Return the CSS application ID which uniquely references this UI element
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
An Application window should define its own title definition logic which may be dynamic depending on its data
The global action bar displayed at the bottom of the game view. The Hotbar is a UI element at the bottom of the screen which contains Macros as interactive buttons. The Hotbar supports 5 pages of global macros which can be dragged and dropped to organize as you wish.
Left-clicking a Macro button triggers its effect. Right-clicking the button displays a context menu of Macro options. The number keys 1 through 0 activate numbered hotbar slots. Pressing the delete key while hovering over a Macro will remove it from the bar.