diff --git a/LUA.md b/LUA.md index 4e07b39..f5ba582 100644 --- a/LUA.md +++ b/LUA.md @@ -1 +1,62 @@ -Welcome to the LUA section of the wiki, please pretent there's a nice intro here. \ No newline at end of file +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 \ No newline at end of file