feat: 📦 added modem(gps)

Author: ChristophLHR

peripherals/geoScanner.lua

@@ -2,14 +2,14 @@
 local class = require("ccClass")
 ---@class GeoScanner : PeripheralActions
 local geoScanner = class(function (a, turtle, scanResult)
-    a.turtle = turtle
+    a.computer = turtle
     a.scanResult = scanResult or {}
 end)
 
 ---@type ScanDataTable
 geoScanner.scanResult = nil
 ---@type TurtleMock | nil
-geoScanner.turtle = nil
+geoScanner.computer = nil
 geoScanner.scanEmulator = false
 
 ---comment
@@ -21,13 +21,13 @@ function geoScanner:scan(radius)
         return self.scanResult
     end
     local result = {}
-    assert(self.turtle, "No turtle found, needs to be provided in the constructor via playPeripheralProxy as the third parameter")
-    local e = self.turtle.emulator
+    assert(self.computer, "No turtle found, needs to be provided in the constructor via playPeripheralProxy as the third parameter")
+    local e = self.computer.emulator
     assert(e, "No emulator found")
     for positionString, block in pairs(e.blocks) do
         --- check if the block is in the radius x of the turtle
-        local length = (block.position - self.turtle.position).length
-        if (block.position - self.turtle.position):length() <= radius then
+        local length = (block.position - self.computer.position).length
+        if (block.position - self.computer.position):length() <= radius then
             table.insert(result, {name = block.item.name
                 ,x = block.position.x
                 ,y = block.position.y
@@ -37,8 +37,8 @@ function geoScanner:scan(radius)
         end
     end    
     for id, turtle in ipairs(e.turtles) do
-        if turtle.id ~= self.turtle.id then
-            local length = (turtle.position - self.turtle.position).length
+        if turtle.id ~= self.computer.id then
+            local length = (turtle.position - self.computer.position).length
             if length <= radius then
                 table.insert(result, {name = "computercraft:turtle_advanced"
                     ,x = turtle.position.x

peripherals/modem.lua

@@ -0,0 +1,30 @@
+---@type ccClass
+local class = require("ccClass")
+---@class Modem : PeripheralActions
+local modem = class(function (a, turtle)
+    a.computer = turtle
+end)
+
+modem.computer = nil
+
+function modem:accessValid(key, item)
+    local computer = self.computer
+    assert(computer, "No not linked to a turtle (turtle.getPeripheralModule) !")
+    ---@cast computer TurtleProxy
+    local succ, valid = pcall(function () 
+        return (computer.equipslots.left.name == item.name or computer.equipslots.right.name == item.name) and self.isWrapped
+     end)
+    return succ and valid
+end
+
+function modem:getType()
+    return "modem"
+end
+
+function modem:locate()
+    assert(self.computer, "No not linked to a turtle (turtle.getPeripheralModule) !")
+    return
+            self.computer.position.x, self.computer.position.y, self.computer.position.z
+end
+
+return modem

peripherals/peripheral.lua

@@ -29,6 +29,8 @@ to simulate the normal behavior of a turtle interacting with a peripheral.
 
 ---@class PeripheralActions
 ---@field getType fun():string
+---@field accessValid nil | fun(self: PeripheralActions, key: string, item: Item):boolean, string
+---@field isWrapped boolean | nil
 
 ---@class PeripheralModule
 ---@field type string
@@ -145,6 +147,7 @@ function peripheralModule:find(typeName, filterFunc)
 
             peripheral = self.computer.emulator:playPeripheralProxy(item)
             if peripheral and ((not filterFunc) or filterFunc(item.name, peripheral)) then
+                peripheral.isWrapped = true
                 return peripheral
             end
         end
@@ -202,6 +205,7 @@ function peripheralModule:wrap(position)
         local positionOfItems = getNearbyPeripheralItems(self)
         if positionOfItems[position] ~= nil then
             local peripheral = self.computer.emulator:playPeripheralProxy(positionOfItems[position])
+            peripheral.isWrapped = true
             return peripheral
         end
     end

tests/test_spec.lua

@@ -40,8 +40,10 @@ require(package)
 -- load the other suits
 local vector = require("vector")
 local geoScanner = require("geoScanner")
+local modemClass = require("modem")
 local chestInventory = require("chestInventory")
 
+
 local turtleEmulator = require("turtleEmulator")
 describe("Disabled Movement", function()
     local turtle
@@ -942,3 +944,43 @@ describe("peripherals", function()
         end)
     end)
 end)
+describe("GPS", function()
+    ---@type TurtleProxy
+    local turtle
+    local gpsItem
+    local gps
+    local modem
+    local peripheral
+
+    before_each(function()
+        turtleEmulator:clearBlocks()
+        turtleEmulator:clearTurtles()
+        turtle = turtleEmulator:createTurtle()
+        gpsItem = { name = "computercraft:advanced_modem", count = 1, equipable = true }
+        turtle.addItemToInventory(gpsItem, 1)
+        turtle.addItemToInventory({ name = "minecraft:coal", count = 64, fuelgain = 8 }, 2)
+        modem = turtleEmulator:addPeripheralToItem(gpsItem, modemClass, turtle)
+        gps = modem
+        peripheral = turtle.getPeripheralModule()
+    end)
+    it("should fail", function()
+        local falsy = modem.locate()
+        assert.is.falsy(falsy)
+    end)
+    it("should work", function()
+        assert.is_true(turtle.equipLeft())
+        assert.are.equal("computercraft:advanced_modem", turtle.equipslots.left.name)
+        assert.is.truthy(peripheral.find("modem"))
+        turtle.select(2)
+        turtle.refuel(10)
+        local x, y, z = gps.locate()
+        assert.are.equal(0, x)
+        assert.are.equal(0, y)
+        assert.are.equal(0, z)
+        turtle.forward()
+        x, y, z = gps.locate()
+        assert.are.equal(1, x)
+        assert.are.equal(0, y)
+        assert.are.equal(0, z)
+    end)
+end)

turtleEmulator.lua

@@ -187,6 +187,17 @@ function turtleEmulator:playPeripheralProxy(item)
         if value == nil then
             error("no field found for key: " .. item.peripheralName .. "." .. key)
         end
+        local callerInfo = debug.getinfo(2, "f")
+        if not (callerInfo and callerInfo.func == action and key ~= "accessValid") then
+            local valid = action.accessValid
+            if valid and not valid(action, key, item) then 
+                if type(value) == "function" then
+                    return function() end
+                end
+                return nil
+            end
+        end
+        -- error("passed")
         if type(value) == "function" then
             return function(...)
                 local mightBeSelf = select(1, ...)
@@ -226,5 +237,7 @@ function turtleEmulator:turtleDrop(position, item)
     itemFallsDown(position, item)
     return true
 end
+
+
 ---set vector-lib for the turtleEmulator
 return turtleEmulator

turtleMock.lua

@@ -12,6 +12,9 @@
 
 ---@alias inspectResult {name: string, tags: table<string, any> | nil, state: table<string, any> | nil} | nil
 
+---@class GPSModule
+---@field locate fun():number, number, number
+
 ---@class TurtleMock
 ---@field position Vector | nil
 ---@field facing Vector | nil
@@ -59,6 +62,7 @@
 ---@field dropDown fun(count: integer):boolean
 ---@field dropUp fun(count: integer):boolean
 ---@field drop fun(count: integer):boolean
+---@field getGPSModule fun():table
 ---@field print fun(...: any):nil only exists for testing purposes
 ---@field getPeripheralModule fun():PeripheralModule only exists for testing purposes
 ---@field addItemToInventory fun(item: Item, slot: number | nil):boolean only exists for testing purposes
@@ -702,6 +706,7 @@ end
 function turtleMock:drop(count)
     return drop(self, self.position + self.facing, count)
 end
+
 ---will only print content if canPrint is set to true
 ---@param ... any
 ---@return nil