From 7082258a9e85a808e99d0155e4b4c70ac65db99a Mon Sep 17 00:00:00 2001 From: Robert Jelic <36573031+NoryiE@users.noreply.github.com> Date: Sun, 26 Jun 2022 19:49:04 +0200 Subject: [PATCH] Update Label.md --- docs/objects/Label.md | 49 ++++++++++++++++++++++++++++++------------- 1 file changed, 34 insertions(+), 15 deletions(-) diff --git a/docs/objects/Label.md b/docs/objects/Label.md index 228fa0c..17998e5 100644 --- a/docs/objects/Label.md +++ b/docs/objects/Label.md @@ -1,35 +1,54 @@ -With the Label object you are able to add some text. +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.
Remember Label inherits from [Object](objects/Object.md) ## setText -sets the text which gets displayed. +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 aInput = mainFrame:addLabel("myFirstLabel"):setText("Hello lovely basalt community!"):show() +local aLabel = mainFrame:addLabel("myFirstLabel"):setText("Some random text"):show() ``` -#### Parameters: string text
-#### Returns: self
## 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/ +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 aInput = mainFrame:addLabel("myFirstLabel"):setText("Hello"):setFontSize(2):show() +local aLabel = mainFrame:addLabel("myFirstLabel"):setText("Basalt!"):setFontSize(2):show() ``` -#### Parameters: number size (1 = default, 2 = big, 3 = bigger, 4 = huge)
-#### Returns: self
## getFontSize -returns the fontsize +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 aInput = mainFrame:addLabel("myFirstLabel"):setText("Hello"):setFontSize(2):show() -basalt.debug(aInput:getFontSize()) -- returns 2 +local aLabel = mainFrame:addLabel("myFirstLabel"):setText("Basalt!"):setFontSize(2):show() +basalt.debug(aLabel:getFontSize()) ``` -#### Parameters:
-#### Returns: number