FontSource

An interface describing loadable resources in Excalibur. Built-in loadable resources include Texture, Sound, and a generic Resource.

Implements

• Loadable<FontFace>

Index

Constructors

• constructor

Properties

• data
• family
• path

Methods

• isLoaded
• load
• toFont

Constructors

constructor

• new FontSource(path: string, family: string, __namedParameters?: FontSourceOptions): FontSource

• Parameters

  • path: string

    Path to the font resource relative from the HTML document hosting the game, or absolute

  • family: string

    The font family name

  • __namedParameters: FontSourceOptions = {}

  Returns FontSource

Properties

data

data: FontFace

Implementation of Loadable.data

Data associated with a loadable

publicreadonlyfamily

family: string

The font family name

publicreadonlypath

path: string

Path to the font resource relative from the HTML document hosting the game, or absolute

Methods

isLoaded

• isLoaded(): boolean

• Implementation of Loadable.isLoaded

  Returns true if the loadable is loaded

  ---

  Returns boolean

load

• load(): Promise<FontFace>

• Implementation of Loadable.load

  Begins loading the resource and returns a promise to be resolved on completion

  ---

  Returns Promise<FontFace>

toFont

• toFont(options?: FontOptions & GraphicOptions & RasterOptions): Font

• Build a font from this FontSource.

  ---

  Parameters

  • optionaloptions: FontOptions & GraphicOptions & RasterOptions

    {FontOptions} Override the font options

  Returns Font