Skip to content

Class "Font"⚓︎

Constructors⚓︎

Font ()⚓︎

Font Font ( )⚓︎

Constructor for the "Font" class.

Example Code

Example usage. 

1
2
3
local f = Font() -- init font object
f:Load("font/terminus.fnt") -- load a font into the font object
f:DrawString("Hello World!",60,50,KColor(1,1,1,1),0,true) -- render string with loaded font on position 60x50y

Functions⚓︎

Draw·String ()⚓︎

void DrawString ( string String, float PositionX, float PositionY, KColor RenderColor, u_int BoxWidth, boolean Center )⚓︎

Draws a string of text to the screen Converts UTF8 to UTF16, then draws the string. Notes: The BoxWidth and Center parameters can be used for aligning the text: If BoxWidth is zero, the text will be left aligned and the center parameter will be ignored If BoxWidth is NOT zero, and the Center parameter is FALSE, then the text will be right aligned inside the BoxWidth size If BoxWidth is NOT zero, and the center parameter is TRUE, then the text will be centered inside the BoxWidth size

Example Code

Example usage. 

1
2
3
local f = Font() -- init font object
f:Load("font/terminus.fnt") -- load a font into the font object
f:DrawString("Hello World!",60,50,KColor(1,1,1,1),0,true) -- render string with loaded font on position 60x50y

Draw·String·Scaled ()⚓︎

void DrawStringScaled ( string String, float PositionX, float PositionY, float ScaleX, float ScaleY, KColor RenderColor, u_int BoxWidth, boolean Center )⚓︎

Draws a scaled string of text on the screen. Converts UTF8 to UTF16, then draws the string.

Example Code

Example usage. 

1
2
3
local f = Font() -- init font object
f:Load("font/terminus.fnt") -- load a font into the font object
f:DrawStringScaled("Hello World!",60,50,0.5,0.5,KColor(1,1,1,1),0,true) -- render string with loaded font on position 60x50y

Draw·String·Scaled·UTF8 ()⚓︎

void DrawStringScaledUTF8 ( string String, float PositionX, float PositionY, float ScaleX, float ScaleY, KColor RenderColor, u_int BoxWidth, boolean Center )⚓︎

Draws a scaled string of Unicode text on the screen.

Example Code

Example usage. 

1
2
3
local f = Font() -- init font object
f:Load("font/terminus.fnt") -- load a font into the font object
f:DrawStringScaledUTF8("Hello World!",60,50,0.5,0.5,KColor(1,1,1,1),0,true) -- render string with loaded font on position 60x50y

Draw·String·UTF8 ()⚓︎

void DrawStringUTF8 ( string String, float PositionX, float PositionY, KColor RenderColor, u_int BoxWidth, boolean Center )⚓︎

Draws a string of Unicode text to the screen Notes: The BoxWidth and Center parameters can be used for aligning the text: If BoxWidth is zero, the text will be left aligned and the center parameter will be ignored If BoxWidth is NOT zero, and the Center parameter is FALSE, then the text will be right aligned inside the BoxWidth size If BoxWidth is NOT zero, and the center parameter is TRUE, then the text will be centered inside the BoxWidth size

Example Code

Example usage. 

1
2
3
local f = Font() -- init font object
f:Load("font/terminus.fnt") -- load a font into the font object
f:DrawStringUTF8("Hello World!",60,50,KColor(1,1,1,1),0,true) -- render string with loaded font on position 60x50y

Get·Baseline·Height ()⚓︎

u_int GetBaselineHeight ( )⚓︎

Get the number of pixels from the absolute top of the line to the base of the characters

Get·Character·Width ()⚓︎

u_int GetCharacterWidth ( char Character )⚓︎

Returns the width of a specific character

Get·Line·Height ()⚓︎

u_int GetLineHeight ( )⚓︎

Get the distance in pixels between each line of text

Get·String·Width ()⚓︎

u_int GetStringWidth ( string String )⚓︎

Converts UTF8 to UTF16 and returns string width

Get·String·Width·UTF8 ()⚓︎

u_int GetStringWidthUTF8 ( string String )⚓︎

returns string width of a Unicode text.

Is·Loaded ()⚓︎

boolean IsLoaded ( )⚓︎

Returns whether a font is loaded or not.

Load ()⚓︎

boolean Load ( string FilePath )⚓︎

Loads a font.

Example Code

Example usage. 

1
2
3
local f = Font() -- init font object
f:Load("font/terminus.fnt") -- load a font into the font object
f:DrawString("Hello World!",60,50,KColor(1,1,1,1),0,true) -- render string with loaded font on position 60x50y

Set·Missing·Character ()⚓︎

void SetMissingCharacter ( u16 MissingCharacter )⚓︎

Converts UTF8 to UTF16, then draws Sets the missing character to be used by the font (the character used when missing characters are encountered)

Unload ()⚓︎

void Unload ( )⚓︎

Unloads all our data from memory

Last update: June 9, 2021