The parent BasePackage class being mixed
A BasePackage subclass mixed with ClientPackage features
A specialized subclass of the ClientDocumentMixin which is used for document types that are intended to be represented upon the game Canvas.
The base document class mixed with client and canvas features
The mixed CanvasDocument class definition
A mixin which extends each Document definition with specialized client-side behaviors. This mixin defines the client-side interface for database operations and common document behaviors.
The base Document class to be mixed
The mixed client-side document class definition
A mixin which adds directory functionality to a DocumentCollection, such as folders, tree structures, and sorting.
The base collection class to extend
A Collection mixed with DirectoryCollection functionality
A mixin which decorates a DisplayObject with depth and/or occlusion properties.
The parent DisplayObject class being mixed
A DisplayObject subclass mixed with OccludableObject features
A mixin which decorates a DisplayObject with additional properties expected for rendering in the PrimaryCanvasGroup.
The parent DisplayObject class being mixed
A DisplayObject subclass mixed with PrimaryCanvasObject features
A mixin which decorates any container with base canvas common properties.
The parent Container class being mixed.
A ContainerClass subclass mixed with BaseCanvasMixin features.
A mixin which decorates any container with base canvas common properties.
The parent Container class being mixed.
A ContainerClass subclass mixed with BaseCanvasMixin features.
A mixin which decorates a PIXI.Filter or PIXI.Shader with common properties.
The parent ShaderClass class being mixed.
A Shader/Filter subclass mixed with BaseShaderMixin features.
A mixin which decorates a PIXI.Filter or PIXI.Shader with common properties.
The parent ShaderClass class being mixed.
A Shader/Filter subclass mixed with BaseShaderMixin features.
A mixin wich decorates a shader or filter and construct a fragment shader according to a choosen channel.
The parent ShaderClass class being mixed.
A Shader/Filter subclass mixed with AdaptiveFragmentChannelMixin.
A mixin wich decorates a shader or filter and construct a fragment shader according to a choosen channel.
The parent ShaderClass class being mixed.
A Shader/Filter subclass mixed with AdaptiveFragmentChannelMixin.
Export data content to be saved to a local file
Data content converted to a string
The type of
The filename of the resulting download
Read text data from a user provided File object
A File object
A Promise which resolves to the loaded text data
Retrieve a Document by its Universally Unique Identifier (uuid).
The uuid of the Document to retrieve.
Returns the Document if it could be found, otherwise null.
Retrieve a Document by its Universally Unique Identifier (uuid) synchronously. If the uuid resolves to a compendium document, that document's index entry will be returned instead.
The uuid of the Document to retrieve.
The Document or its index entry if it resides in a Compendium, otherwise null.
Return a reference to the Document class implementation which is configured for use.
The canonical Document name, for example "Actor"
The configured Document class implementation
Get a template from the server by fetch request and caching the retrieved result
The web-accessible HTML template URL
A Promise which resolves to the compiled Handlebars template
Load and cache a set of templates by providing an Array of paths
An array of template file paths to load, or an object of Handlebars partial IDs to paths.
Get and render a template using provided data and handle the returned HTML Support asynchronous file template file loading with a client-side caching layer
Allow resolution of prototype methods and properties since this all occurs within the safety of the client.
The file path to the target HTML template
A data object against which to compile the template
Returns the compiled and rendered template as a string
Test whether a file source exists by performing a HEAD request against it
The source URL or path to test
Does the file exist at the provided url?
Get a single texture or sprite sheet from the cache.
The texture path to load.
A texture, a sprite sheet or null if not found in cache.
Load a single asset and return a Promise which resolves once the asset is ready to use
The requested asset source
Additional options which modify asset loading
The loaded Texture or sprite sheet, or null if loading failed with no fallback
Augment any PIXI.DisplayObject to assume bounds that are always aligned with the full visible screen. The bounds of this container do not depend on its children but always fill the entire canvas.
Any PIXI DisplayObject subclass
The decorated subclass with full canvas bounds
Add RenderFlags functionality to some other object. This mixin standardizes the interface for such functionality.
The base class being mixed
The mixed class definition
Augment an Application instance with functionality that supports rendering as a directory of foldered entries.
The base Application class definition
The decorated DirectoryApplication class definition
Resolve a series of embedded document UUID parts against a parent Document.
The parent Document.
A series of Embedded Document UUID parts.
Additional options to configure Embedded Document resolution.
The resolved Embedded Document.
The string prefix used to prepend console logging
The singleton Game instance
A mapping of allowed package types and the classes which implement them.
A namespace containing the user interface applications which are defined throughout the Foundry VTT ecosystem.
Runtime configuration settings for Foundry VTT which exposes a large number of variables which determine how aspects of the software behaves.
Unlike the CONST analog which is frozen and immutable, the CONFIG object may be updated during the course of a session or modified by system and module developers to adjust how the application behaves.
A client-side mixin used for all Package types.