Merge pull request #2 from mc-cc-scripts/ClearArea-addition

Clear area addition

Author: ColdIV

README.md

@@ -18,7 +18,12 @@ builder help
 ```lua
 -- Builds a floor with the specified size.
 -- Uses the Item in Slot 1 as Buildingblock!
-builder floor -w <width> -l <length> -m <"left"|"right">
+builder floor -w <width> -l <length> -mH <"left"|"right">
 ```
 
-# Dev - Documentaion
+### clearArea
+
+```lua
+-- clears an Area of the specifed size
+builder clearArea -w <width> -l <length> -h <height> -mH <"left"|"right"> -mV <"up"|"down">
+```

builder-lib.lua

@@ -1,7 +1,7 @@
 ---@class Builder_Lib
 local Builder_Lib = {
     movementDirection = {
-        height = "bottom",
+        height = "up",
         width = "right"
     }
 }
@@ -36,34 +36,44 @@ local function placeDownItem(itemname)
     if not succ then error(txt) end
 end
 
-local function returnToStartingPos()
+local function getTurningDirection(builderRef ,cHorizontal, cVertical, maxWidth)
+    assert(type(builderRef) == "table", "needs self reference!")
+    cHorizontal = cHorizontal or 1
+    cVertical = cVertical or 1
+    maxWidth = maxWidth or 2 -- default is even
 
-end
+    local hModulo = cHorizontal % 2
+    local vModulo = cVertical % 2
+    
+    -- if odd, pretent to always be at base y-level and CONTINUE the left / right toggle
+    -- making vModulo static
+    if (maxWidth % 2 == 1) then
+        vModulo = 1
+    end
 
----builds the floor with the given size
----@param length number
----@param width number
-function Builder_Lib:floor(length, width)
+    if builderRef.movementDirection.width == "left" then
+        hModulo = 1 - hModulo -- invert 1 <=> 0
+    end
 
-    local t
-    if self.movementDirection.width == "right" then
-        t = function(modulo)
-            if modulo == 1 then
-                turtle.turnRight()
-            else
-                turtle.turnLeft()
-            end
-        end
+    if (hModulo == vModulo) then
+        turtle.turnRight()
     else
-        t = function(modulo)
-            if modulo == 1 then
-                turtle.turnLeft()
-            else
-                turtle.turnRight()
-            end
-        end
+        turtle.turnLeft()
     end
 
+end
+
+local function returnToStartingPos()
+
+end
+
+---builds the floor with the given size
+---@param length number | nil
+---@param width number | nil
+---@return boolean success
+function Builder_Lib:floor(length, width)
+    length = length or 1
+    width = width or 1
     turtle.select(1)
     local block = turtle.getItemDetail()
     if block == nil then error("No block at item slot 1") end
@@ -74,11 +84,81 @@ function Builder_Lib:floor(length, width)
         end
         placeDownItem(block.name)
         if (j < width) then
-            t(j % 2)
+            getTurningDirection(self, j)
             turtleController:goStraight(1)
-            t(j % 2)
+            getTurningDirection(self, j)
         end
     end
     returnToStartingPos()
+    return true
+end
+
+---clears an area with of specified size
+---@param length number | nil
+---@param width number | nil
+---@param height number | nil
+---@return boolean success
+function Builder_Lib:clearArea(length, width, height)
+    local upDownDig = function(cHeight, maxHeight)
+        if Builder_Lib.movementDirection.height == "up" then
+            if(cHeight < maxHeight) then
+                turtleController:tryAction("digU")
+            end
+            if(cHeight > 1) then
+                turtleController:tryAction("digD")
+            end
+        else
+            if(cHeight < maxHeight) then
+                turtleController:tryAction("digD")
+            end
+            if(cHeight > 1) then
+                turtleController:tryAction("digU")
+            end
+        end
+    end
+    length = length or 1
+    width = width or 1
+    height = height or 1
+
+
+    local currentHeight = 1
+    local k = 1
+    while true do 
+        for j = 1, width, 1 do
+            for i = 1, length - 1, 1 do
+                upDownDig(currentHeight, height)
+                turtleController:goStraight(1)
+            end
+            upDownDig(currentHeight, height)
+            if (j < width) then
+                getTurningDirection(self, j, k, width)
+                turtleController:goStraight(1)
+                getTurningDirection(self, j, k, width)
+            else
+            end
+        end
+        upDownDig(currentHeight, height)
+
+        -- go up 3 blocks
+        local diff = height - currentHeight
+        if diff > 3 then 
+            diff = 3
+        end
+        if diff <= 1 then
+            break
+        end
+        if self.movementDirection.height == "up" then
+            turtleController:goUp(diff)
+        else
+            turtleController:goDown(diff)
+        end
+        currentHeight = currentHeight + diff
+        
+        k = k + 1
+        turtleController:tryMove("tA")
+    end
+
+    returnToStartingPos()
+    return true
 end
 return Builder_Lib

builder.lua

@@ -1,21 +1,22 @@
 --- UI for Builder
 
 ---@class Builder_Lib
-local builder = require("/progs/builder-prog/builder-lib")
+local builder = require("builder-lib")
 
 
 local function help()
     print("Usage:")
     print("builder <command> <options>")
-    print("")
     print("Commands: ")
-    print("- 'floor'")
-    print("")
+    print("'floor'")
+    print("'clearArea'")
     print("Options:")
-    print("-m[movementDirection] <'left'|'right'> [default: right]")
+    print("-mH[movementDir. Horizon] <'left'|'right'> [default: right]")
+    print("-mV[movementDir. Vertical] <'down'|'up'> [default: up]")
     print("-w[width] <number>")
     print("-l[length] <number>")
-    print("-h[help]")
+    print("-h[height] <number>")
+    print("-help")
 end
 if #arg == 0 then
     help()
@@ -26,16 +27,20 @@ end
 local stopExec = false
 
 local size = {
-    ["length"] = 0,
-    ["width"] = 0,
-    ["height"] = 0
+    ["length"] = nil,
+    ["width"] = nil,
+    ["height"] = nil
 }
 
 local argsSwitch = {
-    ["-m"] = function(no)
+    ["-mH"] = function(no)
         no[1] = no[1] + 1
         builder.movementDirection.width = arg[no[1]]
     end,
+    ["-mV"] = function (no)
+        no[1] = no[1] + 1
+        builder.movementDirection.height = arg[no[1]]
+    end,
     ["-l"] = function(no)
         no[1] = no[1] + 1
         size["length"] = tonumber(arg[no[1]]) or error("length not valid")
@@ -44,7 +49,16 @@ local argsSwitch = {
         no[1] = no[1] + 1
         size["width"] = tonumber(arg[no[1]]) or error("width not valid")
     end,
-    ["-h"] = function()
+    ["-h"] = function(no)
+        no[1] = no[1] + 1
+        if not tonumber(arg[no[1]]) then
+            help()
+            stopExec = true
+            return
+        end
+        size["height"] = tonumber(arg[no[1]])
+    end,
+    ["-help"] = function()
         help()
         stopExec = true
     end,
@@ -56,6 +70,9 @@ local argsSwitch = {
 local commands = {
     ["floor"] = function()
         builder:floor(size["length"], size["width"])
+    end,
+    ["clearArea"] = function()
+        builder:clearArea(size["length"], size["width"], size["height"])
     end
 }