@turbowarp/types-tw
    Preparing search index...

    Interface FontManager

    interface FontManager {
        fonts: {
            asset?: Asset;
            fallback: string;
            family: string;
            system: boolean;
        }[];
        restrictedFonts: Set<string>;
        runtime: Runtime;
        addCustomFont(family: string, fallback: string, asset: Asset): void;
        addListener<K extends "change">(
            event: K,
            callback: EventEmitterCallback<FontManagerEvents, K>,
        ): void;
        addSystemFont(family: string, fallback: string): void;
        changed(): void;
        clear(): void;
        deleteFont(index: number): void;
        deserialize(
            json: unknown,
            zip?: JSZip,
            keepExisting?: boolean,
        ): Promise<void>;
        emit<K extends "change">(
            event: K,
            ...args: EventEmitterArgs<FontManagerEvents, K>,
        ): void;
        getFonts(): {
            data: Uint8Array<ArrayBuffer>
            | null;
            family: string;
            format: string | null;
            name: string;
            system: boolean;
        }[];
        getUnusedCustomFont(family: string): string;
        getUnusedSystemFont(family: string): string;
        hasFont(family: string): boolean;
        isValidCustomFont(family: string): boolean;
        isValidFamily(family: string): boolean;
        isValidSystemFont(family: string): boolean;
        listeners<K extends "change">(
            event: K,
        ): EventEmitterCallback<FontManagerEvents, K>[];
        off<K extends "change">(
            event: K,
            callback: EventEmitterCallback<FontManagerEvents, K>,
        ): void;
        on<K extends "change">(
            event: K,
            callback: EventEmitterCallback<FontManagerEvents, K>,
        ): void;
        once<K extends "change">(
            event: K,
            callback: EventEmitterCallback<FontManagerEvents, K>,
        ): void;
        removeListener<K extends "change">(
            event: K,
            callback: EventEmitterCallback<FontManagerEvents, K>,
        ): void;
        restrictFont(font: string): void;
        serializeAssets(): Asset[];
        serializeJSON(): unknown;
        updateRenderer(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    fonts restrictedFonts runtime

    Methods

    addCustomFont addListener addSystemFont changed clear deleteFont deserialize emit getFonts getUnusedCustomFont getUnusedSystemFont hasFont isValidCustomFont isValidFamily isValidSystemFont listeners off on once removeListener restrictFont serializeAssets serializeJSON updateRenderer

    Properties

    fonts: { asset?: Asset; fallback: string; family: string; system: boolean }[]
    restrictedFonts: Set<string>
    runtime: Runtime

    Methods

    • Parameters

      • family: string
      • fallback: string

      Returns void

    • Parameters

      • json: unknown
      • Optionalzip: JSZip
      • OptionalkeepExisting: boolean

      Returns Promise<void>

    • Returns {
          data: Uint8Array<ArrayBuffer> | null;
          family: string;
          format: string | null;
          name: string;
          system: boolean;
      }[]

    • Parameters

      • family: string

      Returns boolean

      use isValidSystemFont or isValidCustomFont instead

    • Prevents a family from being overridden by a custom font. The project may still use it as a system font.

      Parameters

      • font: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods