Global

The ID of the scene that the user is viewing.

The position of the user's cursor.

The state of the user's ruler, if they are currently using one.

The IDs of the tokens the user has targeted in the currently viewed scene.

Whether the user has an open WS connection to the server or not.

Is the user pulling focus to the cursor coordinates?

Is the user emitting a ping at the cursor coordinates?

The state of the user's AV settings.

A named "base application" which generates an additional hook

The default pixel width for the rendered HTML

The default pixel height for the rendered HTML

The default offset-top position for the rendered HTML

The default offset-left position for the rendered HTML

A transformation scale for the rendered HTML

Whether to display the application as a pop-out container

Whether the rendered application can be minimized (popOut only)

Whether the rendered application can be drag-resized (popOut only)

The default CSS id to assign to the rendered HTML

An array of CSS string classes to apply to the rendered HTML

A default window title string (popOut only)

The default HTML template path to render for this Application

A list of unique CSS selectors which target containers that should have their vertical scroll positions preserved during a re-render.

An array of tabbed container configurations which should be enabled for the application.

An array of CSS selectors for configuring the application's DragDrop behaviour.

An array of SearchFilter configuration objects.

Whether this user has muted themselves.

Whether this user has hidden their video.

Whether the user is broadcasting audio.

The animation function being executed each frame

The object context within which animation occurs

A Promise which resolves once the animation is complete

The resolution function, allowing animation to be ended early

The type of operation stored as history (create, update, delete)

The data corresponding to the action which may later be un-done

The layer name by which the instance is referenced within the Canvas

The zIndex sorting of this layer relative to other layers

Should this layer be sorted to the top when it is active?

Is this chat log being rendered as part of the stream view?

The desired density of padding rays, a number per PI

The minimum angle of emission

The maximum angle of emission

The minimum ray of emission

The maximum ray of emission

Does this polygon have a limited radius?

Does this polygon have a limited angle?

The squared radius of the polygon, for faster computation later

A small epsilon used for avoiding floating point precision issues

A map of axes values

The Set of pressed Buttons

The context menu label. Can be localized.

A string containing an HTML icon element for the menu item

The function to call when the menu item is clicked. Receives the HTML element of the entry that this context menu is for.

A function to call to determine if this item appears in the menu. Receives the HTML element of the entry that this context menu is for.

A Font Awesome icon for the button

The label for the button

A callback function that fires when the button is clicked

Whether to provide jQuery objects to callback functions (if true) or plain HTMLElement instances (if false). This is currently true by default but in the future will become false by default.

The numeric result

Is this result active, contributing to the total?

A value that the result counts as, otherwise the result is not used directly as

Does this result denote a success?

Does this result denote a failure?

Was this result discarded?

Was this result rerolled?

Was this result exploded?

An object which defines the data type of this field

Is this field required to have an assigned value? Default is false.

Can the field be populated by a null value? Default is true.

A static default value or a function which assigns a default value

An optional cleaning function which sanitizes input data to this field

A function which asserts that the value of this field is valid

An error message which is displayed if validation fails

Is the field an embedded Document collection?

A parent Document within which these Documents should be embedded

A Compendium pack identifier within which the Documents should be modified

Block the dispatch of preCreate hooks for this operation

Return an index of the Document collection, used only during a get operation.

An array of fields to retrieve when indexing the collection

When performing a creation operation, keep the _id of the document being created instead of generating a new one.

When performing a creation operation, keep existing _id values of documents embedded within the one being created instead of generating new ones.

Create a temporary document which is not saved to the database. Only used during creation.

Automatically re-render existing applications associated with the document.

Automatically create and render the Document sheet when the Document is first created.

Difference each update object against current Document data to reduce the size of the transferred data. Only used during update.

Merge objects recursively. If false, inner objects will be replaced explicitly. Use with caution!

Is the operation undoing a previous operation, only used by embedded Documents within a Scene

Whether to delete all documents of a given type, regardless of the array of ids provided. Only used during a delete operation.

The default permissions required to view this Document sheet.

The CSS selector used to target draggable elements.

The CSS selector used to target viable drop targets.

An object of permission test functions for each action

An object of callback functions for each action

Configure the default drawing settings, instead of a specific Drawing

A type of file to target, in "audio", "image", "video", "imagevideo", "folder", or "any"

The current file path being modified, if any

A current file source in "data", "public", or "s3"

A callback function to trigger once a file has been selected

A flag which permits explicitly disallowing upload, true by default

An HTML form field that the result of this selection is applied to

An HTML button element which triggers the display of this picker

The picker display mode in FilePicker.DISPLAY_MODES

Display the tile size configuration.

Whether to automatically close the application when it's contained form is submitted.

Whether to automatically submit the contained HTML form when an input or select element is changed.

Whether to automatically submit the contained HTML form when the application window is manually closed.

Whether the application form is editable - if true, it's fields will be unlocked and the form can be submitted. If false, all form fields will be disabled and the form cannot be submitted.

Support configuration of the sheet type used for this application.

Can this image be shared with connected users?

The UUID of some related Document.

