This is the UI Manager and the starting point for your project. The following functions allow you to influence the default behavior of Basalt.
Before you can access Basalt, you need to add the following code on top of your file:
local basalt = require("basalt")What this code does is it loads basalt into the project, and you can access it by using the variable defined as "basalt".
Here is a list with all available methods for basalt.
| Method | Returns | Description |
|---|---|---|
| basalt.run | - | Starts the event/draw system. |
| basalt.stop | - | Stops the event/draw system. |
| basalt.getMainFrame | BaseFrame | Returns or creates a BaseFrame. |
| basalt.addFrame | BaseFrame | Creates a new BaseFrame. |
| basalt.removeFrame | boolean | Removes a frame. |
| basalt.switchFrame | - | Switches to a new BaseFrame. |
| basalt.setFocusedFrame | - | Changes the focus between frames. |
| basalt.addMonitor | Monitor | Creates a new Monitor frame. |
| basalt.addBigMonitor | BigMonitor | Creates a new BigMonitor frame. |
| basalt.removeMonitor | boolean | Removes a monitor. |
| basalt.isKeyDown | boolean | Returns if a certain key is currently held down. |
| basalt.isMouseDown | boolean | Returns if a certain mouse button is currently held down. |
| basalt.onEvent | - | Adds a new event listener to basalt. |
| basalt.removeEvent | - | Removes a event from basalts event listener. |
| basalt.thread | Thread | Adds a new thread (coroutine) to basalt. |
| basalt.getElements | table | Returns a list of available elements. |
| basalt.getTerm | term | Returns the term used by basalt. |
| basalt.errorHandler | - | Handles all incoming errors. |
| basalt.create | object | Can create a new element. |
basalt.run starts the event and draw handler. The listeners will run until you stop them.
boolean? - if you use false as the first parameter it would stop the listeners. Using false is a synonym for basalt.stop().local basalt = require("basalt")
local main = basalt.getMainFrame()
main:addButton():onClick(function()
basalt.run(false) -- Stops the event and draw listeners
end)
basalt.run() -- Start the event and draw listenersThis method stops the automatic draw and event handler that was started by basalt.run(). basalt.run(false) achieves the same result
local basalt = require("basalt")
local main = basalt.getMainFrame()
main:addButton():onClick(function()
basalt.stop() -- Stops the event and draw listeners
end)
basalt.run() -- Start the event and draw listenersReturns the current main frame, if there's no main frame it creates a new one
BaseFramelocal basalt = require("basalt")
local main = basalt.getMainFrame()
basalt.run()Creates a new base frame, which is essentially a frame without a parent. You can have as many base frames as you want, but only one can be active (visible) at a 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).
string? id - if you don’t set an ID, it will automatically create a UUID for youBaseFramelocal main1 = basalt.addFrame() -- Visible base frame on program start
local main2 = basalt.addFrame()
local main3 = basalt.addFrame()
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.run()Removes the given frame from basalts listeners. This will ignore the BaseFrame in every way.
string|BaseFrame id or the object itselfboolean if the frame got successfully removedlocal main = basalt.addFrame()
main:addButton()
:onClick(function()
basalt.removeFrame(main)
end)
basalt.run()With basalt.switchFrame you are able to switch to a new BaseFrame.
string|BaseFrame The baseframe you want to switch to.local main = basalt.getMainFrame()
local second = basalt.addFrame()
second:addButton()
basalt.switchFrame(second)This will change the focus between frames. It is mostly useful in combination with monitors. Mouse/Touch events also changes the focus for you.
string|BaseFrame|Monitor|BigMonitor The frame you want to switch to.local main = basalt.getMainFrame()
local monitor = basalt.addMonitor()
main:addButton():onClick(function()
basalt.setFocusedFrame(monitor)
end)Creates a new monitor frame which can be used to display your UI onto a monitor.
string? id - if you don’t set an ID, it will automatically create a UUID for youMonitorlocal monitorFrame = basalt.addMonitor()
monitorFrame:addButton()
basalt.run()Creates a new big-monitor frame which can be used to display your UI onto a monitor.
string? id - if you don’t set an ID, it will automatically create a UUID for youBigMonitorlocal bigMonitorFrame = basalt.addBigMonitor()
bigMonitorFrame:addButton()
basalt.run()Removes the given monitor from basalts listeners.
string|Monitor|BigMonitor id or the object itselfboolean if the monitor got successfully removedlocal monitor = basalt.addMonitor()
monitor:addButton()
:onClick(function()
basalt.removeMonitor(monitor)
end)
basalt.run()This method returns if a certain key is currently held down. Please try to use the keys API. Here is a list: Computercraft Keys
number The key codebooleanbasalt.debug(basalt.isKeyDown(keys.leftCtrl))basalt.isMouseDown returns if a mouse button is held down. 1 = left button, 2 = right button, 3 = middle button
number the mouse buttonbooleanbasalt.debug(basalt.isMouseDown(1))basalt.onEvent is a core event listener, it doesn't matter which frame is active, this event listener receives all incoming events
function the function which gets called on any eventbasalt.onEvent(function(event, char)
if(event=="char")then
basalt.debug(char.."got pressed")
end
end)Removes the event from the event listener
function the function to removelocal function personalEventHandler(event)
basalt.debug(event)
end
basalt.onEvent(personalEventHandler)
main:addButton():onClick(function()
basalt.removeEvent(personalEventHandler)
end)The basalt.thread module offers a mechanism to handle concurrent tasks within the Basalt framework. By using threads, developers can execute non-blocking operations, ensuring the UI remains responsive.
function The function intended for the coroutineThread-- Create a new thread
basalt.thread(function()
while true do
basalt.debug("Hello World!")
sleep(1) -- pause execution for 1 second
end
end)
-- Start the Basalt event loop
basalt.run()Returns a list of all available elements.
tablefor _,elements in pairs(basalt.getElements())do
print(elements)
endThe main term, which gets defined once basalt gets required.
termlocal main = basalt.getMainFrame()
main:addButton():onClick(function()
basalt.debug(basalt.getTerm())
end)
basalt.run()This is basalt's default error handler. The reason this is public is, because you can overwrite it if you want. Just make sure to use basalt.stop() to stop basalt.
string The error message to showbasalt.errorHandler = function(errMsg)
basalt.stop()
term.clear()
term.setCursorPos(1,1)
term.setBackgroundColor(colors.red)
term.setTextColor(colors.black)
print(errMsg)
term.setTextColor(colors.white)This is used to create new elements.
string The id of the elementContainer? The error message to showtype The element type you want to createdefaultProperties? A table with default propertiesobject The elementlocal main = basalt.getMainFrame()
local button = basalt.create("RandomId", nil, "Button")
button:setParent(main)