From 72f2c527b903ab4c82dec1eba82ce691913b2ca4 Mon Sep 17 00:00:00 2001 From: Erb3 <49862976+Erb3@users.noreply.github.com> Date: Mon, 12 Sep 2022 20:51:58 +0200 Subject: [PATCH] Docs: basalt.get(Active)Frame --- docs/objects/Basalt/getActiveFrame.md | 15 ++++++++++----- docs/objects/Basalt/getFrame.md | 23 +++++++++++++++-------- 2 files changed, 25 insertions(+), 13 deletions(-) diff --git a/docs/objects/Basalt/getActiveFrame.md b/docs/objects/Basalt/getActiveFrame.md index 495e1d5..e778c7d 100644 --- a/docs/objects/Basalt/getActiveFrame.md +++ b/docs/objects/Basalt/getActiveFrame.md @@ -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 -``` \ No newline at end of file +``` diff --git a/docs/objects/Basalt/getFrame.md b/docs/objects/Basalt/getFrame.md index ad70e02..cf9b328 100644 --- a/docs/objects/Basalt/getFrame.md +++ b/docs/objects/Basalt/getFrame.md @@ -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) -``` \ No newline at end of file +basalt.autoUpdate() +```