Docs: basalt.get(Active)Frame

This commit is contained in:
Erb3
2022-09-12 20:51:58 +02:00
parent 77eeb1ce81
commit 72f2c527b9
2 changed files with 25 additions and 13 deletions

View File

@@ -1,12 +1,17 @@
## basalt.getActiveFrame
Returns the currently active/visible base frame
#### Returns:
# basalt.getActiveFrame
Returns the currently active/visible base frame.
## Returns
1. `frame` The current frame
#### Usage:
## Usage
* Displays the active frame name in the debug console
```lua
local main = basalt.createFrame()
basalt.debug(basalt.getActiveFrame():getName()) -- returns the id
```
```

View File

@@ -1,14 +1,20 @@
## basalt.getFrame
Returns a base frame by the given id
#### Parameters:
# basalt.getFrame
Returns a base frame by the given id.
## Parameters
1. `string` id
#### Returns:
1. `frame` object
## Returns
1. `frame` The frame with the supplied id.
## Usage
#### Usage:
* Creates, fetches and shows the "myFirstFrame" object
```lua
local main = basalt.createFrame("firstBaseFrame")
local main2 = basalt.createFrame("secondBaseFrame")
@@ -16,8 +22,9 @@ main:addButton()
:setText("Show")
:onClick(function()
local frame2 = basalt.getFrame("secondBaseFrame")
if(frame2~=nil)then
if(frame2 ~= nil)then
frame2:show()
end
end)
```
basalt.autoUpdate()
```