Module basalt
-
Basalt UI Framework main module
-
-
-
+
Basalt UI Framework main module.
+
This is the main entry point for the Basalt UI Framework.
+ It provides functions for creating and managing UI elements and handling events.
+
See also:
+
+
Usage:
+
local basalt = require("basalt")
+local mainFrame = basalt.createFrame()
+mainFrame:show()
+basalt.run()
+
+
Info:
- Copyright: 2025
+ - Release: 2.0
- License: MIT
- Author: NyoriE
@@ -60,7 +71,8 @@
| basalt:create(type[, id]) |
- Creates a new UI element |
+ Creates a new UI element
+ Creates and returns a new UI element of the specified type |
| basalt:createFrame() |
@@ -108,6 +120,7 @@
The main Basalt instance
+ Contains all core functionality and management functions
-
@@ -116,19 +129,16 @@
-
Creates a new UI element
+ Creates and returns a new UI element of the specified type
-
-
-
-
Parameters:
- type
- string The type of element to create (e.g. "BaseFrame")
+ string The type of element to create (e.g. "Button", "Label", "BaseFrame")
- id
- string Optional ID for the element
+ string Optional unique identifier for the element
(optional)
@@ -136,14 +146,19 @@
Returns:
- table The created element instance
+ table
+ The created element instance
+ See also:
+
Usage:
local button = basalt.create("Button", "myButton")
+ local button = basalt.create("Button", "myButton")
+button:setPosition(5, 5)
@@ -154,10 +169,6 @@
-
Creates and returns a new frame
-
-
-
-
Returns:
@@ -181,10 +192,6 @@
-
Returns the element manager instance
-
-
-
-
Returns:
@@ -208,10 +215,6 @@
-
Gets or creates the main frame
-
-
-
-
Returns:
@@ -235,10 +238,6 @@
-
Removes a scheduled update
-
-
-
-
Parameters:
@@ -263,10 +262,6 @@
-
Starts the Basalt runtime
-
-
-
-
Parameters:
@@ -293,10 +288,6 @@
-
Schedules a function to be updated
-
-
-
-
Parameters:
@@ -326,10 +317,6 @@
-
Sets the active frame
-
-
-
-
Parameters:
@@ -359,10 +346,6 @@
-
Stops the Basalt runtime
-
-
-
-
@@ -381,10 +364,6 @@
-
Updates all scheduled functions
-
-
-
-
@@ -403,7 +382,7 @@
generated by LDoc 1.5.0
-
Last updated 2025-02-09 15:18:44
+
Last updated 2025-02-09 15:27:10