The current display mode of the journal. Either 'text' or 'image'.

The namespaced machine identifier of the Action

The Keyboard key

The human readable name

Required modifiers

Optional (reserved) modifiers

The handler that executes onDown

The handler that executes onUp

If True, allows Repeat events to execute this Action's onDown

If true, only a GM can execute this Action

The registration precedence

The registration order

The KeyboardEvent#code value from https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code/code_values

An array of modifiers keys from KeyboardManager.MODIFIER_KEYS which are required for this binding to be activated

The namespace within which the action was registered

The human readable name

An additional human readable hint

The default bindings that can never be changed nor removed.

The default bindings that can be changed by the user.

A function to execute when a key down event occurs. If True is returned, the event is consumed and no further keybinds execute.

A function to execute when a key up event occurs. If True is returned, the event is consumed and no further keybinds execute.

If True, allows Repeat events to execute the Action's onDown. Defaults to false.

If true, only a GM can edit and execute this Action

Modifiers such as [ "CONTROL" ] that can be also pressed when executing this Action. Prevents using one of these modifiers as a Binding.

The preferred precedence of running this Keybinding Action

The recorded registration order of the action

The normalized string key, such as "A"

The originating keypress event

Is the Shift modifier being pressed

Is the Control or Meta modifier being processed

Is the Alt modifier being pressed

Are any of the modifiers being pressed

A list of string modifiers applied to this context, such as [ "CONTROL" ]

True if the Key is Up, else False if down

True if the given key is being held down such that it is automatically repeating.

The executing Keybinding Action. May be undefined until the action is known.

The human-readable (localized) label for the animation

The animation function that runs every frame

A custom illumination shader used by this animation

A custom coloration shader used by this animation

A custom background shader used by this animation

The animation seed

The animation time

The numeric identifier of the technique

The localization string that labels the technique

The shader fragment when the technique is used

The x-coordinate of the source location

The y-coordinate of the source location

An optional z-index sorting for the source

The angle of rotation for this point source

An opacity for the emitted light, if any

An animation configuration for the source

The angle of emission for this point source

The allowed radius of bright vision or illumination

A tint color for the emitted light, if any

The coloration technique applied in the shader

The amount of contrast this light applies to the background texture

A darkness range (min and max) for which the source should be active

The allowed radius of dim vision or illumination

Fade the difference between bright, dim, and dark gradually?

The luminosity applied in the shader

The amount of color saturation this light applies to the background texture

The depth of shadows this light applies to the background texture

Whether or not the source is constrained by walls

Whether or not this source provides a source of vision

An integer seed to synchronize (or de-synchronize) animations

Is point A inside the circle?

Is point B inside the circle?

Is the segment AB contained within the circle?

Is the segment AB fully outside the circle?

Is the segment AB tangent to the circle?

Intersection points: zero, one, or two

The x-coordinate of intersection

The y-coordinate of intersection

The vector distance from A to B on segment AB

The vector distance from C to D on segment CD

Return the distance in grid increments rather than the co-ordinate distance.

The type of polygon being computed

The angle of emission, if limited

The desired density of padding rays, a number per PI

A limited radius of the resulting polygon

The direction of facing, required if the angle is limited

Display debugging visualization and logging for the polygon

Is this polygon constrained by any walls?

The object (if any) that spawned this polygon.

The x-coordinate of intersection

The y-coordinate of intersection

The proximity to the Ray origin, as a ratio of distance

The proximity to the Ray destination, as a ratio of distance

The Dice roll which generated the draw

An array of drawn TableResult documents

The ruler measurement state.

A unique name for the ruler containing the owning user's ID.

The current point the ruler has been extended to.

The class name of this ruler instance.

Additional waypoints along the ruler's length, including the starting point.

Options which customize the behavior of the filter

Properties

A unique machine-readable id for the setting

The namespace the setting belongs to

The human readable name

An additional human readable hint

The scope the Setting is stored in, either World or Client

Indicates if this Setting should render in the Config application

The JS Type that the Setting is storing

For string Types, defines the allowable values

For numeric Types, defines the allowable range

The default value

Executes when the value of this Setting changes

The human readable name

The human readable label

An additional human readable hint

The classname of an Icon to render

The FormApplication to render

If true, only a GM can edit this Setting

A list of data property keys that will trigger a re-render of the tab if they are updated on a Document that this tab is responsible for.

The CSS selector that activates the context menu for displayed Documents.

The server-side action being requested

The type of object being modified

Data applied to the operation

A Compendium pack name

The type of parent document

The ID of a parent document

Additional options applied to the request

The initial request

An error, if one occurred

The status of the request

The ID of the requesting User

Data returned as a result of the request

The x-coordinate of the source location

The y-coordinate of the source location

The radius of the sound effect

Whether or not the source is constrained by walls

The x-coordinate of the source location

The y-coordinate of the source location

An optional z-index sorting for the source

The angle of rotation for this point source

The angle of emission for this point source

The allowed radius of bright vision or illumination

The allowed radius of dim vision or illumination

Whether the world is being created or updated.