Basalt2/docs/references/elements/Label.md

Label

This is the label class. It provides a simple text display element that automatically resizes its width based on the text content.

Extends: VisualElement

Properties

Property	Type	Default	Description
text	string	Label	The text content to display. Can be a string or a function that returns a string
autoSize	boolean	true	Whether the label should automatically resize its width based on the text content

Functions

Method	Returns	Description
Label.new	Label	Creates a new Label instance
Label:init	Label	Initializes the Label instance
Label:getWrappedText	table	Gets the wrapped lines of the Label
Label:render	-	Renders the Label by drawing its text content

Label.new()

Creates a new Label instance

Returns

• Label self The newly created Label instance

Label:init(props, basalt)

Parameters

• props table The properties to initialize the element with
• basalt table The basalt instance

Returns

• Label self The initialized instance

Label:getWrappedText()

Gets the wrapped lines of the Label

Returns

• table wrappedText The wrapped lines of the Label

Label:render()