Text Functions

Functions to display text on screen.

makeLuaText

makeLuaText(tag:String, ?text:String = '', ?width:Int = 0, ?x:Float = 0, ?y:Float = 0):Void

Creates a Lua Text and store it as the name input in "tag".

tag - Lua Text nametag to save.
text (Optional) - Text to display.
width (Optional) - Set to zero to make it automatic, but will cause memory leaks if you change the text constantly, defaults to 0.
x (Optional) - Defaults to 0.
y (Optional) - Defaults to 0.

Examples:

makeLuaText('myText', 'This is a Test') - Create a simple text displaying "This is a Test".
makeLuaText('myText', 'Hello World!', 300, 400, 320)Creates a text displaying "Hello World!" with a defined width, X and Y.

Note: You will still have to add the Lua Text to the scene with addLuaText or it won't be visible.

addLuaText

addLuaText(tag:String):Void

Adds a previously created Lua Text to the top of the scene.

tag - Lua Text nametag.

Examples:

addLuaText('myText') - Adds to the scene a Lua Text created with makeLuaText('myText', 'This is a Test').

removeLuaText

removeLuaText(tag:String, ?destroy:Bool = true):Void

Removes a previously added Lua Text.

tag - Lua Text nametag.
destroy (Optional) - If enabled, clears the text object from memory once removed, do not disable unless you know what you're doing.

Examples:

removeLuaText('myText') - Removes a Lua Text created with makeLuaText('myText', 'This is a Test').

setTextString

setTextString(tag:String, text:String):Bool

Changes a Text's string.
Returns true if the operation was successful, throws an error if text object is missing and returns false.

tag - Text instance variable/Lua Text nametag.
text - Text to set.

Examples:

setTextString('myText', 'Goodbye World!') - Changes the Lua Text's text to "Goodbye World!".

setTextSize

setTextSize(tag:String, size:Int):Bool

Changes a Text's Font size.
Returns true if the operation was successful, throws an error if text object is missing and returns false.

tag - Text instance variable/Lua Text nametag.
size - New font size.

Examples:

setTextSize('myText', 32) - Make the text really big.
setTextSize('myText', 4) - Make the text really small.

setTextWidth

setTextWidth(tag:String, width:Float):Bool

Changes a Text's max width per line (in pixels).
Returns true if the operation was successful, throws an error if text object is missing and returns false.

tag - Text instance variable/Lua Text nametag.
size - New width, set to 0 to make it automatic.

Examples:

setTextWidth('myText', 150) - Make the text's max width be 150 pixels.

setTextHeight

setTextHeight(tag:String, height:Float):Bool

Changes a Text's max height (in pixels).
Returns true if the operation was successful, throws an error if text object is missing and returns false.

tag - Text instance variable/Lua Text nametag.
size - New height, set to 0 to make it automatic.

Examples:

setTextHeight('myText', 50) - Make the text's max height be 50 pixels.

setTextAutoSize

setTextAutoSize(tag:String, value:Bool):Bool

Changes a Text's Auto Size property.
Returns true if the operation was successful, throws an error if text object is missing and returns false.

tag - Text instance variable/Lua Text nametag.
value - Value to set it to.

Examples:

setTextAutoSize('myText', false) - Disable auto-size.

setTextBorder

setTextBorder(tag:String, size:Float, color:String, ?style:String = 'outline'):Bool

Changes a Text's Border properties.
Returns true if the operation was successful, throws an error if text object is missing and returns false.

tag - Text instance variable/Lua Text nametag.
size - Border thickness.
color - Color hexadecimal string or color name.
style (Optional) - Can be: "none", "outline", "outline_fast", "shadow".

Examples:

setTextBorder('myText', 3, 'black') - Sets a thick black outline to the text.
setTextBorder('myText', 1, 'FF0000', 'outline_fast') - Sets a Fast/Optimized thin red outline to the text.

setTextColor

setTextColor(tag:String, color:String):Bool

Changes a Text's color.
Returns true if the operation was successful, throws an error if text object is missing and returns false.

tag - Text instance variable/Lua Text nametag.
color - Color hexadecimal string or color name.

Examples:

setTextColor('myText', '7F7F7F') - Makes text gray.
setTextColor('myText', 'red') - Makes text red.

setTextFont

setTextFont(tag:String, font:String):Bool

Changes a Text's font.
Returns true if the operation was successful, throws an error if text object is missing and returns false.

tag - Text instance variable/Lua Text nametag.
font - Text font path.

Examples:

setTextFont('myText', 'comicSans.ttf') - Loads font from "mods/My-Mod/fonts/comicSans.ttf" into "myText" Lua Text.

setTextItalic

setTextItalic(tag:String, italic:Bool):Bool

Toggles Italic in a Text.
Returns true if the operation was successful, throws an error if text object is missing and returns false.

tag - Text instance variable/Lua Text nametag.
italic - Value to set it to.

Examples:

setTextItalic('myText', true) - Toggle on Italic in a Lua Text.

setTextAlignment

setTextAlignment(tag:String, ?alignment:String = 'left'):Bool

Changes a Text's Alignment.
Returns true if the operation was successful, throws an error if text object is missing and returns false.

tag - Text instance variable/Lua Text nametag.
alignment - Can be: "left", "right", "center", "justify". Defaults to "left".

Examples:

setTextAlignment('myText', 'center') - Makes a Lua Text centered.

getTextString

getTextString(tag:String):String

Returns the Text's string.
Throws an error if the text object is missing and returns null.

tag - Text instance variable/Lua Text nametag.

Examples:

getTextString('myText') - Returns the Text string from a Lua Text named "myText".

getTextSize

getTextSize(tag:String):Int

Returns the Text's font size.
Throws an error if the text object is missing and returns -1.

tag - Text instance variable/Lua Text nametag.

getTextFont

getTextFont(tag:String):String

Returns the Text's font path.
Throws an error if the text object is missing and returns null.

tag - Text instance variable/Lua Text nametag.

getTextWidth

getTextWidth(tag:String):Int

Returns the Text's max width.
Throws an error if the text object is missing and returns 0.

tag - Text instance variable/Lua Text nametag.

luaTextExists

luaTextExists(tag:String):Bool

Returns whether a Lua Text with a specific tag exists.

tag - Lua Text nametag.