Class FontManager

Loads FVTT core fonts supporting FontConfig on 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.

Index
constructor
getCoreDefinitions loadFonts removeDuplicateDefinitions

  • Collect all the font definitions and combine them.

    Returns { [key: string]: FamilyDefinition }[]

    Core font definitions.

  • 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]: FamilyDefinition }[]
              | { [key: string]: FamilyDefinition };
          ms?: number;
      }

      Optional parameters.

      • Optionaldocument?: Document

        The target document to load the fonts into.

      • Optionaleditor?: boolean

        When true verifies the editor field of FontFamilyDefinition.

      • Optionalfonts?: { [key: string]: FamilyDefinition }[] | { [key: string]: FamilyDefinition }

        A custom set of font family definitions to load. If not defined the core font family definitions are loaded.

      • Optionalms?: number

        The maximum time to spend loading fonts before proceeding.

    Returns Promise<void>

  • Removes duplicate font definitions.

    Parameters

    • fonts: { [key: string]: FamilyDefinition }[]

      An array of FontFamilyDefinition objects to process.

    Returns { [key: string]: FamilyDefinition }[]

    Filtered font definitions.

Settings
Member Visibility

On This Page
Constructors
Methods