docs: update documentation [skip ci] 4ed14fc007

This commit is contained in:
NoryiE
2025-02-09 18:00:32 +00:00
commit 97c9014b32
4 changed files with 53 additions and 0 deletions

0
.nojekyll Normal file
View File

1
README.md Normal file
View File

@@ -0,0 +1 @@
Basalt v2 Dev

51
basalt.md Normal file
View File

@@ -0,0 +1,51 @@
## The main Basalt instance
Contains all core functionality and management functions
### basalt:create (type, id)
Creates and returns a new UI element of the specified type
### basalt:createFrame ()
Creates and returns a new frame
### basalt:getElementManager ()
Returns the element manager instance
### basalt:getMainFrame ()
Gets or creates the main frame
### basalt:setActiveFrame (frame)
Sets the active frame
### basalt:scheduleUpdate (func)
Schedules a function to be updated
### basalt:removeSchedule (id)
Removes a scheduled update
### basalt.updateEvent (event, ...)
Internal event handler
### basalt.renderFrames ()
Internal render function
### basalt:update ()
Updates all scheduled functions
### basalt:stop ()
Stops the Basalt runtime
### basalt:run (isActive)
Starts the Basalt runtime

1
manual.md Normal file
View File

@@ -0,0 +1 @@
Comming soon