diff --git a/docs/objects/Basalt.md b/docs/objects/Basalt.md index 62cc966..67d30ad 100644 --- a/docs/objects/Basalt.md +++ b/docs/objects/Basalt.md @@ -12,8 +12,10 @@ Now you are able to call all these functions: Create a frame without a parent #### Parameters: 1. `string` name + #### Returns: 1. `frame` object + #### Usage: * Create and show a frame with id "myFirstFrame" ````lua @@ -22,8 +24,10 @@ local mainFrame = basalt.createFrame("myFirstFrame"):show() ## basalt.removeFrame Removes a frame (only possible for non-parent frames) + #### Parameters: 1. `string` name + #### Usage: * Removes the previously created frame with id "myFirstFrame" ````lua @@ -35,8 +39,10 @@ basalt.removeFrame("myFirstFrame") 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 @@ -47,8 +53,10 @@ basalt.getFrame("myFirstFrame"):show() ## basalt.getActiveFrame 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 @@ -58,6 +66,7 @@ basalt.debug(basalt.getActiveFrame():getName()) -- returns myFirstFrame ## basalt.autoUpdate 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 @@ -68,9 +77,11 @@ basalt.autoUpdate() ## basalt.update 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 @@ -85,6 +96,7 @@ quitButton:onClick( ## basalt.stopUpdate 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 @@ -101,8 +113,10 @@ quitButton:onClick( ## 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