Lua Script API: Custom Text

Text Functions

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

Initializes the creation of a text object. This will not add the text object immediately into the game yet.

• tag - The unique tag name for the text object to inherit for later use.
• text - An optional parameter, The given text content for the text object to display inside the game.
• width - An optional parameter, the specified text-box width to be set in; Default value: 0.
• x - An optional parameter, the specified x-position value of the text object to be set at; Default value: 0.
• y - An optional parameter, the specified y-position value of the text object to be set at; Default value: 0.

addLuaText(tag:String):Void

Adds the given text object into the game. Once a text object has been added it will overlap the previous added object. Causing the recently added object to be placed in front of every object in the game.

• tag - The given text object name tag to add within the game.

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

Removes the given text object from the game.

• tag - The given text object name tag to remove from the game.
• destroy - An optional parameter, whether the given text object will be permanently removed or not; Default value: true.

---

Text Property Functions

Setters

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

Sets the given text object's string content with a new content. Returns true, if it works properly.

• tag - The given text object name tag to set a new content.
• text - The new string content to set to.

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

Sets the given text object's size with a new size value.

• tag - The given text object name tag to set a new size. Returns true, if it works properly.
• size - The new size value to set to.

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

Sets the given text object's auto-sizing, it determines the width and height by its text content size.

• tag - The given text object name tag to enable auto-sizing or not.
• autoSize - Whether to enable auto-sizing or not.

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

Sets the given text object's text-box width with a new text-box width value. Returns true, if it works properly.

• tag - The given text object name tag to set a new text-box width.
• width - The new text-box width value to set to.

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

Sets the given text object's text-box height with a new text-box height value. Returns true, if it works properly.

• tag - The given text object name tag to set a new text-box height.
• height - The new text-box height value to set to.

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

Sets the given text object's border size, color, and style with a new value.

• tag - The given text object name tag to set a new border properties. Returns true, if it works properly.
• size - The new border size to set to.
• color - The new border color to set to.
• style - An optional parameter, The new border style to set to; Default value: outline.

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

Sets the given text object's text color with a new color value. Returns true, if it works properly.

• tag - The given text object name tag to set a new color value to.
• color - The new color value to set to.

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

Sets the given text object's text alignment with a new alignment. Returns true, if it works properly.

• tag - The given text object name tag to set a new alignment to.
• alignment - An optional parameter, the new alignment to set to; Default value: left.

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

Sets the given text object's font with a new font. Returns true, if it works properly.

• tag - The given text object name tag to set a new font to.
• newFont - The new font to set to; starts within the fonts folder directory.

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

Sets the given text object's into a italic type. Returns true, if it works properly.

• tag - The given text object name tag to enable italic type or not.
• italic - Whether to enable italic type or not.

Getters

getTextString(tag:String):String

Gets the given text object's current string content value.

• tag - The given text object name tag to get the current string content from.

getTextSize(tag:String):Float

Gets the given text object's current size value.

• tag - The given text object name tag to get the current size value from.

getTextWidth(tag:String):Float

Gets the given text object's current text-box width value.

• tag - The given text object name tag to get the current text-box width from.

getTextFont(tag:String):String

Gets the given text object's current font.

• tag - The given text object name tag to get the current font from.

---

See Also

• Custom Sprite
• Object Functions
• Reflection Functions