Merge pull request #24 from Atria1234/sort-by-category-count

Added mod setting to switch between sorting results by distance from player and item/fluid count

Author: tburrows13

control.lua

@@ -95,9 +95,7 @@ require "scripts.remote"
 ---@field resource_count? number
 ---@field distance? number
 
----@alias EntitySurfaceData EntityGroup[]
-
----@alias CategorisedSurfaceData table<EntityName, EntitySurfaceData>
+---@alias CategorisedSurfaceData EntityGroup[]
 
 ---@alias SurfaceDataCategoryName "consumers"|"producers"|"storage"|"logistics"|"modules"|"requesters"|"ground_items"|"entities"|"signals"|"map_tags"
 ---@alias SurfaceData table<SurfaceDataCategoryName, CategorisedSurfaceData>

locale/en/FactorySearch.cfg

@@ -14,6 +14,7 @@ fs-chunks-per-tick=Chunks per tick
 fs-initial-zoom=Zoom level
 fs-clear-highlights-with-gui=Clear highlights when closing interface
 fs-highlight-duration=Highlight duration
+fs-sort-results-by=Sort results by
 
 [mod-setting-description]
 fs-non-blocking-search=Searching takes much longer but doesn't freeze the game.
@@ -26,6 +27,9 @@ fs-highlight-duration=Number of seconds that highlight boxes and arrows exist fo
 fs-non-blocking-search-on=On
 fs-non-blocking-search-multiplayer=Multiplayer only
 fs-non-blocking-search-off=Off
+fs-sort-results-by-name=Entity name
+fs-sort-results-by-distance=Distance from player
+fs-sort-results-by-count=Item/fluid count
 
 [search-gui]
 keep-open=Keep open

scripts/search-gui.lua

@@ -19,78 +19,77 @@ end
 ---@return GuiElemDef[]
 function SearchGui.build_surface_results(surface_name, surface_data)
   local gui_elements = {}
-  for entity_name, entity_surface_data in pairs(surface_data) do
-    for _, group in pairs(entity_surface_data) do
-      local distance_info = {""}
-      if group.distance then
-        distance_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"search-gui.distance-tooltip"}, ":[/color][/font] ", util.format_number(math.ceil(group.distance), true), "m"}
+  for _, group in pairs(surface_data) do
+    local entity_name = group.entity_name
+    local distance_info = {""}
+    if group.distance then
+      distance_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"search-gui.distance-tooltip"}, ":[/color][/font] ", util.format_number(math.ceil(group.distance), true), "m"}
+    end
+    local extra_info = {""}
+    if group.recipe_list then
+      extra_info = {""}
+      local multiple_recipes = false
+      local number_of_recipes = 0
+      for _ in pairs(group.recipe_list) do number_of_recipes = number_of_recipes + 1 end
+
+      if number_of_recipes > 1 then
+        multiple_recipes = true
       end
-      local extra_info = {""}
-      if group.recipe_list then
-        extra_info = {""}
-        local multiple_recipes = false
-        local number_of_recipes = 0
-        for _ in pairs(group.recipe_list) do number_of_recipes = number_of_recipes + 1 end
-
-        if number_of_recipes > 1 then
-          multiple_recipes = true
-        end
-        if number_of_recipes <= 10 then
-          -- Localised strings must not have more than 20 parameters
-          for name, recipe_info in pairs(group.recipe_list) do
-            local string = "\n"
-            if multiple_recipes then
-              string = string .. "[font=default-bold]" .. recipe_info.count .. " × [/font]"
-            end
-            string = string .. "[recipe=" .. name .. "] "
-            table.insert(extra_info, string)
-            table.insert(extra_info, recipe_info.localised_name)
+      if number_of_recipes <= 10 then
+        -- Localised strings must not have more than 20 parameters
+        for name, recipe_info in pairs(group.recipe_list) do
+          local string = "\n"
+          if multiple_recipes then
+            string = string .. "[font=default-bold]" .. recipe_info.count .. " × [/font]"
           end
+          string = string .. "[recipe=" .. name .. "] "
+          table.insert(extra_info, string)
+          table.insert(extra_info, recipe_info.localised_name)
         end
       end
