chore: Merge pull request #2 from noodlebox/issue-1

Fix caching of limbo containers

Author: noodlebox

migrations/limbo-cull.lua

@@ -0,0 +1,22 @@
+-- Cull limbo chests that were created due to a bug in inventory-selector <=1.0.0
+-- See: https://github.com/noodlebox/factorio-inventory-selector/issues/1
+
+local limbo = require("script.limbo")
+
+-- First, reassign any proxies to properly placed limbo containers, if necessary
+for _, selector in pairs(storage.selectors) do
+    local proxy = selector.proxy
+    if proxy and proxy.valid then
+        local target = proxy.proxy_target_entity
+        if target and target.valid and target.name == "inventory-selector-limbo" then
+            proxy.proxy_target_entity = limbo[proxy.surface_index]
+        end
+    end
+end
+
+-- Then, remove the misplaced limbo containers
+for _, surface in pairs(game.surfaces) do
+    for _, entity in pairs(surface.find_entities_filtered{ name="inventory-selector-limbo", position={0.5,0.5} }) do
+        entity.destroy()
+    end
+end

script/limbo.lua

@@ -35,16 +35,19 @@ local origin = {0, 0}
 -- issues because of the change to the behavior of entity prototype flags concerning automated interaction.
 -- TODO: Open a new bug report for these issues once explored a bit more.
 local limbo = setmetatable({}, {
-    ---@param surface LuaSurface
+    ---@param surface_index uint
     ---@return LuaEntity?
-    __index = function(self, surface)
+    __index = function(self, surface_index)
+        local surface = game.surfaces[surface_index]
+        if not surface then return nil end
         local entity = surface.find_entity("inventory-selector-limbo", origin)
         if not entity then
             -- Any and all flags that can be set to make this entity as invisible and uninteractable as possible
             -- should be present here.
             entity = surface.create_entity{
                 name = "inventory-selector-limbo",
                 position = origin,
+                snap_to_grid = false,
                 force = game.forces.neutral,
                 create_build_effect_smoke = false,
                 preserve_ghosts_and_corpses = true,
@@ -55,10 +58,9 @@ local limbo = setmetatable({}, {
             entity.active = false
         end
         -- Cache the reference for future lookups
-        self[surface] = entity
+        self[surface_index] = entity
         return entity
     end,
-    __mode = "k",
 })
 
 return limbo

script/selector.lua

@@ -265,7 +265,7 @@ function selector:update_proxy_inventory()
 
     ::limbo::
     -- The target wasn't valid for some reason, so just prepare a limbo container
-    target = limbo[proxy.surface]
+    target = limbo[proxy.surface_index]
     index = inventory.get_inventory_info(target, "main") or defines.inventory.chest -- 1
 
     ::assign::
@@ -826,6 +826,12 @@ local library = {
     on_load = register_tick_handlers,
     ---@type table<defines.events, function>
     events = {
+        [defines.events.on_surface_cleared] = function (event)
+            limbo[event.surface_index] = nil
+        end,
+        [defines.events.on_surface_deleted] = function (event)
+            limbo[event.surface_index] = nil
+        end,
         [defines.events.on_object_destroyed] = on_object_destroyed,
         [defines.events.on_player_rotated_entity] = on_entity_modified,
         [defines.events.on_player_flipped_entity] = on_entity_modified,