fix: Cache limbo containers by surface_id instead of LuaSurface (#1)

Author: noodlebox

script/limbo.lua

@@ -35,9 +35,11 @@ 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
@@ -56,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,