font.create

Client

Creates a new font instance from a file path


Syntax

local instance = font.create(
    path
)

Parameters

TypeNameDescription
stringpathFile path to a supported font asset
Refer Formats section

Returns

TypeNameDescription
fontinstanceCreated font instance

Formats

FormatExtensionDescription
TrueType.ttfStandard scalable font format
OpenType.otfExtended scalable font format
Web Open Font.woffCompressed web font format
Web Open Font 2.woff2Modern compressed web font format

Examples

Create a font instance from a TTF file
local fnt = font.create("assets/font.ttf")
Create a font instance from an OTF file
local fnt = font.create("assets/font.otf")
Create a font instance from a WOFF2 file
local fnt = font.create("assets/font.woff2")

On this page