Class PixiBitmapFontManager

PixiBitmapFontManager loads fnt/xml files (using fetch), from the "bitmapFont" resources of the game.

It installs the "BitmapFont" with PixiJS to be used with PIXI.BitmapText.

Implements

ResourceManager

Index

Constructors

Methods

dispose getDefaultBitmapFont getResourceKinds loadResource obtainBitmapFont processResource releaseBitmapFont

Constructors

constructor

new PixiBitmapFontManager(resourceLoader, imageManager): PixiBitmapFontManager
Parameters
- resourceLoader: ResourceLoader
  The resources loader of the game.
- imageManager: PixiImageManager
  The image manager to be used to get textures used by fonts.
Returns PixiBitmapFontManager
- Defined in GDJS/Runtime/pixi-renderers/pixi-bitmapfont-manager.ts:66

Methods

dispose

dispose(): void
To be called when the game is disposed. Uninstall all the fonts from memory and clear cache of loaded fonts.

Returns void
Implementation of ResourceManager.dispose
- Defined in GDJS/Runtime/pixi-renderers/pixi-bitmapfont-manager.ts:297

getDefaultBitmapFont

getDefaultBitmapFont(): BitmapFont
Get the instance of the default Pixi.BitmapFont, always available.

Returns BitmapFont
- Defined in GDJS/Runtime/pixi-renderers/pixi-bitmapfont-manager.ts:81

getResourceKinds

getResourceKinds(): ResourceKind[]
Return the kind of resources handled by this manager.

Returns ResourceKind[]
Implementation of ResourceManager.getResourceKinds
- Defined in GDJS/Runtime/pixi-renderers/pixi-bitmapfont-manager.ts:74

loadResource

loadResource(resourceName): Promise<void>
Load the "bitmapFont" resources of the game, so that they are ready to be used when obtainBitmapFont is called.
Parameters
- resourceName: string
Returns Promise<void>
Implementation of ResourceManager.loadResource
- Defined in GDJS/Runtime/pixi-renderers/pixi-bitmapfont-manager.ts:255

obtainBitmapFont

obtainBitmapFont(bitmapFontResourceName, textureAtlasResourceName): BitmapFont
Given a bitmap font resource name and a texture atlas resource name, returns the PIXI.BitmapFont for it. The font is register and should be released with releaseBitmapFont - so that it can be removed from memory when unused.
Parameters
- bitmapFontResourceName: string
- textureAtlasResourceName: string
Returns BitmapFont
- Defined in GDJS/Runtime/pixi-renderers/pixi-bitmapfont-manager.ts:195

processResource

processResource(resourceName): Promise<void>
Process the specified resource.

This method will only be run while loading screen is shown. It can do heavy tasks like parsing data.
Parameters
- resourceName: string
Returns Promise<void>
Implementation of ResourceManager.processResource
- Defined in GDJS/Runtime/pixi-renderers/pixi-bitmapfont-manager.ts:247

releaseBitmapFont

releaseBitmapFont(bitmapFontInstallKey): void
When a font is not used by an object anymore (object destroyed or font changed), call this function to decrease the internal count of objects using the font.

When a font is not unused anymore, it goes in a temporary cache. The cache holds up to 10 fonts. If the cache reaches its maximum capacity, the oldest font is uninstalled from memory.
Parameters
- bitmapFontInstallKey: string
  Name of the font of the BitmapFont (bitmapFont.font)
Returns void
- Defined in GDJS/Runtime/pixi-renderers/pixi-bitmapfont-manager.ts:147