GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity

Update Frame.md

Browse Source
This commit is contained in:
Robert Jelic
2022-05-30 23:17:31 +02:00
committed by GitHub
parent 1675b71c40
commit 4f5693a15b
1 changed files with 31 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/objects/Frame.md
View File

@@ -88,6 +88,36 @@ Toggles the frame's upper bar
local mainFrame = myFrame:setBar("Hello World!"):showBar()
````
## addMonitor
adds a monitor to the active main frame.
#### Parameters:
1. `string` The monitor name ("right", "left",... "monitor_1", "monitor_2",...)
#### Returns:
1. `frame` returns a frame which you can use like normal frames
#### Usage:
* Adds a monitor to the mainFrame. Only as long as this frame is also the active Frame, the monitor will be shown.
````lua
local mainFrame = basalt.createFrame("mainFrame"):show()
local monitor1 = mainFrame:addMonitor("right"):show()
monitor1:setBar("Monitor 1"):showBar()
````
## setMonitorScale
changes the monitor scale (almost the same as setTextScale())
#### Parameters:
1. `number` Possible values are: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 (1 is the same as 0.5 by setTextScale, and 10 is the same as 5)
#### Returns:
1. `monitor` The monitor being used
#### Usage:
* Changes the monitor scale to 2
````lua
local mainFrame = basalt.createFrame("mainFrame"):show()
local monitor1 = mainFrame:addMonitor("right"):setMonitorScale(2):show()
monitor1:setBar("Monitor 1"):showBar()
````
## ~~isModifierActive~~
### _Disabled, this function is a WIP_
Returns true if the user is currently holding the respective key down
@@ -224,4 +254,4 @@ local myFrame = basalt.createFrame("myFirstFrame"):setOffset(5, 3)
* Creates "myFirstFrame" with an x offset of 5 and a y offset of -5 (Meaning if you added a button with y position 5, it would be at y position 0)
````lua
local myFrame = basalt.createFrame("myFirstFrame"):setOffset(5, -5)
````
````