FontsModule

The FontsModule class is used for working with custom fonts in effects.

Example

//==============================================================================
// The following example demonstrates how to access a font in the Assets and
// assign it to a text object.
//
// Project setup:
// - Insert text
// - Add the Custom Fonts capability
//==============================================================================

// Load in the required modules
const Fonts = require('Fonts');
const Scene = require('Scene');

// Locate the font in the Assets and the text in the Scene
const font = Fonts.get('customFont.ttf');
const text = Scene.root.find('text0');

// Set the font of the text
text.font = font;

Properties

This module exposes no properties.

Methods

MethodDescription

get

get(fontName: string): FontId

Returns a font object identified by the fontName argument.

Throws an exception if there is no such font in the project.

Classes

ClassDescription

FontId

The FontsId class identifies a font in an effect.