55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
A label is for adding simple 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.
|
|
|
|
The fontsize feature is calculated by bigfonts, a library made by Wojbie (http://www.computercraft.info/forums2/index.php?/topic/25367-bigfont-api-write-bigger-letters-v10/)
|
|
|
|
Here are all possible functions available for labels.<br>
|
|
Remember Label inherits from [Object](objects/Object.md)
|
|
|
|
## setText
|
|
Sets the text which gets displayed.
|
|
|
|
#### Parameters:
|
|
1. `string` The text which should be displayed
|
|
|
|
#### Returns:
|
|
1. `object` The object in use
|
|
|
|
#### Usage:
|
|
* Creates a default label with text "Some random text".
|
|
```lua
|
|
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
|
local aLabel = mainFrame:addLabel("myFirstLabel"):setText("Some random text"):show()
|
|
```
|
|
|
|
## setFontSize
|
|
Sets the font size, calculated by bigfonts. Default size is 1.
|
|
|
|
#### Parameters:
|
|
1. `number` The size (1, 2, 3, 4)
|
|
|
|
#### Returns:
|
|
1. `object` The object in use
|
|
|
|
#### Usage:
|
|
* Creates a default label, sets the text to "Basalt!" and its font size to 2.
|
|
```lua
|
|
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
|
local aLabel = mainFrame:addLabel("myFirstLabel"):setText("Basalt!"):setFontSize(2):show()
|
|
```
|
|
|
|
## getFontSize
|
|
Returns the current font size
|
|
|
|
#### Returns:
|
|
1. `number` font size
|
|
|
|
#### Usage:
|
|
* Creates a default label, sets the text to "Basalt!" and its font size to 2. Also prints the current fontsize.
|
|
```lua
|
|
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
|
local aLabel = mainFrame:addLabel("myFirstLabel"):setText("Basalt!"):setFontSize(2):show()
|
|
basalt.debug(aLabel:getFontSize())
|
|
```
|