mirror of
https://github.com/Artemis-RGB/Artemis
synced 2025-12-13 05:48:35 +00:00
Created [LUA] Profile (markdown)
parent
1d1db60052
commit
e862511cea
52
[LUA]-Profile.md
Normal file
52
[LUA]-Profile.md
Normal file
@ -0,0 +1,52 @@
|
||||
The Profile variable lets you interact with the profile the LUA script resides in.
|
||||
|
||||
## Properties
|
||||
### Name
|
||||
Returns the name of the current profile.
|
||||
|
||||
#### Example:
|
||||
```lua
|
||||
print("Current profile: ".. Profile.Name);
|
||||
```
|
||||
|
||||
#### Result:
|
||||
```
|
||||
Current profile: Test
|
||||
```
|
||||
|
||||
## Functions
|
||||
### GetLayers
|
||||
Returns all layers within the profile
|
||||
#### Syntax:
|
||||
```lua
|
||||
table GetLayers( );
|
||||
```
|
||||
#### Example:
|
||||
```lua
|
||||
local layers = Profile.GetLayers();
|
||||
for layerKey, layerValue in pairs(layers) do
|
||||
print(layerValue.Name)
|
||||
end
|
||||
```
|
||||
#### Result:
|
||||
```
|
||||
Test layer 1
|
||||
Test layer 2
|
||||
```
|
||||
|
||||
### GetLayerByName
|
||||
If found, returns the first layer with the given name
|
||||
#### Syntax:
|
||||
```lua
|
||||
layer GetLayerByName(string layerName);
|
||||
```
|
||||
#### Example:
|
||||
```lua
|
||||
local layer = Profile.GetLayerByName("Test layer 1");
|
||||
print(layer.Name)
|
||||
end
|
||||
```
|
||||
#### Result:
|
||||
```
|
||||
Test layer 1
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user