-      if group.item_count then
-        extra_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"gui-train.add-item-count-condition"}, ":[/color][/font] ", util.format_number(math.floor(group.item_count), true)}
-      end
-      if group.fluid_count then
-        extra_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"gui-train.add-fluid-count-condition"}, ":[/color][/font] ", util.format_number(math.floor(group.fluid_count), true)}
-      end
-      if group.module_count then
-        extra_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"search-gui.module-count-tooltip"}, ":[/color][/font] ", util.format_number(math.floor(group.module_count), true)}
-      end
-      if group.request_count then
-        extra_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"search-gui.request-count-tooltip"}, ":[/color][/font] ", util.format_number(math.floor(group.request_count), true)}
-      end
-      if group.signal_count then
-        extra_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"search-gui.signal-count-tooltip"}, ":[/color][/font] ", util.format_number(math.floor(group.signal_count), true)}
-      end
-      local sprite = "entity/" .. entity_name
+    end
+    if group.item_count then
+      extra_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"gui-train.add-item-count-condition"}, ":[/color][/font] ", util.format_number(math.floor(group.item_count), true)}
+    end
+    if group.fluid_count then
+      extra_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"gui-train.add-fluid-count-condition"}, ":[/color][/font] ", util.format_number(math.floor(group.fluid_count), true)}
+    end
+    if group.module_count then
+      extra_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"search-gui.module-count-tooltip"}, ":[/color][/font] ", util.format_number(math.floor(group.module_count), true)}
+    end
+    if group.request_count then
+      extra_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"search-gui.request-count-tooltip"}, ":[/color][/font] ", util.format_number(math.floor(group.request_count), true)}
+    end
+    if group.signal_count then
+      extra_info = {"", "\n[font=default-semibold][color=255, 230, 192]", {"search-gui.signal-count-tooltip"}, ":[/color][/font] ", util.format_number(math.floor(group.signal_count), true)}
+    end
+    local sprite = "entity/" .. entity_name
+    if not helpers.is_valid_sprite_path(sprite) then
+      sprite = "item/" .. entity_name
       if not helpers.is_valid_sprite_path(sprite) then
-        sprite = "item/" .. entity_name
+        sprite = "fluid/" .. entity_name
         if not helpers.is_valid_sprite_path(sprite) then
-          sprite = "fluid/" .. entity_name
+          sprite = "recipe/" .. entity_name
           if not helpers.is_valid_sprite_path(sprite) then
-            sprite = "recipe/" .. entity_name
+            sprite = "virtual-signal/" .. entity_name
             if not helpers.is_valid_sprite_path(sprite) then
-              sprite = "virtual-signal/" .. entity_name
-              if not helpers.is_valid_sprite_path(sprite) then
-                sprite = "utility/questionmark"
-              end
+              sprite = "utility/questionmark"
             end
           end
         end
       end
-      table.insert(gui_elements,
-        {
-          type = "sprite-button",
-          sprite = sprite,
-          tooltip = {"", "[font=default-bold]", group.localised_name, "[/font]", distance_info, extra_info, "\n", {"search-gui.result-tooltip"}},
-          style = "slot_button",
-          number = group.resource_count or group.count,
-          tags = {position = group.avg_position, surface = surface_name, selection_boxes = group.selection_boxes},
-          handler = {[defines.events.on_gui_click] = SearchGui.open_location_on_map}
-        }
-      )
     end
+    table.insert(gui_elements,
+      {
+        type = "sprite-button",
+        sprite = sprite,
+        tooltip = {"", "[font=default-bold]", group.localised_name, "[/font]", distance_info, extra_info, "\n", {"search-gui.result-tooltip"}},
+        style = "slot_button",
+        number = group.resource_count or group.count,
+        tags = {position = group.avg_position, surface = surface_name, selection_boxes = group.selection_boxes},
+        handler = {[defines.events.on_gui_click] = SearchGui.open_location_on_map}
+      }
+    )
   end
   return gui_elements
 end
@@ -223,14 +222,13 @@ function SearchGui.build_results(data, statistics, frame, check_result_found, in
     local surface_contains_results = false
     for _, category_data in pairs(surface_data) do
       -- TODO surface_statistics check here?
-      surface_contains_results = surface_contains_results or not not next(category_data)
+      surface_contains_results = surface_contains_results or table_size(category_data) > 0
     end
     result_found = result_found or surface_contains_results
     if not surface_contains_results then
       goto continue
     end
 
-    -- TODO sort somewhere before showing storage, modules, requesters, ...
     gui.add(frame, {
       SearchGui.build_surface_name(include_surface_name, surface_name),
       SearchGui.build_surface_count(statistics[surface_name], include_surface_name),

scripts/search-results.lua

@@ -11,10 +11,9 @@ function SearchResults.add_entity(entity, surface_data)
   local entity_name = entity.name
   local entity_position = entity.position
   local entity_selection_box = entity.selection_box
-  local entity_surface_data = surface_data[entity_name] or {}
   ---@type EntityGroup?
   local assigned_group
-  for _, group in pairs(entity_surface_data) do
+  for _, group in pairs(surface_data) do
     if entity_name == group.entity_name and math2d.bounding_box.collides_with(entity_selection_box, group.selection_box) then
       -- Add entity to group
       assigned_group = group
@@ -58,9 +57,8 @@ function SearchResults.add_entity(entity, surface_data)
       selection_boxes = {[1] = entity.selection_box},
       localised_name = entity.localised_name,
     }
-    table.insert(entity_surface_data, assigned_group)
+    table.insert(surface_data, assigned_group)
   end
-  surface_data[entity_name] = entity_surface_data
   return assigned_group
 end
 
@@ -143,10 +141,6 @@ end
 ---@param tag LuaCustomChartTag
 ---@param surface_data CategorisedSurfaceData
 function SearchResults.add_tag(tag, surface_data)
-  -- An alternative to add_entity*, for map tags
-  local icon_name = tag.icon.name  ---@cast icon_name -?
-  local tag_surface_data = surface_data[icon_name] or {}
-
   -- Tag groups always have size 1
   local tag_position = tag.position
   local tag_box_size = 8
@@ -174,9 +168,7 @@ function SearchResults.add_tag(tag, surface_data)
     },
     localised_name = localised_name,
   }
