feat: 🚧 Added Equipment and Added Blocks to the Emulator - WIP

Author: ChristophLHR

Progress.md

@@ -8,6 +8,11 @@ turtle.getSelectedSlot()
 turtle.select(slotNum)
 turtle.getItemCount(slotNum)
 turtle.getItemSpace(slotNum)
+turtle.getFuelLimit()
+turtle.transferTo(slotNum, count)
+turtle.equipLeft()
+turtle.equipRight()
+turtle.refuel(count)
 ```
 
 ## Implemented but not finished
@@ -39,11 +44,6 @@ turtle.dropDown(count)
 turtle.suck(count)
 turtle.suckUp(count)
 turtle.suckDown(count)
-turtle.refuel(count)
-turtle.getFuelLimit()
-turtle.transferTo(slotNum, count)--now
-turtle.equipLeft()
-turtle.equipRight()
 turtle.dig()
 turtle.digUp()
 turtle.digDown()

tests/test_spec.lua

@@ -24,6 +24,7 @@
 ---@field True function
 ---@field False function
 ---@field has_error function
+---@field is_false function
 ---@field is_true function
 ---@field equal function
 assert = assert
@@ -217,6 +218,7 @@ describe("multiple Turtles", function()
     local turtle1
     local turtle2
     setup(function()
+        turtleEmulator:clearTurtles()
         turtle1 = turtleEmulator:createTurtle()
         turtle2 = turtleEmulator:createTurtle()
         turtle1["canMoveToCheck"] = function()
@@ -297,7 +299,7 @@ describe("InventoryTests", function()
     describe("Adding Items for Testing", function()
         before_each(function()
             turtle = turtleEmulator:createTurtle()
-            turtle:addItemToInventory({ name = "minecraft:coal", count = 64, maxcount = 64, fuelgain = 64 }, 1)
+            turtle:addItemToInventory({ name = "minecraft:coal", count = 64, maxcount = 64, fuelgain = 16 }, 1)
             turtle:addItemToInventory({ name = "minecraft:wood_plank", count = 64, maxcount = 64, fuelgain = 8 }, 2)
         end)
         it("Throw Error when adding Item to full slot", function()
@@ -357,10 +359,36 @@ describe("InventoryTests", function()
             assert.are.equal(0, turtle.getItemCount(6))
         end)
     end)
+    describe("Refueling", function ()
+        local fuelGainPerCoal = 16
+        before_each(function()
+            turtle = turtleEmulator:createTurtle()
+            turtle:addItemToInventory({ name = "minecraft:coal", count = 64, maxcount = 64, fuelgain = fuelGainPerCoal }, 1)
+            turtle:addItemToInventory({ name = "minecraft:wood_plank", count = 64, maxcount = 64, fuelgain = 8 }, 2)
+        end)
+        it("Refuel with coal", function()
+            turtle.select(1)
+            local succ = turtle.refuel()
+            assert.is_true(succ)
+            assert.are.equal(fuelGainPerCoal, turtle.getFuelLevel())
+            assert.are.equal(63, turtle.getItemCount())
+            succ = turtle.refuel(63)
+            assert.is_true(succ)
+            assert.are.equal(fuelGainPerCoal * 64, turtle.getFuelLevel())
+            assert.are.equal(0, turtle.getItemCount())
+            local succ = turtle.refuel()
+            assert.is_false(succ)
+            turtle.select(3)
+            turtle:addItemToInventory({ name = "minecraft:stone", count = 64, maxcount = 64 }, 3)
+            succ = turtle.refuel()
+            assert.is_false(succ)
+            assert.are.equal(fuelGainPerCoal * 64, turtle.getFuelLevel())
+        end)
+    end)
     describe("Remaining Inventory Tests", function()
         before_each(function()
             turtle = turtleEmulator:createTurtle()
-            turtle:addItemToInventory({ name = "minecraft:coal", count = 64, maxcount = 64, fuelgain = 64 }, 1)
+            turtle:addItemToInventory({ name = "minecraft:coal", count = 64, maxcount = 64, fuelgain = 16 }, 1)
             turtle:addItemToInventory({ name = "minecraft:wood_plank", count = 64, maxcount = 64, fuelgain = 8 }, 2)
             turtle:getSocket()
         end)
@@ -409,3 +437,111 @@ describe("InventoryTests", function()
         end)
     end)
 end)
+describe("Equipment", function ()
+    ---@type TurtleProxy
+    local turtle
+    before_each(function()
+        turtle = turtleEmulator:createTurtle()
+        turtle:addItemToInventory({ name = "minecraft:coal", count = 64, maxcount = 64, fuelgain = 16 }, 1)
+        turtle:addItemToInventory({ name = "minecraft:wood_plank", count = 64, maxcount = 64, fuelgain = 8 }, 2)
+    end)
+    it("Equip non Equipment", function()
+        local succ = turtle.equipLeft()
+        assert.is_false(succ)
+    end)
+    it("Equip Equipment", function()
+        turtle:addItemToInventory({ name = "CCTweaked:chat_box", count = 2, maxcount = 2, equipable = true}, 3)
+        turtle:select(3)
+        local succ = turtle.equipLeft()
+        assert.is_true(succ)
+        assert.are.equal( turtle.equipslots.left.name, "CCTweaked:chat_box")
+        assert.are.equal(turtle.equipslots.left.count, 1)
+    end)
+    it("Upgrade Equipment", function()
+        turtle:addItemToInventory({ name = "CCTweaked:chat_box", count = 2, maxcount = 2, equipable = true}, 3)
+        turtle:select(3)
+        local succ = turtle.equipLeft()
+        assert.is_true(succ)
+        assert.are.equal(turtle.equipslots.left.name, "CCTweaked:chat_box")
+        assert.are.equal(turtle.equipslots.left.count, 1)
+    end)
+
+    it("Upgrade Equipment and Replace in inventory", function()
+        turtle:addItemToInventory({ name = "CCTweaked:chat_box", count = 2, maxcount = 2, equipable = true}, 3)
+        turtle:addItemToInventory({ name = "CCTweaked:chunk_loader", count = 1, maxcount = 1, equipable = true }, 4)
+        turtle:select(3)
+        local succ = turtle.equipLeft()
+        assert.is_true(succ)
+        assert.are.equal(turtle.equipslots.left.name, "CCTweaked:chat_box")
+        assert.are.equal(turtle.equipslots.left.count, 1)
+        turtle:select(4)
+        succ = turtle.equipLeft()
+        assert.is_true(succ)
+        assert.are.equal(turtle.equipslots.left.name, "CCTweaked:chunk_loader")
+        assert.are.equal(turtle.equipslots.left.count, 1)
+        assert.are.equal(turtle.inventory[4].count, 1)
+        assert.are.equal(turtle.inventory[4].name, "CCTweaked:chat_box")
+        assert.are.equal(turtle.inventory[3].count, 1)
+        assert.are.equal(turtle.inventory[3].name, "CCTweaked:chat_box")
+    end)
+
+    it("Equip Left and RightSlot", function()
+        turtle:addItemToInventory({ name = "CCTweaked:chat_box", count = 2, maxcount = 2, equipable = true}, 3)
+        turtle.select(3)
+        local succ = turtle.equipRight()
+        assert.is_true(succ)
+        assert.are.equal(turtle.equipslots.right.name, "CCTweaked:chat_box")
+        assert.are.equal(turtle.equipslots.right.count, 1)
+        assert.are.equal(turtle.inventory[3].name, "CCTweaked:chat_box")
+        assert.are.equal(turtle.inventory[3].count, 1)
+    end)
+
+
+    
+end)
+
+describe("EmulatorTesting", function()
+    setup(function()
+        turtleEmulator:clearTurtles();
+    end)
+    describe("Adding Blocks", function()
+        it("Add Block", function()
+            turtleEmulator:createBlock({ item = {name = "minecraft:stone", maxcount = 64}, position = { x = 0, y = 0, z = 1 } })
+            assert.are_not.equal(nil, turtleEmulator.blocks["0,0,1"])
+            assert.are.equal("minecraft:stone", turtleEmulator.blocks["0,0,1"].item.name)
+            assert.are.equal(nil, turtleEmulator.blocks["0,0,2"])
+        end)
+        it("Add Block and remove it", function()
+            local block = { item = {name = "minecraft:stone", maxcount = 64}, position = { x = 1, y = 0, z = 0 } }
+            turtleEmulator:createBlock(block)
+            assert.are_not.equal(nil, turtleEmulator.blocks["1,0,0"])
+            assert.are.equal("minecraft:stone", turtleEmulator.blocks["1,0,0"].item.name)
+            turtleEmulator:removeBlock(block.position)
+            assert.are.equal(nil, turtleEmulator.blocks["1,0,0"])
+        end)
+    end)
+    describe("Read Blocks", function()
+        ---TODO: Implement
+    end)
+    describe("Return Block", function()
+        local block = { 
+            item = {name = "minecraft:stone", maxcount = 64},
+            position = { x = 1, y = 0, z = 0 }
+        }
+        turtleEmulator:createBlock(block)
+        assert.are_not.equal(nil, turtleEmulator.blocks["1,0,0"])
+        assert.are_not.equal(nil, turtleEmulator:getBlock(block.position))
+        local b = turtleEmulator:getBlock(block.position)
+        assert.is.falsy(b.emulator)
+        assert.are.equal(block.item.name, b.item.name)
+    end)
+end)
+
+describe("ActionAccepted", function ()
+    --- TODO: Implement
+    local turtle1
+    local turtle2
+    setup(function()
+        turtleEmulator:clearTurtles()
+    end)
+end)

turtleEmulator.lua

@@ -1,12 +1,81 @@
+--- ### Definitions
+---@alias checkActionValid table | string | fun(equipslots: equipslots ,action : string, block: block): true
+---@alias block {item: item, checkActionValid: checkActionValid, position: position, onInteration: fun(turtle: turtleMock, block: block, action: string): nil}
+
+--- used from the Scanner, as the blocks will most likely be scanned, saved and then inserted into the turtleEmulator for testing
+---@class ScanData
+---@field x number
+---@field y number
+---@field z number
+---@field name string
+---@field checkActionValid checkActionValid | nil
+
+---@class ScanDataTable
+---@field _ ScanData
+
+
+
+---@type TurtleMock
 local turtleM = require("./turtleMock")
+
 ---@class TurtleEmulator
 local turtleEmulator = {
+    ---@type table<number, TurtleProxy>
     turtles = {},
+    ---@type table<string, block>
+    blocks = {},
     createTurtle = function(self)
-        local t = turtleM.createMock()
+        ---@type TurtleProxy
+        local t = turtleM.createMock(self)
         table.insert(self.turtles, t)
         return t
     end,
 }
 
+local function createPositionKey(position)
+    return position.x .. "," .. position.y .. "," .. position.z
+end
+
+--- Adds a block to the emulated world
+---@param block block
+function turtleEmulator:createBlock(block)
+    assert(block.position, "Block has no position")
+    self.blocks[createPositionKey(block.position)] = block
+end
+
+--- Removes a block from the emulated world
+---@param position position
+function turtleEmulator:removeBlock(position)
+    self.blocks[createPositionKey(position)] = nil
+end
+
+--- Reads the blocks from the scanner-result and adds them to the emulated world
+---@param scannResult ScanDataTable
+function turtleEmulator:readBlocks(scannResult)
+    for _, v in pairs(scannResult) do
+        self:createBlock(v)
+    end
+end
+
+--- Removes all blocks from the emulated world
+function turtleEmulator:clearBlocks()
+    self.blocks = {}
+end
+
+--- Returns the block at the given position
+---@param position position
+---@return block | TurtleProxy | nil
+function turtleEmulator:getBlock(position)
+    for _, t in ipairs(self.turtles) do
+        if t.position.x == position.x and t.position.y == position.y and t.position.z == position.z then
+            return t
+        end
+    end
+    return self.blocks[createPositionKey(position)]
+end
+
+function turtleEmulator:clearTurtles()
+    self.turtles = {}
+end
+
 return turtleEmulator