commit 97c9014b32532f64af979e546e82332f40f952cb Author: NoryiE Date: Sun Feb 9 18:00:32 2025 +0000 docs: update documentation [skip ci] 4ed14fc00795c713ef0690f745440b8ffde34602 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md new file mode 100644 index 0000000..c92c316 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +Basalt v2 Dev diff --git a/basalt.md b/basalt.md new file mode 100644 index 0000000..d81bb34 --- /dev/null +++ b/basalt.md @@ -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 + diff --git a/manual.md b/manual.md new file mode 100644 index 0000000..15cd6ef --- /dev/null +++ b/manual.md @@ -0,0 +1 @@ +Comming soon \ No newline at end of file