DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-13 05:48:35 +00:00
Code Issues Releases Wiki Activity

Destroyed LUA (markdown)

Robert Beekman 2016-11-01 17:53:34 +01:00
parent d2d6f96953
commit 08dcef3728
1 changed files with 0 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
LUA.md

@ -1,62 +0,0 @@
Welcome to the LUA section of the wiki, please pretent there's a nice intro here.
# Profile
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
```
# Keyboard
# Brushes
# Events