-  table.insert(tag_surface_data, group)
-
-  surface_data[icon_name] = tag_surface_data
+  table.insert(surface_data, group)
 end
 
 ---@param category SurfaceStatisticsCategoryName

scripts/search.lua

@@ -114,14 +114,13 @@ local function add_entity_type(type_list, to_add_list)
   end
 end
 
+---@param surface_data SurfaceData
+---@param player_position MapPosition
 local function generate_distance_data(surface_data, player_position)
   local distance = math2d.position.distance
-  for _, entity_groups in pairs(surface_data) do
-    for _, groups in pairs(entity_groups) do
-      for _, group in pairs(groups) do
-        group.distance = distance(group.avg_position, player_position)
-      end
-      table.sort(groups, function (k1, k2) return k1.distance < k2.distance end)
+  for _, groups in pairs(surface_data) do
+    for _, group in pairs(groups) do
+      group.distance = distance(group.avg_position, player_position)
     end
   end
 end
@@ -693,6 +692,41 @@ local function get_target_entity_names(target_item)
   end
 end
 
+--- @type table<SurfaceDataCategoryName, string[]>
+local sort_categories_by = {
+  consumers = {'count'},
+  producers = {'count'},
+  storage = {'item_count', 'fluid_count'},
+  logistics = {'item_count', 'fluid_count'},
+  modules = {'module_count'},
+  requesters = {'request_count'},
+  ground_items = {'count'},
+  entities = {'resource_count', 'count'},
+  signals = {'count'}
+}
+
+---@param surface_data SurfaceData
+---@param player LuaPlayer
+local function sort_surface_data(surface_data, player)
+  for category, groups in pairs(surface_data) do
+    local sort_by = player.mod_settings["fs-sort-results-by"].value
+    if sort_by == 'distance' then
+      table.sort(groups, function (k1, k2) return (k1.distance or math.huge) < (k2.distance or math.huge) end)
+    elseif sort_by == 'name' then
+      table.sort(groups, function (k1, k2) return k1.entity_name < k2.entity_name end)
+    elseif sort_by == 'count' and sort_categories_by[category] then
+      table.sort(groups, function (k1, k2)
+        for _, property_name in ipairs(sort_categories_by[category]) do
+          if k1[property_name] ~= nil and k2[property_name] ~= nil then
+            return k1[property_name] > k2[property_name]
+          end
+        end
+        return false
+      end)
+    end
+  end
+end
+
 ---@param force LuaForce
 ---@param state SearchGuiState
 ---@param target_item SignalID
@@ -772,6 +806,7 @@ function Search.blocking_search(force, state, target_item, surface_list, type_li
     if surface == player.surface then
       generate_distance_data(surface_data, player.position)
     end
+    sort_surface_data(surface_data, player)
     data[surface.name] = surface_data
     statistics[surface.name] = surface_statistics
     ::continue::
@@ -811,11 +846,6 @@ function on_tick()
     next_surface = table.remove(search_data.not_started_surfaces)
     if not next_surface then
       -- All surfaces are complete
-      local player = search_data.player
-      local surface_data = search_data.data[player.surface.name]
-      if surface_data then
-        generate_distance_data(surface_data, player.position)
-      end
       search_data.search_complete = true
       return
     end
@@ -852,6 +882,11 @@ function on_tick()
     local chunk = chunk_iterator()
     if not chunk then
       -- Surface is complete
+      if current_surface_search_data.surface == search_data.player.surface then
+        generate_distance_data(current_surface_search_data.surface_data, search_data.player.position)
+      end
+      sort_surface_data(current_surface_search_data.surface_data, search_data.player)
+
       search_data.data[current_surface.name] = current_surface_search_data.surface_data
       search_data.statistics[current_surface.name] = current_surface_search_data.surface_statistics
       search_data.current_surface_search_data = nil

settings.lua

@@ -41,4 +41,12 @@ data:extend{
     maximum_value = 1000,
     order = "bb"
   },
+  {
+    type = "string-setting",
+    name = "fs-sort-results-by",
+    setting_type = "runtime-per-user",
+    default_value = "name",
+    allowed_values = {"name", "distance", "count"},
+    order = "bc"
+  },
 }