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.

Constructors

constructor

Methods

getCoreDefinitions loadFonts removeDuplicateDefinitions

Constructors

constructor

Methods

StaticgetCoreDefinitions

  • getCoreDefinitions(): { [key: string]: object }[]

  • Collect all the font definitions and combine them.

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

    Core font definitions.

StaticloadFonts

  • loadFonts(
        opts?: {
            document?: Document;
            editor?: boolean;
            fonts?: { [key: string]: object } | { [key: string]: object }[];
            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]: object } | { [key: string]: object }[];
          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]: object } | { [key: string]: object }[]

        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>

StaticremoveDuplicateDefinitions

  • removeDuplicateDefinitions(
        fonts: { [key: string]: object }[],
    ): { [key: string]: object }[]

  • Removes duplicate font definitions.

    Parameters

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

      An array of FontFamilyDefinition objects to process.

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

    Filtered font definitions.

Settings

Member Visibility

On This Page

Constructors
Methods