1
0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-13 05:48:35 +00:00

Created Keyboard (markdown)

Robert Beekman 2016-11-01 17:44:57 +01:00
parent ffed0eb146
commit 18a1fbeac9

52
Keyboard.md Normal file

@ -0,0 +1,52 @@
The Keyboard variable lets you interact with the currently active keyboard.
## Properties
### Name
Returns the name of the keyboard.
#### Example:
```lua
print("Current keyboard: ".. Keyboard.Name);
```
#### Result:
```
Current keyboard: K95 RGB
```
## 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
```