1.5.1

- improved performance by 8% for 120 Sensors
- bumped required Factorio version to current stable 
- moved config.lua settings to mod settings

Author: 0ptera

changelog.txt

@@ -1,3 +1,13 @@
+1.5.1
+- improved performance by 8% for 120 Sensors
+
+1.5.0
+- bumped required Factorio version to current stable 
+- moved config.lua settings to mod settings
+
+1.4.12
+- fixed ambigous config variables
+
 1.4.11
 - deconstruction triggers only if sensors exist
 

control.lua

@@ -1,5 +1,3 @@
-require "config"
-
 -- constant prototypes names
 local SENSOR = "item-sensor"
 
@@ -33,106 +31,157 @@ local floor = math.floor
 local ceil = math.ceil
 
 
----- Events ----
-
-function init_events()
-	script.on_event({defines.events.on_built_entity, defines.events.on_robot_built_entity}, OnEntityCreated)
-	if global.ItemSensors and #global.ItemSensors > 0 then
-		script.on_event(defines.events.on_tick, OnTick)
-		script.on_event({defines.events.on_preplayer_mined_item, defines.events.on_robot_pre_mined, defines.events.on_entity_died}, OnEntityRemoved)
-	end
-end
-
-script.on_init(function()
-  global.ItemSensors = global.ItemSensors or {}
-  init_events()
+---- MOD SETTINGS ----
+
+local UpdateInterval = settings.global["inv_sensor_update_interval"].value
+local ScanInterval = settings.global["inv_sensor_find_entity_interval"].value
+local ScanOffset = settings.global["inv_sensor_BBox_offset"].value
+local ScanRange = settings.global["inv_sensor_BBox_range"].value
+
+script.on_event(defines.events.on_runtime_mod_setting_changed, function(event)
+  if event.setting == "inv_sensor_update_interval" then
+    UpdateInterval = settings.global["inv_sensor_update_interval"].value
+    ResetStride()
+  end
+  if event.setting == "inv_sensor_find_entity_interval" then
+    ScanInterval = settings.global["inv_sensor_find_entity_interval"].value
+  end
+  if event.setting == "inv_sensor_BBox_offset" then
+    ScanOffset = settings.global["inv_sensor_BBox_offset"].value
+    ResetSensors()
+  end
+  if event.setting == "inv_sensor_BBox_range" then
+    ScanRange = settings.global["inv_sensor_BBox_range"].value
+    ResetSensors()
+  end
 end)
 
-script.on_load(function()
-  init_events()
-end)
 
-script.on_configuration_changed(function(data)
-	global.ItemSensors = global.ItemSensors or {}
-	for i=1, #global.ItemSensors do
-		local itemSensor = global.ItemSensors[i]
-		itemSensor.ID = itemSensor.Sensor.unit_number
-		itemSensor.ScanArea = GetScanArea(itemSensor.Sensor)
-		itemSensor.ConnectedEntity = nil
-		itemSensor.Inventory = {}
-		SetConnectedEntity(itemSensor)
-	end
-	init_events()
-end)
+---- EVENTS ----
 
 function OnEntityCreated(event)
 	if (event.created_entity.name == "item-sensor") then
-		CreateItemSensor(event.created_entity)
+    local entity = event.created_entity
+    global.ItemSensors = global.ItemSensors or {}
+
+    entity.operable = false
+    entity.rotatable = false
+    local itemSensor = {}
+    itemSensor.ID = entity.unit_number
+    itemSensor.Sensor = entity
+    itemSensor.ScanArea = GetScanArea(entity)
+    SetConnectedEntity(itemSensor)
+
+    global.ItemSensors[#global.ItemSensors+1] = itemSensor
+
 		if #global.ItemSensors == 1 then
 			script.on_event(defines.events.on_tick, OnTick)
 			script.on_event({defines.events.on_preplayer_mined_item, defines.events.on_robot_pre_mined, defines.events.on_entity_died}, OnEntityRemoved)
 		end
+    
+    ResetStride()
 	end
 end
 
 function OnEntityRemoved(event)
 -- script.on_event({defines.events.on_preplayer_mined_item, defines.events.on_robot_pre_mined, defines.events.on_entity_died}, function(event)
 	if event.entity.name == SENSOR then
-		RemoveItemSensor(event.entity)
+    for i=#global.ItemSensors, 1, -1 do
+      if event.entity.unit_number == global.ItemSensors[i].ID then
+        table.remove(global.ItemSensors,i)
+      end
+    end
+
 		if #global.ItemSensors == 0 then
 			script.on_event(defines.events.on_tick, nil)
 			script.on_event({defines.events.on_preplayer_mined_item, defines.events.on_robot_pre_mined, defines.events.on_entity_died}, nil)
 		end
+    
+    ResetStride()
 	end
 end
 
+
 function OnTick(event)
-	local tick = game.tick
-	for i=1, #global.ItemSensors do
-		local itemSensor = global.ItemSensors[i]
-		if not itemSensor.SkipEntityScanning and (i + tick) % find_entity_interval == 0 then
-			SetConnectedEntity(itemSensor)
-		end
-		if (i + tick) % update_interval == 0 then
-			UpdateSensor(itemSensor)
-		end
-	end
+  global.tickCount = global.tickCount or 1
+  global.SensorIndex = global.SensorIndex or 1
+
+  -- only work if index is within bounds
+  if global.SensorIndex <= #global.ItemSensors then
+    local lastIndex = global.SensorIndex + global.SensorStride - 1
+    if lastIndex >= #global.ItemSensors then
+      lastIndex = #global.ItemSensors
+    end
+
+    -- log("[IS] "..global.tickCount.." / "..game.tick.." updating sensors "..global.SensorIndex.." to "..lastIndex)
+    for i=global.SensorIndex, lastIndex do
+      local itemSensor = global.ItemSensors[i]
+      -- log("[IS] skipScan: "..tostring(itemSensor.SkipEntityScanning).." LastScan: "..tostring(itemSensor.LastScanned).."/"..game.tick)
+      if not itemSensor.SkipEntityScanning and (game.tick - itemSensor.LastScanned) >= ScanInterval then
+        SetConnectedEntity(itemSensor)
+      end
+      
+      UpdateSensor(itemSensor)      
+    end
+    global.SensorIndex = lastIndex + 1
+  end
+
+  -- reset clock and chest index
+  if global.tickCount < UpdateInterval then
+    global.tickCount = global.tickCount + 1
+  else
+    global.tickCount = 1
+    global.SensorIndex = 1
+  end
 end
 
-
----- Logic ----
-
-function CreateItemSensor(entity)
-	global.ItemSensors = global.ItemSensors or {}
-
-	entity.operable = false
-	entity.rotatable = false
-	local itemSensor = {}
-	itemSensor.ID = entity.unit_number
-	itemSensor.Sensor = entity
-	itemSensor.ScanArea = GetScanArea(entity)
-	SetConnectedEntity(itemSensor)
-
-	global.ItemSensors[#global.ItemSensors+1] = itemSensor
+-- function OnTick(event)
+	-- local tick = game.tick
+	-- for i=1, #global.ItemSensors do
+		-- local itemSensor = global.ItemSensors[i]
+		-- if not itemSensor.SkipEntityScanning and (i + tick) % ScanInterval == 0 then
+			-- SetConnectedEntity(itemSensor)
+		-- end
+		-- if (i + tick) % UpdateInterval == 0 then
+			-- UpdateSensor(itemSensor)
+		-- end
+	-- end
+-- end
+
+---- LOGIC ----
+
+-- recalculates how many sensors are updated each tick
+function ResetStride()
+  if #global.ItemSensors > UpdateInterval then
+    global.SensorStride =  math.ceil(#global.ItemSensors/UpdateInterval)
+  else
+    global.SensorStride = 1
+  end
+  log("[IS] sride set to "..global.SensorStride)
 end
 
-function RemoveItemSensor(entity)
-	for i=#global.ItemSensors, 1, -1 do
-		if entity.unit_number == global.ItemSensors[i].ID then
-			table.remove(global.ItemSensors,i)
-		end
+
+function ResetSensors()
+  global.ItemSensors = global.ItemSensors or {}
+	for i=1, #global.ItemSensors do
+		local itemSensor = global.ItemSensors[i]
+		itemSensor.ID = itemSensor.Sensor.unit_number
+		itemSensor.ScanArea = GetScanArea(itemSensor.Sensor)
+		itemSensor.ConnectedEntity = nil
+		itemSensor.Inventory = {}
+		SetConnectedEntity(itemSensor)
 	end
 end
 
 function GetScanArea(sensor)
 	if sensor.direction == 0 then --south
-		 return{{sensor.position.x - BBox_offset, sensor.position.y}, {sensor.position.x + BBox_offset, sensor.position.y + BBox_range}}
+		 return{{sensor.position.x - ScanOffset, sensor.position.y}, {sensor.position.x + ScanOffset, sensor.position.y + ScanRange}}
 	elseif sensor.direction == 2 then --west
-		return{{sensor.position.x - BBox_range, sensor.position.y - BBox_offset}, {sensor.position.x, sensor.position.y + BBox_offset}}
+		return{{sensor.position.x - ScanRange, sensor.position.y - ScanOffset}, {sensor.position.x, sensor.position.y + ScanOffset}}
 	elseif sensor.direction == 4 then --north
-		return{{sensor.position.x - BBox_offset, sensor.position.y - BBox_range}, {sensor.position.x + BBox_offset, sensor.position.y}}
+		return{{sensor.position.x - ScanOffset, sensor.position.y - ScanRange}, {sensor.position.x + ScanOffset, sensor.position.y}}
 	elseif sensor.direction == 6 then --east
-		return{{sensor.position.x, sensor.position.y - BBox_offset}, {sensor.position.x + BBox_range, sensor.position.y + BBox_offset}}
+		return{{sensor.position.x, sensor.position.y - ScanOffset}, {sensor.position.x + ScanRange, sensor.position.y + ScanOffset}}
 	end
 end
 
@@ -143,14 +192,15 @@ function SetInventories(itemSensor, entity)
 		inv = entity.get_inventory(i)
 		if inv then
 			itemSensor.Inventory[#itemSensor.Inventory+1] = inv
-			-- log("adding inventory "..tostring(inv.index))
+			-- log("[IS] adding inventory "..tostring(inv.index))
 		end
 	end
 end
 
 function SetConnectedEntity(itemSensor)
+  itemSensor.LastScanned = game.tick
 	local connectedEntities = itemSensor.Sensor.surface.find_entities(itemSensor.ScanArea)
-	--printmsg("Found "..#connectedEntities.." entities in direction "..sensor.direction)
+	--printmsg("[IS] Found "..#connectedEntities.." entities in direction "..sensor.direction)
 	if connectedEntities then
 		for i=1, #connectedEntities do
 			local entity = connectedEntities[i]
@@ -185,7 +235,7 @@ function UpdateSensor(itemSensor)
 	if connectedEntity.type == LOCO then
 		if connectedEntity.train.state == defines.train_state.wait_station
 		or connectedEntity.train.state == defines.train_state.wait_signal
-		or connectedEntity.train.state == defines.train_state.manual_control then --keeps showing inventory for find_entity_interval ticks after movement start > neglect able
+		or connectedEntity.train.state == defines.train_state.manual_control then --keeps showing inventory for ScanInterval ticks after movement start > neglect able
 			signals[signalIndex] = {index = signalIndex, signal={type="virtual",name="inv-sensor-detected-locomotive"},count=1}
 			signalIndex = signalIndex+1
 		else -- train is moving > remove connection
@@ -198,7 +248,7 @@ function UpdateSensor(itemSensor)
 	elseif connectedEntity.type == WAGON or connectedEntity.type == WAGONFLUID then
 		if connectedEntity.train.state == defines.train_state.wait_station
 		or connectedEntity.train.state == defines.train_state.wait_signal
-		or connectedEntity.train.state == defines.train_state.manual_control then --keeps showing inventory for find_entity_interval ticks after movement start > neglect able
+		or connectedEntity.train.state == defines.train_state.manual_control then --keeps showing inventory for ScanInterval ticks after movement start > neglect able
 			signals[signalIndex] = {index = signalIndex, signal={type="virtual",name="inv-sensor-detected-wagon"},count=1}
 			signalIndex = signalIndex+1
 		else -- train is moving > remove connection
@@ -281,3 +331,33 @@ function UpdateSensor(itemSensor)
 
 	sensor.get_control_behavior().parameters = {parameters=signals}
 end
+
+
+---- INIT ----
+do
+local function init_events()
+	script.on_event({defines.events.on_built_entity, defines.events.on_robot_built_entity}, OnEntityCreated)
+	if global.ItemSensors and #global.ItemSensors > 0 then
+		script.on_event(defines.events.on_tick, OnTick)
+		script.on_event({defines.events.on_preplayer_mined_item, defines.events.on_robot_pre_mined, defines.events.on_entity_died}, OnEntityRemoved)
+	end
+end
+
+script.on_load(function()
+  init_events()
+end)
+
+script.on_init(function()
+  global.ItemSensors = global.ItemSensors or {}
+  ResetStride()
+  init_events()
+end)
+
+script.on_configuration_changed(function(data)
+  ResetSensors()
+  ResetStride()
+	init_events()
+  log("[IS] on_config_changed complete.")
+end)
+
+end

info.json

@@ -1,11 +1,11 @@
 {
   "name": "Inventory Sensor",
-  "version": "1.4.11",
+  "version": "1.5.1",
   "title": "Inventory Sensor",
   "author": "Optera",
   "contact": "https://forums.factorio.com/memberlist.php?mode=viewprofile&u=21729",
   "homepage": "https://forums.factorio.com/viewtopic.php?f=97&t=30454",
-  "description": "Adds a combinator that reads inventories of locomotives, wagons, cars, furnaces, assemblers, reactors and roboports.",
+  "description": "Adds a combinator that reads inventories of locomotives, wagons, cars, furnaces, assemblers, roboports, rocket silos and reactors.",
   "factorio_version": "0.15",
-	"dependencies": ["base >= 0.15.18"]
+	"dependencies": ["base >= 0.15.32"]
 }

locale/de/de.cfg

@@ -13,4 +13,4 @@ inv-sensor-detected-wagon=Güterwaggon Gefunden
 inv-sensor-detected-car=Auto Gefunden
 inv-sensor-detected-tank=Panzer Gefunden
 inv-sensor-temperature=Temperatur
-inv-sensor-progress=Fortschritt
+inv-sensor-progress=Fortschritt

locale/en/en.cfg

@@ -13,4 +13,16 @@ inv-sensor-detected-wagon=Cargo Wagon Detected
 inv-sensor-detected-car=Car Detected
 inv-sensor-detected-tank=Tank Detected
 inv-sensor-temperature=Temperature
-inv-sensor-progress=Crafting Progress
+inv-sensor-progress=Crafting Progress
+
+[mod-setting-name]
+inv_sensor_update_interval=Inventory update interval (ticks)
+inv_sensor_find_entity_interval=Entity scan interval (ticks)
+inv_sensor_BBox_range=Scan Range
+inv_sensor_BBox_offset=Scan Offset
+
+[mod-setting-description]
+inv_sensor_update_interval=How often inventories are updated.\nDefault = 10
+inv_sensor_find_entity_interval=How often for new/changed entities is scanned.\nDefault = 120
+inv_sensor_BBox_range=Length of search rectangle in front of sensors.\nWARNING, entities may not be detected properly after changing this value!\nDefault = 1.5
+inv_sensor_BBox_offset=Half width of search rectangle.\nWARNING, entities may not be detected properly after changing this value!\nDefault = 0.2

settings.lua

@@ -0,0 +1,32 @@
+data:extend({
+  {  
+    type = "int-setting",
+    name = "inv_sensor_update_interval",
+    order = "aa",
+    setting_type = "runtime-global",
+    default_value = 10,
+    minimum_value = 1,
+  },
+  {
+    type = "int-setting",
+    name = "inv_sensor_find_entity_interval",
+    order = "ab",
+    setting_type = "runtime-global",
+    default_value = 120,
+    minimum_value = 1,
+  },
+	{
+    type = "double-setting",
+    name = "inv_sensor_BBox_offset",
+    order = "ad",
+    setting_type = "runtime-global",
+		default_value = 0.2,
+  },
+  {
+    type = "double-setting",
+    name = "inv_sensor_BBox_range",
+    order = "ac",
+    setting_type = "runtime-global",
+		default_value = 1.5,
+  },
+})