From fac7e221b3a6410e148da579aae94bb6ef4d4f01 Mon Sep 17 00:00:00 2001
From: toastonrye <toastonrye@hotmail.com>
Date: Mon, 8 Aug 2022 19:44:24 -0500
Subject: [PATCH] Update redstoneAnalogOutput.lua

Add comments
---
 examples/redstoneAnalogOutput.lua | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/examples/redstoneAnalogOutput.lua b/examples/redstoneAnalogOutput.lua
index da1b262..41ddc99 100644
--- a/examples/redstoneAnalogOutput.lua
+++ b/examples/redstoneAnalogOutput.lua
@@ -6,11 +6,11 @@ end
 
 -- toastonrye's example: Redstone Analog Output
 local basalt = require(filePath:gsub(".lua", "")) -- here you can change the variablename in any variablename you want default: basalt
-local w, h = term.getSize()
+local w, h = term.getSize() -- dimensions to use when drawing the sub frame
 
 local main = basalt.createFrame()
  :show()
- :setBackground(colours.blue)
+ :setBackground(colours.blue) -- using colours to easily determine what frame I'm in
 
 local sub = main:addFrame()
  :setPosition(2,2)
@@ -20,28 +20,28 @@ local sub = main:addFrame()
 local rFrame = sub:addFrame("redstoneFrame")
  :setPosition(1,1)
  :setSize(25,5)
- :setMoveable(true)
+ :setMoveable(true) -- the next release of Basalt will fix spelling to :setMovable
  :setBackground(colours.red)
 
 -- Redstone Analog Output
-local redstoneAnalog = rFrame:addLabel()
+local redstoneAnalog = rFrame:addLabel() -- label that displays the value of the slider & Redstone output
  :setPosition(18,3):setText("1")
 
-redstone.setAnalogOutput("left", 1)
+redstone.setAnalogOutput("left", 1) -- initialize the redstone output to 1, to match the above label
 
-rFrame:addLabel()
+rFrame:addLabel() -- draw a label on the frame
  :setText("Redstone Analog Output")
  :setPosition(1,2)
  
 rFrame:addSlider()
  :setPosition(1,3)
- :onChange(function(self)
+ :onChange(function(self) -- when a player interacts with the slider, update the variable redstoneAnalog
   redstoneAnalog:setText(self:getValue())
  end)
- :setMaxValue(15)
- :setSize(15,1)
+ :setMaxValue(15) -- max value of the slider, default 8. Redstone has 15 levels (16 including 0)
+ :setSize(15,1) -- draw the slider to this size, without this redstoneAnalog value can have decimals
 
-redstoneAnalog:onChange(function(self)
+redstoneAnalog:onChange(function(self) -- when the slider value changes, change the Redstone output to match
  redstone.setAnalogOutput("left", tonumber(self:getValue()))
  basalt.debug(self:getValue())
 end)