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

docs fix

Browse Source
This commit is contained in:
Robert Jelic
2025-09-13 12:54:15 +02:00
parent 3504d8a3aa 8e64ba97bf
commit 9e1112f3bd
42 changed files with 1582 additions and 2507 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/references/elementManager.md
View File

@@ -1,30 +1,27 @@
# ElementManager
_This class manages elements and plugins. It loads elements and plugins from the elements and plugins directories
and then applies the plugins to the elements. It also provides a way to get elements and APIs._
This class manages elements and plugins. It loads elements and plugins from the elements and plugins directories
and then applies the plugins to the elements. It also provides a way to get elements and APIs.
## Functions
|Method|Returns|Description|
|---|---|---|
|[ElementManager.loadElement](#elementmanager-loadelement-name)|-|Loads an element by name. This will load the element and apply any plugins to it.|
|[ElementManager.getElement](#elementmanager-getelement-name)|table|Gets an element by name. If the element is not loaded, it will try to load it first.|
|[ElementManager.getElementList](#elementmanager-getelementlist)|table|Gets a list of all elements|
|[ElementManager.getAPI](#elementmanager-getapi-name)|table|Gets an Plugin API by name|
|[ElementManager.getAPI](#elementmanager-getapi)|table|
|[ElementManager.getElement](#elementmanager-getelement)|table|
|[ElementManager.getElementList](#elementmanager-getelementlist)|table|
|[ElementManager.loadElement](#elementmanager-loadelement)|-|
## ElementManager.loadElement(name)
Loads an element by name. This will load the element and apply any plugins to it.
## ElementManager.getAPI(name)
Gets an Plugin API by name
### Parameters
* `name` `string` The name of the element to load
* `name` `string` The name of the API to get
### Usage
```lua
ElementManager.loadElement("Button")
```
### Returns
* `table` `API` The API
## ElementManager.getElement(name)
Gets an element by name. If the element is not loaded, it will try to load it first.
### Parameters
@@ -34,18 +31,20 @@ Gets an element by name. If the element is not loaded, it will try to load it fi
* `table` `Element` The element class
## ElementManager.getElementList()
Gets a list of all elements
### Returns
* `table` `ElementList` A list of all elements
## ElementManager.getAPI(name)
Gets an Plugin API by name
## ElementManager.loadElement(name)
Loads an element by name. This will load the element and apply any plugins to it.
### Parameters
* `name` `string` The name of the API to get
* `name` `string` The name of the element to load
### Usage
```lua
ElementManager.loadElement("Button")
```
### Returns
* `table` `API` The API