This commit is contained in:
Robert Jelic
2025-02-09 17:56:44 +01:00
parent fb8844108e
commit 5afcae7633
2 changed files with 11 additions and 16 deletions

View File

@@ -4,7 +4,7 @@ description = "A Basalt UI Framework Documentation"
format = "markdown" format = "markdown"
dir = "docs" dir = "docs"
file = "src" file = "src"
style = "!dark.css" style = "!dark"
template = true template = true
sort = true sort = true
all = true all = true

View File

@@ -55,17 +55,15 @@ function basalt.createFrame()
end end
--- Returns the element manager instance --- Returns the element manager instance
-- @function getElementManager --- @return table ElementManager The element manager
-- @return table The element manager --- @usage local manager = basalt.getElementManager()
-- @usage local manager = basalt.getElementManager()
function basalt.getElementManager() function basalt.getElementManager()
return elementManager return elementManager
end end
--- Gets or creates the main frame --- Gets or creates the main frame
-- @function getMainFrame --- @return BaseFrame table The main frame instance
-- @return table The main frame instance --- @usage local frame = basalt.getMainFrame()
-- @usage local frame = basalt.getMainFrame()
function basalt.getMainFrame() function basalt.getMainFrame()
if(mainFrame == nil)then if(mainFrame == nil)then
mainFrame = basalt.createFrame() mainFrame = basalt.createFrame()
@@ -74,20 +72,17 @@ function basalt.getMainFrame()
end end
--- Sets the active frame --- Sets the active frame
-- @function setActiveFrame --- @param frame table The frame to set as active
-- @param frame table The frame to set as active --- @usage basalt.setActiveFrame(myFrame)
-- @return boolean Always returns false
-- @usage basalt.setActiveFrame(myFrame)
function basalt.setActiveFrame(frame) function basalt.setActiveFrame(frame)
mainFrame = frame mainFrame = frame
return false
end end
--- Schedules a function to be updated --- Schedules a function to be updated
-- @function scheduleUpdate --- @function scheduleUpdate
-- @param func function The function to schedule --- @param func function The function to schedule
-- @return number The schedule ID --- @return number The schedule ID
-- @usage local id = basalt.scheduleUpdate(myFunction) --- @usage local id = basalt.scheduleUpdate(myFunction)
function basalt.scheduleUpdate(func) function basalt.scheduleUpdate(func)
table.insert(basalt._schedule, func) table.insert(basalt._schedule, func)
return #basalt._schedule return #basalt._schedule