Files
Basalt/docs/objects/Label.md
2022-06-24 20:49:14 +02:00

36 lines
1.4 KiB
Markdown

With the Label object you are able to add some text.
By default label's width is auto sizing based on the length of the text. If you change the size with setSize it will automatically stop autosizing the width.
Here are all possible functions available for labels.<br>
Remember Label inherits from [Object](objects/Object.md)
## setText
sets the text which gets displayed.
```lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aInput = mainFrame:addLabel("myFirstLabel"):setText("Hello lovely basalt community!"):show()
```
#### Parameters: string text<br>
#### Returns: self<br>
## setFontSize
sets the font size of that text.
The font size is handled by bigfonts, if you're curious what bigfonts is, check out this page: http://www.computercraft.info/forums2/index.php?/topic/25367-bigfont-api-write-bigger-letters-v10/
```lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aInput = mainFrame:addLabel("myFirstLabel"):setText("Hello"):setFontSize(2):show()
```
#### Parameters: number size (1 = default, 2 = big, 3 = bigger, 4 = huge)<br>
#### Returns: self<br>
## getFontSize
returns the fontsize
```lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aInput = mainFrame:addLabel("myFirstLabel"):setText("Hello"):setFontSize(2):show()
basalt.debug(aInput:getFontSize()) -- returns 2
```
#### Parameters: <br>
#### Returns: number<br>