Docs 1.6

Accidentally uploaded outdated 1.6 docs

docs/docs1_6/objects/Basalt/autoUpdate.md

@@ -0,0 +1,18 @@
+# Basalt
+
+## autoUpdate
+
+This starts the event and draw handler for you. The listeners will run until you stop them.
+
+### Parameters
+
+1. `boolean` optional - if you use false as the first parameter it would stop the listeners. Using false is a synonym for [`basalt.stopUpdate()`](objects/Basalt/stopUpdate.md).
+
+### Usage
+
+* Enables the basalt listeners, otherwise the screen will not continue to update
+
+```lua
+local main = basalt.createFrame()
+basalt.autoUpdate()
+```

docs/docs1_6/objects/Basalt/createFrame.md

@@ -0,0 +1,35 @@
+# Basalt
+
+## createFrame
+
+Creates a new base-frame, you can have as many base-frames as you want, but only 1 can be active (visible) at the same time.
+You can always switch between your base frames.
+
+Only the currently active base-frame listens to incoming events (except for some events like time-events and peripheral-events)
+
+### Parameters
+
+1. `string` id - optional (if you dont set a id it will automatically create a uuid for you)
+
+### Returns
+
+1. `frame` object
+
+### Usage
+
+* How to use multiple base frames:
+
+```lua
+local main1 = basalt.createFrame() -- Visible base frame on program start
+local main2 = basalt.createFrame()
+local main3 = basalt.createFrame()
+main1:addButton()
+    :setPosition(2,2)
+    :setText("Switch")
+    :onClick(function()
+        main2:show() -- this function automatically "hides" the first one and shows the second one
+    end)
+main2:addLabel()
+    :setText("We are currently on main2")
+basalt.autoUpdate()
+```

docs/docs1_6/objects/Basalt/debug.md

@@ -0,0 +1,29 @@
+# Basalt
+
+## debug
+
+Creates a label with some information on the main frame on the bottom left. When you click on that label it will open a log view for you. See it as the new print for debugging
+
+You can also edit the default debug Label (change position, change color or whatever you want) by accessing the variable `basalt.debugLabel`
+which returns the debug Label.
+
+`basalt.debugFrame` and `basalt.debugList` are also available.
+
+### Parameters
+
+1. `...` (multiple parameters are possible, like print does)
+
+### Usage
+
+* Prints "Hello! ^-^" to the debug console
+
+```lua
+basalt.debug("Hello! ", "^-^")
+```
+
+* Changes the debug label's anchor
+
+```lua
+basalt.debugLabel:setAnchor("topLeft") -- default anchor is bottomLeft
+basalt.debug("Hello!")
+```

docs/docs1_6/objects/Basalt/getActiveFrame.md

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

docs/docs1_6/objects/Basalt/getFrame.md

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

docs/docs1_6/objects/Basalt/getTheme.md

