diff --git a/docs/objects/Basalt.md b/docs/objects/Basalt.md index a213f87..62cc966 100644 --- a/docs/objects/Basalt.md +++ b/docs/objects/Basalt.md @@ -9,70 +9,103 @@ remember you need the basalt.lua file on your computer! Now you are able to call all these functions: ## basalt.createFrame -create a frame without a parent +Create a frame without a parent +#### Parameters: +1. `string` name +#### Returns: +1. `frame` object +#### Usage: +* Create and show a frame with id "myFirstFrame" ````lua local mainFrame = basalt.createFrame("myFirstFrame"):show() ```` -**parameters:** string name
-**returns:** new frame object
## basalt.removeFrame -removes a frame (only possible for non-parent frames) +Removes a frame (only possible for non-parent frames) +#### Parameters: +1. `string` name +#### Usage: +* Removes the previously created frame with id "myFirstFrame" ````lua local mainFrame = basalt.createFrame("myFirstFrame"):show() basalt.removeFrame("myFirstFrame") ```` -**parameters:** string name
-**returns:**-
## basalt.getFrame With that function you can get frames, but only frames without a parent! +#### Parameters: +1. `string` name +#### Returns: +1. `frame` object +#### Usage: +* Creates, fetches and shows the "myFirstFrame" object ````lua basalt.createFrame("myFirstFrame") basalt.getFrame("myFirstFrame"):show() ```` -**parameters:** string name
-**returns:** frame object
+ ## basalt.getActiveFrame -returns the currently active (without a parent) frame +Returns the currently active (without a parent) frame +#### Returns: +1. `frame` The current frame +#### Usage: +* Displays the active frame name in the debug console ````lua basalt.createFrame("myFirstFrame"):show() basalt.debug(basalt.getActiveFrame():getName()) -- returns myFirstFrame ```` -**parameters:** -
-**returns:** frame object
## basalt.autoUpdate -starts the draw and event handler until you use basalt.stopUpdate +Starts the draw and event handler until basalt.stopUpdate() is called +#### Usage: +* Enable the basalt updates, otherwise the screen will not continue to update ````lua local mainFrame = basalt.createFrame("myFirstFrame"):show() basalt.autoUpdate() ```` -**parameters:** -
-**returns:**-
+ ## basalt.update -calls the draw and event handler method once +Calls the draw and event handler method once +#### Parameters: +1. `string` The event to be received +2. `...` Additional event variables to capture +#### Usage: +* Prints "Left Mouse Button clicked!" when clicked ````lua -local mainFrame = basalt.createFrame("myFirstFrame"):show() -basalt.autoUpdate() +quitButton:onClick( + function(obj, event, x, y) + if(event == "mouse_click") and (button == 1) then --> The button at index 1 is left + basalt.debug("Left Mouse Button clicked!") + end + end +) ```` -**parameters:** string event, ... (you can use some paramters here. you dont have to pass any paramters )
-**returns:**-
## basalt.stopUpdate -stops the draw and event handler +Stops the draw and event handler _(including, but not limited to mouse clicks)_ +#### Usage: +* When the quit button is clicked, the button stops basalt updates and clears the terminal ````lua -basalt.stopUpdate() +quitButton:onClick( + function(obj, event) + if (event == "mouse_click") and (obj == quitButton) then --> The button at index 1 is left + basalt.stopUpdate() + term.clear() + end + end +) ```` -**parameters:** -
-**returns:**-
+ ## basalt.debug creates a label with some information on the main frame on the bottom left, if you click on that label it will open a log view for you see it as the new print for debugging +#### Parameters: +1. `...` (multiple parameters are possible, like print does)
+#### Usage: +* Prints "Hello! ^-^" to the debug console ````lua -basalt.debug("Hi i am cute") +basalt.debug("Hello! ^-^") ```` -**parameters:** ... (multiple parameters are possible, like print does)
-**returns:**-
+