GitHub/Basalt2
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases 1 Wiki Activity

deploy: 3be4c1bc5d

Browse Source
This commit is contained in:
NoryiE
2025-03-10 02:21:03 +00:00
parent 0c010c6b59
commit 0dbb1cef3e
3 changed files with 63 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/references/elements/Container.md
View File

@@ -21,7 +21,7 @@ like Frames, BaseFrames, and more.
|Name|Properties|Description| |Name|Properties|Description|
|---|---|---| |---|---|---|
|offset|`offsetX offsetY`|Combined property for offsetX and offsetY| |offset|`offsetX number, offsetY number`|Combined property for offsetX and offsetY|
## Functions ## Functions

23
docs/references/main.md
View File

@@ -1,4 +1,4 @@
# Basalt # basalt
This is the UI Manager and the starting point for your project. The following functions allow you to influence the default behavior of Basalt. 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: Before you can access Basalt, you need to add the following code on top of your file:
@@ -18,6 +18,7 @@ What this code does is it loads basalt into the project, and you can access it b
|_events|`table`|A table of events and their callbacks| |_events|`table`|A table of events and their callbacks|
|_schedule|`function[]`|A table of scheduled functions| |_schedule|`function[]`|A table of scheduled functions|
|_plugins|`table`|A table of plugins| |_plugins|`table`|A table of plugins|
|isRunning|`boolean`|Whether the Basalt runtime is active|
|LOGGER|`Log`|The logger instance| |LOGGER|`Log`|The logger instance|
|path|`string`|The path to the Basalt library| |path|`string`|The path to the Basalt library|
@@ -26,8 +27,9 @@ What this code does is it loads basalt into the project, and you can access it b
|Method|Returns|Description| |Method|Returns|Description|
|---|---|---| |---|---|---|
|[basalt.create](#basalt.create)|table|Creates a new UI element |[basalt.create](#basalt.create)|table|Creates a new UI element
|[basalt.createFrame](#basalt.createFrame)|table|Creates a new BaseFrame |[basalt.createFrame](#basalt.createFrame)|BaseFrame|Creates a new BaseFrame
|[basalt.getAPI](#basalt.getAPI)|table|Returns a Plugin API |[basalt.getAPI](#basalt.getAPI)|table|Returns a Plugin API
|[basalt.getActiveFrame](#basalt.getActiveFrame)|BaseFrame?|Returns the active frame
|[basalt.getElementClass](#basalt.getElementClass)|table|Returns an element class |[basalt.getElementClass](#basalt.getElementClass)|table|Returns an element class
|[basalt.getElementManager](#basalt.getElementManager)|table|Returns the element manager |[basalt.getElementManager](#basalt.getElementManager)|table|Returns the element manager
|[basalt.getMainFrame](#basalt.getMainFrame)|BaseFrame|Gets or creates the main frame |[basalt.getMainFrame](#basalt.getMainFrame)|BaseFrame|Gets or creates the main frame
@@ -58,7 +60,7 @@ local button = basalt.create("Button")
Creates and returns a new BaseFrame Creates and returns a new BaseFrame
### Returns ### Returns
* `table` `BaseFrame` The created frame instance * `BaseFrame` `BaseFrame` The created frame instance
### Usage ### Usage
```lua ```lua
@@ -74,6 +76,17 @@ Returns a Plugin API
### Returns ### Returns
* `table` `Plugin` The plugin API * `table` `Plugin` The plugin API
## basalt.getActiveFrame()
Returns the active frame
### Returns
* `BaseFrame?` `BaseFrame` The frame to set as active
### Usage
```lua
local frame = basalt.getActiveFrame()
```
## basalt.getElementClass(name) ## basalt.getElementClass(name)
Returns an element's class without creating a instance Returns an element's class without creating a instance
@@ -98,7 +111,7 @@ local manager = basalt.getElementManager()
Gets or creates the main frame Gets or creates the main frame
### Returns ### Returns
* `BaseFrame` `table` The main frame instance * `BaseFrame` `BaseFrame` The main frame instance
### Usage ### Usage
```lua ```lua
@@ -149,7 +162,7 @@ local id = basalt.scheduleUpdate(myFunction)
Sets the active frame Sets the active frame
### Parameters ### Parameters
* `frame` `table` The frame to set as active * `frame` `BaseFrame` The frame to set as active
### Usage ### Usage
```lua ```lua

44
docs/references/plugins/benchmark_Container : VisualElement.md Normal file
View File

@@ -0,0 +1,44 @@
# Container : VisualElement
## Functions
|Method|Returns|Description|
|---|---|---|
|[Container:benchmarkContainer](#Container:benchmarkContainer)|Container|Recursively enables benchmarking
|[Container:logContainerBenchmarks](#Container:logContainerBenchmarks)|Container|Recursively logs benchmark statistics
|[Container:stopContainerBenchmark](#Container:stopContainerBenchmark)|Container|Recursively stops benchmarking
## Container:benchmarkContainer(methodName)
Enables benchmarking for a container and all its children
### Parameters
* `methodName` `string` The method to benchmark
### Returns
* `Container` `self` The container instance
### Usage
```lua
container:benchmarkContainer("render")
```
## Container:logContainerBenchmarks(methodName)
Logs benchmark statistics for a container and all its children
### Parameters
* `methodName` `string` The method to log
### Returns
* `Container` `self` The container instance
## Container:stopContainerBenchmark(methodName)
Stops benchmarking for a container and all its children
### Parameters
* `methodName` `string` The method to stop benchmarking
### Returns
* `Container` `self` The container instance