@@ -0,0 +1,18 @@
+# Basalt
+
+## basalt.getTheme
+
+Returns the current base-theme. This base-theme can be set using setTheme.md.
+A list of base-theme keys can be found [here](https://github.com/Pyroxenium/Basalt/blob/master/Basalt/theme.lua).
+
+### Returns
+
+1. `number` The color of the requested base-theme key.
+
+### Usage
+
+* Displays the color of the main background in the debug console
+
+```lua
+basalt.debug(basalt.getTheme("BasaltBG"))
+```

docs/docs1_6/objects/Basalt/getVariable.md

@@ -0,0 +1,26 @@
+# Basalt
+
+## getVariable
+
+Returns a variable defined with [setVariable](objects/Basalt/setVariable)
+
+### Returns
+
+1. `variable` The variable stored
+
+### Usage
+
+* Displays the stored variable in the debug console
+
+```lua
+basalt.setVariable("abc", function()
+  basalt.debug("I got clicked")
+  return 1
+end)
+
+basalt.debug(basalt.getVariable("abc")()) -- Should debug log "I got clicked" and debug log 1 (which was returned from the function)
+```
+
+```xml
+<button onClick="abc" text="Click me" />
+```

docs/docs1_6/objects/Basalt/getVersion.md

@@ -0,0 +1,17 @@
+# Basalt
+
+## getVersion
+
+Returns the currently active/visible base frame.
+
+### Returns
+
+1. `string` The current version of Basalt
+
+### Usage
+
+* Displays the version of Basalt in the debug console
+
+```lua
+basalt.debug(basalt.getVersion()) -- Example: 1.6.2
+```

docs/docs1_6/objects/Basalt/isKeyDown.md

@@ -0,0 +1,28 @@
+# Basalt
+
+## isKeyDown
+
+Checks if the user is currently holding a key
+
+### Parameters
+
+1. `number` key code (use the [keys table](https://tweaked.cc/module/keys.html) for that)
+
+### Returns
+
+1. `boolean` true or false
+
+### Usage
+
+* Shows a debug message with true or false if the left ctrl key is down, as soon as you click on the button.
+
+```lua
+local main = basalt.createFrame()
+local aButton = mainFrame:addButton()
+    :setPosition(2,2)
+    :setText("Check Ctrl")
+    :onClick(function() 
+        basalt.debug(basalt.isKeyDown(keys.leftCtrl))
+    end)
+basalt.autoUpdate()
+```

docs/docs1_6/objects/Basalt/log.md

@@ -0,0 +1,28 @@
+# Basalt
+
+## log
+
+This writes something into a file. The main goal is to make debugging errors easier. Lets say you'r program is crashing and you don't know why, you could use basalt.log The log files will automatically removed after you start your program again.
+
+### Parameters
+
+1. `string` The text to write into the log file
+2. `string` - optional (default: "Debug") - the type to write
+
+### Usage
+
+* Writes "Hello!" into the log file
+
+```lua
+basalt.log("Hello!")
+```
+
+This should result in there beeing a file called `basaltLog.txt`. In the file it should say `[Basalt][Debug]: Hello!`.
+
+* Writes "Config file missing" into the log file, with warning as prefix.
+
+```lua
+basalt.log("Config file is missing", "WARNING")
+```
+
+This should result in there beeing a file called `basaltLog.txt`. In the file it should say `[Basalt][WARNING]: Config file is missing`.

docs/docs1_6/objects/Basalt/onEvent.md

@@ -0,0 +1,21 @@
+# Basalt
+
+## onEvent
+
+This is the top-level method to intercept an event before sending it to the object event handlers. If you use return false, the event is not passed to the event handlers.
+
+### Parameters
+
+1. `function` The function which should be called
+
+### Usage
+
+```lua
+local basalt = require("basalt")
+
+basalt.onEvent(function(event)
+    if(event=="terminate")then
+        return false
+    end
+end)
+```

docs/docs1_6/objects/Basalt/removeFrame.md

@@ -0,0 +1,37 @@
+# Basalt
+
+## removeFrame
+
+Removes the base frame by it's id. **This only works for base-frames.**
+
+### Parameters
+
+1. `string` id - ID of the base-frame.
+
+### Usage
+
+* Removes the previously created frame with id "secondBaseFrame"
+The frame id is gotten from a frame variable's `:getName()`
+
+```lua
+local main = basalt.createFrame("firstBaseFrame")
+local main2 = basalt.createFrame("secondBaseFrame")
+main:addButton()
+    :setText("Remove")
+    :onClick(function()
+        basalt.removeFrame(main2:getName())
+    end)
+```
+
+* Removes the previously created frame with id "secondBaseFrame", without frame stored in variable
+The frame id is the frame's name
+
+```lua
+local main = basalt.createFrame("firstBaseFrame")
+local main2 = basalt.createFrame("secondBaseFrame")
+main:addButton()
+    :setText("Remove")
+    :onClick(function()
+        basalt.removeFrame("secondBaseFrame")
+    end)
+```

docs/docs1_6/objects/Basalt/schedule.md

@@ -0,0 +1,36 @@
+# Basalt
+
+## schedule
+
+Schedules a function which gets called in a coroutine. After the coroutine is finished it will get destroyed immediatly. It's something like threads, but with some limits.
+**A guide can be found [here](/tips/logic).**
+
+### Parameters
+
+1. `function` a function which should get executed
+
+### Returns
+
+1. `function` it returns the function which you have to execute in order to start the coroutine
+
+### Usage
+
+* Creates a schedule which switches the color between red and gray
+
+```lua
+local mainFrame = basalt.createFrame()
+local aButton = mainFrame:addButton():setText("Click me")
+aButton:onClick(basalt.schedule(function(self)
+    self:setBackground(colors.red)
+    os.sleep(0.1)
+    self:setBackground(colors.gray)
+    os.sleep(0.1)
+    self:setBackground(colors.red)
+    os.sleep(0.1)
+    self:setBackground(colors.gray)
+    os.sleep(0.1)
+    self:setBackground(colors.red)
+    os.sleep(0.1)
+    self:setBackground(colors.gray)
+end))
+```

docs/docs1_6/objects/Basalt/setActiveFrame.md

@@ -0,0 +1,13 @@
+# Basalt
+
+## setActiveFrame
+
+Sets what should be the active baseframe.
+
+### Parameters
+
+1. `frame` frame - The frame that should be the active base-frame.
+
+### Usage
+
+TODO

docs/docs1_6/objects/Basalt/setMouseDragThrottle.md

@@ -0,0 +1,18 @@
+# Basalt
+
+## setMouseDragThrottle
+
+Changes the drag throttle of all drag events. Default value is 50ms - which is 0.05s.
+Instead of sending all mouse_drag events to the :onDrag handlers basalt sends every 0.05s (while dragging) the most recent drag event to all
+drag handlers. If you need all drag events - just change the value to 0.
+
+### Parameters
+
+1. `number` A number in miliseconds.
+
+### Usage
+
+```lua
+local basalt = require("basalt")
+basalt.setMouseDragThrottle(0)
+```

docs/docs1_6/objects/Basalt/setMouseMoveThrottle.md

@@ -0,0 +1,20 @@
+# Basalt
+
+## setMouseMoveThrottle
+
+This feature is only available for [CraftOS-PC](https://www.craftos-pc.cc).
+
+CraftOS-PC has a builtin mouse_move event, which is disabled by default. By using this method it will also enable the event for you. Remember - basalt does not disable the event after closing the program, which means the event stays active. If you want to disable the event please use config.set("mouse_move_throttle", -1) in your lua prompt or your program.
+
+Sidenote: a very low amount can make the program laggy - because it litterally spams the mouse_move event. So use it carefully.
+
+### Parameters
+
+1. `number` A number in miliseconds.
+
+### Usage
+
+```lua
+local basalt = require("basalt")
+basalt.setMouseMoveThrottle(50)
+```

docs/docs1_6/objects/Basalt/setTheme.md

@@ -0,0 +1,21 @@
+# Basalt
+
+## setTheme
+
+Sets the base theme of the project! Make sure to cover all existing objects, otherwise it will result in errors. A good example is [theme](https://github.com/Pyroxenium/Basalt/blob/master/Basalt/theme.lua). The theme can also be gotten with [`basalt.getTheme()`](objects/Basalt/getTheme)
+
+### Parameters
+
+1. `table` theme layout look into [theme](https://github.com/Pyroxenium/Basalt/blob/master/Basalt/theme.lua) for a example
+
+### Usage
+
+* Sets the default theme of basalt.
+
+```lua
+basalt.setTheme({
+    ButtonBG = colors.yellow,
+    ButtonText = colors.red,
+    ...,
+})
+```

docs/docs1_6/objects/Basalt/setVariable.md

@@ -0,0 +1,25 @@
+# Basalt
+
+## setVariable
+
+This stores a variable which you're able to access via xml. You are also able to add a function, which then gets called by object events created in XML.
+
+### Parameters
+
+1. `string` a key name
+2. `any` any variable
+
+### Usage
+
+* Adds a function to basalt.
+
+```lua
+basalt.setVariable("clickMe", function()
+    basalt.debug("I got clicked")
+end)
+
+```
+
+```xml
+<button onClick="clickMe" text="Click me" />
+```

docs/docs1_6/objects/Basalt/stopUpdate.md

@@ -0,0 +1,21 @@
+# Basalt
+
+## stopUpdate / stop
+
+Stops the automatic draw and event handler which got started by `basalt.autoUpdate()`.
+`basalt.autoUpdate(false)` also does the same.
+
+### Usage
+
+* When the quit button is clicked, the button stops basalt's event listeners and draw handlers
+
+```lua
+local main = basalt.createFrame()
+main:addButton()
+    :setPosition(2,2)
+    :setText("Stop Basalt!")
+    :onClick(function()
+        basalt.stopUpdate()
+    end)
+basalt.autoUpdate()
+```

docs/docs1_6/objects/Basalt/update.md

@@ -0,0 +1,24 @@
+# Basalt
+
+## update
+
+Calls the draw and event handler once - this gives more flexibility about which events basalt should process. For example you could filter the terminate event.
+Which means you have to pass the events into basalt.update.
+
+### Parameters
+
+1. `string` The event to be received
+2. `...` Additional event variables to capture
+
+### Usage
+
+* Creates and starts a custom update cycle
+
+```lua
+local mainFrame = basalt.createFrame()
+mainFrame:addButton():setPosition(2,2)
+while true do
+    local ev = table.pack(os.pullEventRaw())
+    basalt.update(table.unpack(ev))
+end
+```