feat: 🧱 Emulating blocks in the "world" and dig-functions

Author: ChristophLHR

Progress.md

@@ -13,17 +13,21 @@ turtle.transferTo(slotNum, count)
 turtle.equipLeft()
 turtle.equipRight()
 turtle.refuel(count)
+turtle.dig()
+turtle.digUp()
+turtle.digDown()
+turtle.forward()
+turtle.back()
+turtle.up()
+turtle.down()
 ```
 
 ## Implemented but not finished
 
 ### No check against fuel level or worldgen
 
 ```lua
-turtle.forward()
-turtle.back()
-turtle.up()
-turtle.down()
+
 ```
 
 ## Implemented but not working
@@ -44,9 +48,6 @@ turtle.dropDown(count)
 turtle.suck(count)
 turtle.suckUp(count)
 turtle.suckDown(count)
-turtle.dig()
-turtle.digUp()
-turtle.digDown()
 turtle.place(text)
 turtle.placeUp(text)
 turtle.placeDown(text)
@@ -57,4 +58,5 @@ turtle.attack()
 turtle.attackUp()
 turtle.attackDown()
 turtle.craft(count)
+peripheral.find("chest, turtle, drive, ...")
 ```

README.md

@@ -1,29 +1,45 @@
 # turtleEmulator-lib
 
-This Emulator is exclusively ment to enable testing CC code with a testingframework, outside MC and CraftOS.
+This Emulator is exclusively ment to enable testing CC turtle-code with a testingframework (namely busted), outside MC and CraftOS.
 
 ### WIP
 
-> Should increase in scope incrementally. For now it (will) only keep track of position and turtle-direction
+ Should increase in scope incrementally.
+
+> For now it only supports all functions listed in the Progress.md
 
 ### HOW TO USE
 
 ```lua
 local turtleEmulator = require("<path>/turtleEmulator")
 
+-- create turtles
 local turtleOne = turtleEmulator:createTurtle()
 local turtleTwo = turtleEmulator:createTurtle()
 
--- override the default behavior, skipping fuelcheck etc.
-turtleTwo.canMoveToCheck = function() return true end
-
-turtleOne.forward()
-assert(turtleOne.position.x == 1)
+-- add items to turtles for testing
+turtleOne.addItemToInventory({ 
+    name = "minecraft:coal",
+    count = 64,
+    maxcount = 64,
+    fuelgain = 8
+})
+turtleOne.refuel(64)
+
+assert(true == turtleOne.forward(), "I have fuel and should work")
+assert(false == turtleTwo.forward(), "I have no fuel and should not work")
+
+-- add block to World
+turtleEmulator:createBlock({
+    item = {
+        name = "minecraft:dirt"
+    },
+    position = { x = 0, y = -1, z = 0 }
+})
 
---...
 ```
-
+---
 ### Restrictions
 
-To allow the creation of multiple turtles within the same Emulator, the turtle returned by createTurtle is only a proxy, meaning that the metatable should not be modified.
+To allow the creation of multiple turtles within the same Emulator, the turtle returned by createTurtle is only a proxy, meaning that the metatable should not be modified!
 However, should the need ever arise, you can modify it by getmetatable(turtle).\_\_metatable = nil. But please be aware that overriding the \_\_index and \_\_newIndex will break the functionality of the turtle.

defaultInteraction.lua

@@ -0,0 +1,26 @@
+---@type item
+local turtleItem = {name = "computercraft:turtle_normal", count = 1, maxcount = 64}
+
+---@type onInteration
+local function defaultInteration(turtle, block, action)
+    assert(turtle, "Turtle is nil")
+    assert(turtle.emulator, "Turtle has no reference to the emulator")
+    if block.emulator == nil then -- Block
+        assert(block.item, "Block has no item")
+        assert(block.item.name, "Block has no item name")
+        if action == "dig" then
+            block.item.count = block.item.count or 1
+            block.item.maxcount = block.item.maxcount or 64
+            turtle:addItemToInventory(block.item)
+            turtle.emulator:removeBlock(block.position)
+        end
+    else -- Turtle. On a turtle, the "self" always gets inserted, therefore every parameter moves to the right
+        if action == "dig" then
+            assert(block.emulator, "Turtle has no reference to the emulator")
+            block.emulator:removeTurtle(block)
+            turtle:addItemToInventory(turtleItem)
+        end
+    end
+end
+
+return defaultInteration

defaultcheckActionValid.lua

@@ -0,0 +1,14 @@
+-- This is the default checkActionValid function
+---@type checkActionValidFunc
+local defaultcheckActionValid = function(equipslots, action, block)
+    -- example use cases:
+    --
+    -- if equipslots.left and equipslots.left.name == "" then end
+    -- if action == "dig" then end
+    -- if block.item.name == "" then end
+
+    
+    return true
+end
+
+return defaultcheckActionValid