feat: 👥 Implemented Detect, Compare and Inspect

Author: ChristophLHR

Progress.md

@@ -60,3 +60,5 @@ turtle.attackDown()
 turtle.craft(count)
 peripheral.find("chest, turtle, drive, ...")
 ```
+
+Also: A way to manage the "state" of blocks (for turtle.inspect f.e.)

tests/test_spec.lua

@@ -627,6 +627,70 @@ describe("ActionAccepted", function ()
         assert.are.equal("computercraft:turtle_normal", turtleEmulator:getBlock({ x = 2, y = 0, z = 0 }).item.name)
         assert.are.equal("computercraft:turtle_normal", turtle2.getItemDetail().name)
     end)
+end)
+
+describe("Detect, Compare, Inspect", function()
+    local turtle
+    before_each(function()
+        turtleEmulator:clearBlocks()
+        turtleEmulator:clearTurtles()
+        turtle = turtleEmulator:createTurtle()
+        turtleEmulator:createBlock({ item = {name = "minecraft:stone"}, position = { x = 1, y = 0, z = 0 } })
+        turtleEmulator:createBlock({ item = {name = "minecraft:wood"}, position = { x = 0, y = 1, z = 0 }, state = {burning = true} })
+        
+    end)
+    it("Detect", function()
+        turtleEmulator:createBlock({ item = {name = "minecraft:stone"}, position = { x = 1, y = 0, z = 0 } })
+        assert.is_true(turtle.detect())
+        assert.is_true(turtle.detectUp())
+        assert.is_false(turtle.detectDown())
+        turtleEmulator:createBlock({ item = {name = "minecraft:obsidian"}, position = { x = 0, y = -1, z = 0 , tag = {["minecraft:minable/pickaxe"] = true}} })
+        assert.is_true(turtle.detectDown())
+    end)
+    it("Compare", function()
+        assert.is_false(turtle.compare())
+        turtle:addItemToInventory({ name = "minecraft:stone", count = 1, maxcount = 64 })
+        assert.is_true(turtle.compare())
+        assert.is_false(turtle.compareUp())
+        turtleEmulator:createBlock({ item = {name = "minecraft:obsidian"}, position = { x = 0, y = -1, z = 0 , tag = {["minecraft:minable/pickaxe"] = true}} })
+        assert.is_false(turtle.compareDown())
+        turtle:addItemToInventory({ name = "minecraft:obsidian", count = 1, maxcount = 64 })
+        turtle.select(2)
+        assert.is_true(turtle.compareDown())
+    end)
+    it("Inspect", function()
+        local succ, info = turtle.inspect()
+        assert.is_true(succ)
+        ---@cast info inspectResult
+        assert.are.equal("minecraft:stone", info.name)
+        assert.are.equal(nil, info.state)
+        assert.are.equal(nil, info.tags)
+        succ, info = turtle.inspectUp()
+        assert.is_true(succ)
+        ---@cast info inspectResult
+        assert.are.equal("minecraft:wood", info.name)
+        assert.are.equal(true, info and info.state and info.state.burning)
+        assert.are.equal(nil, info.tags)
+        succ, info = turtle.inspectDown()
+        assert.is_false(succ)
+        assert.are.equal(nil, info)
+        turtleEmulator:createBlock({ item = {name = "minecraft:obsidian", tags = {["minecraft:minable/pickaxe"] = true}}, position = { x = 0, y = -1, z = 0 } })
+        succ, info = turtle.inspectDown()
+        assert.is_true(succ)
+        ---@cast info inspectResult
+        assert.are.equal("minecraft:obsidian", info.name)
+        assert.are.equal(true, info and info.tags and info.tags["minecraft:minable/pickaxe"])
+        local turtle2 = turtleEmulator:createTurtle()
+        turtle2.addItemToInventory({ name = "minecraft:coal", count = 64, maxcount = 64, fuelgain = 8 }, 1)
+        turtle2.refuel(64)
+        turtle2.dig()
+        assert.is_true(turtle2.forward())
+        succ, info = turtle.inspect()
+        assert.is_true(succ)
+        assert.are.equal("computercraft:turtle_normal", info.name)
+        assert.are.equal(nil, info.state)
+        assert.are.equal(nil, info.tags)
+    end)
 
 
 end)

turtleEmulator.lua

@@ -5,7 +5,7 @@
 ---@alias checkActionValidFunc fun(equipslots: equipslots ,action : checkActionName, block: block): true
 ---@alias checkActionValid checkActionValidFunc | table<checkActionName, toolName|checkActionValidFunc>  # e.g. {["dig"] = "pickaxe", ["place"] = func()}
 ---@alias onInteration fun(turtle: TurtleProxy, block: block | TurtleProxy, action: string): nil
----@alias block {item: item, checkActionValid: checkActionValid, position: position, onInteration: onInteration}
+---@alias block {item: item, checkActionValid: checkActionValid, position: position, onInteration: onInteration, state: table<string, any> | nil}
 
 --- used from the Scanner, as the blocks will most likely be scanned, saved and then inserted into the turtleEmulator for testing
 ---@class ScanData

turtleMock.lua

@@ -12,13 +12,15 @@
 ---@alias height integer
 ---@alias position {x: north, y: east, z: height}
 
----@alias item {name: string, durabilty: integer, equipable: boolean, fuelgain: integer, placeAble: boolean, maxcount: number, wildcardInfo: any, count: integer}
+---@alias item {name: string, durabilty: integer, equipable: boolean, fuelgain: integer, placeAble: boolean, maxcount: number, wildcardInfo: any, count: integer, tags: table<string, any> | nil}
 ---@alias inventory { [integer]: item }
 
 ---@alias left string
 ---@alias right string
 ---@alias equipslots {left: item, right: item}
 
+---@alias inspectResult {name: string, tags: table<string, any> | nil, state: table<string, any> | nil} | nil
+
 local defaultInteration = require("../defaultInteraction")
 
 ---@class TurtleMock
@@ -373,6 +375,38 @@ local function dig(turtle, block)
     return true, "Cannot beak block with this tool"
 end
 
+---@param block block | nil
+---@return boolean
+local function detect(block)
+    return block and true or false
+end
+
+---@param block block | nil
+---@param compareItem item | nil
+---@return boolean
+local function compare(block, compareItem)
+    if block == nil and compareItem == nil then
+        return true
+    end
+    if block == nil and compareItem ~= nil then
+        return false
+    end
+    if compareItem == nil and block ~= nil then
+        return false
+    end
+    return block.item.name == compareItem.name
+end
+
+---@param block block | nil
+---@return boolean
+---@return inspectResult
+local function inspect(block)
+    if block == nil or block.item == nil or block.item.name == nil then
+        return false, nil
+    end
+    return true, { name = block.item.name, tags = block.item.tags, state = block.state }
+end
+
 ---@param emulator TurtleEmulator
 ---@return TurtleProxy
 function turtleMock.createMock(emulator, id)
@@ -647,6 +681,54 @@ function turtleMock:digDown()
     return dig(self, blockPos)
 end
 
+function turtleMock:detect()
+    local _, _, blockPos = forward(self, false)
+    local block = self.emulator:getBlock(blockPos)
+    return detect(block)
+end
+
+function turtleMock:detectUp()
+    local block = self.emulator:getBlock({x = self.position.x, y = self.position.y + 1, z = self.position.z})
+    return detect(block)
+end
+
+function turtleMock:detectDown()
+    local block = self.emulator:getBlock({x = self.position.x, y = self.position.y - 1, z = self.position.z})
+    return detect(block)
+end
+
+function turtleMock:compare()
+    local _, _, blockPos = forward(self, false)
+    local block = self.emulator:getBlock(blockPos)
+    return compare(block, self.inventory[self.selectedSlot])
+end
+
+function turtleMock:compareUp()
+    local block = self.emulator:getBlock({x = self.position.x, y = self.position.y + 1, z = self.position.z})
+    return compare(block, self.inventory[self.selectedSlot])
+end
+
+function turtleMock:compareDown()
+    local block = self.emulator:getBlock({x = self.position.x, y = self.position.y - 1, z = self.position.z})
+    return compare(block, self.inventory[self.selectedSlot])
+end
+
+function turtleMock:inspect()
+    local _, _, blockPos = forward(self, false)
+    local block = self.emulator:getBlock(blockPos)
+    return inspect(block)
+end
+
+function turtleMock:inspectUp()
+    local block = self.emulator:getBlock({x = self.position.x, y = self.position.y + 1, z = self.position.z})
+    return inspect(block)
+end
+
+function turtleMock:inspectDown()
+    local block = self.emulator:getBlock({x = self.position.x, y = self.position.y - 1, z = self.position.z})
+    return inspect(block)
+end
+
 ---will only print content if canPrint is set to true
 ---@param ... any
 ---@return nil