Class FontManager
Index
Constructors
Methods
Constructors
constructor
- new FontManager(): FontManager
Returns FontManager
Methods
StaticgetCoreDefinitions
- getCoreDefinitions(): { [key: string]: FontFamilyDefinition }[]
Collect all the font definitions and combine them.
Returns { [key: string]: FontFamilyDefinition }[]
Core font definitions.
StaticloadFonts
- loadFonts(
opts?: {
document?: Document;
editor?: boolean;
fonts?:
| { [key: string]: FontFamilyDefinition }[]
| { [key: string]: FontFamilyDefinition };
ms?: number;
},
): Promise<void> Ensure that fonts have loaded and are ready for use. Enforce a maximum timeout in milliseconds. Proceed after that point even if fonts are not yet available.
Parameters
Optionalopts: {
document?: Document;
editor?: boolean;
fonts?:
| { [key: string]: FontFamilyDefinition }[]
| { [key: string]: FontFamilyDefinition };
ms?: number;
}Optional parameters.
Optionaldocument?: DocumentThe target document to load the fonts into.
Optionaleditor?: booleanWhen true verifies the
editorfield of FontFamilyDefinition.Optionalfonts?:
| { [key: string]: FontFamilyDefinition }[]
| { [key: string]: FontFamilyDefinition }A custom set of font family definitions to load. If not defined the core font family definitions are loaded.
Optionalms?: numberThe maximum time to spend loading fonts before proceeding.
Returns Promise<void>
StaticremoveDuplicateDefinitions
- removeDuplicateDefinitions(
fonts: { [key: string]: FontFamilyDefinition }[],
): { [key: string]: FontFamilyDefinition }[] Removes duplicate font definitions.
Parameters
- fonts: { [key: string]: FontFamilyDefinition }[]
An array of FontFamilyDefinition objects to process.
Returns { [key: string]: FontFamilyDefinition }[]
Filtered font definitions.
- fonts: { [key: string]: FontFamilyDefinition }[]
Loads FVTT core fonts supporting
FontConfigon Foundry v10+.Note: This class contains code modified from Foundry VTT core client code. There are only so many ways to process core Foundry data structures correctly.