The code to provide a city block tracker

control.lua

@@ -67,6 +67,8 @@ script.on_event(defines.events.on_gui_click, TLBE.GUI.onClick)
 script.on_event(defines.events.on_gui_selection_state_changed, TLBE.GUI.onSelected)
 script.on_event(defines.events.on_gui_text_changed, TLBE.GUI.onTextChanged)
 script.on_event(defines.events.on_gui_checked_state_changed, TLBE.GUI.onStateChanged)
+script.on_event(defines.events.on_gui_confirmed, TLBE.GUI.onGuiConfirmed)
+script.on_event(defines.events.on_gui_leave, TLBE.GUI.onGuiConfirmed)
 script.on_event(defines.events.on_runtime_mod_setting_changed, TLBE.Config.reload)
 script.on_event(defines.events.on_player_created, on_player_created)
 script.on_event(defines.events.on_player_joined_game, on_player_created)

locale/en/locale.cfg

@@ -14,6 +14,7 @@ tracker-area=Area Tracker
 tracker-base=Base Tracker
 tracker-player=Player Tracker
 tracker-rocket=Rocket Tracker
+tracker-cityBlock=City Block Tracker
 
 [gui]
 button-base-recalculate=Recalculate base size
@@ -37,6 +38,12 @@ label-type=Type:
 label-until-build=Follow until build
 label-zoom=Zoom:
 label-transitionperiod=Transition period:
+label-cityblock-size=Block size:
+label-cityblock-offset=Offset:
+label-cityblock-block=Block:
+label-cityblock-currentblock=Current:
+label-cityblock-blockScale=Scale:
+label-cityblock-centerOnPlayer=Select block:
 label-transition-speedgain=Transition speed gain:
 item-add-tracker=<Add Tracker>
 item-new-tracker=<New Tracker>
@@ -66,6 +73,18 @@ tracker-area-player=Use player coordinates to fill in this corner.
 tracker-smooth=Enable/Disable smooth behavior of the camera when this tracker is active.
 tracker-until-build=Follow the player until an entity is build.
 tracker-wrong-surface=Tracker is disabled because tracker surface differs from camera surface.
+tracker-cityblock-size=The size of a single city block in tiles.
+tracker-cityblock-size-x=The width of a single city block in tiles.
+tracker-cityblock-size-y=The height of a single city block in tiles.
+tracker-cityblock-offset=The number of tiles to shift the city blocks grid.
+tracker-cityblock-offset-x=The number of tiles right to shift the city blocks grid.
+tracker-cityblock-offset-y=The number of tiles down to shift the city blocks grid.
+tracker-cityblock-currentblock=The city block to focus on, counting in whole blocks.
+tracker-cityblock-currentblock-x=The position of the current city block, counting blocks rightwards.
+tracker-cityblock-currentblock-y=The position of the current city block, counting blocks downwards.
+tracker-cityblock-blockScale=How many city blocks to zoom out, centered on the current block.
+tracker-cityblock-blockScale-value=A zoom of 3 will capture the current block and all of the neighbours. <enter> to set.
+tracker-cityblock-player=Use player coordinates to select the current city block.
 
 [controls]
 tlbe-main-window-toggle=Open/Close camera settings

prototypes/signal.lua

@@ -1,5 +1,5 @@
-local capture_tint = { 0.9, 0.9, 0.9 }
-local target_tint = { 0.1, 0.6, 0.2 }
+local captureTint = { 0.9, 0.9, 0.9 }
+local targetTint = { 0.1, 0.6, 0.2 }
 
 data:extend({
     {
@@ -14,7 +14,7 @@ data:extend({
         icons = {
             {
                 icon = "__TLBE__/graphics/box-north-west.png",
-                tint = capture_tint
+                tint = captureTint
             }
         },
         icon_size = 32,
@@ -28,7 +28,7 @@ data:extend({
         icons = {
             {
                 icon = "__TLBE__/graphics/box-south-west.png",
-                tint = capture_tint,
+                tint = captureTint,
             }
         },
         icon_size = 32,
@@ -42,7 +42,7 @@ data:extend({
         icons = {
             {
                 icon = "__TLBE__/graphics/box-south-east.png",
-                tint = capture_tint
+                tint = captureTint
             }
         },
         icon_size = 32,
@@ -57,7 +57,7 @@ data:extend({
         icons = {
             {
                 icon = "__TLBE__/graphics/box-north-east.png",
-                tint = capture_tint,
+                tint = captureTint,
             }
         },
         icon_size = 32,
@@ -71,7 +71,7 @@ data:extend({
         icons = {
             {
                 icon = "__TLBE__/graphics/box-north-west.png",
-                tint = target_tint
+                tint = targetTint
             }
         },
         icon_size = 32,
@@ -85,7 +85,7 @@ data:extend({
         icons = {
             {
                 icon = "__TLBE__/graphics/box-south-west.png",
-                tint = target_tint,
+                tint = targetTint,
             }
         },
         icon_size = 32,
@@ -99,11 +99,10 @@ data:extend({
         icons = {
             {
                 icon = "__TLBE__/graphics/box-south-east.png",
-                tint = target_tint
+                tint = targetTint
             }
         },
         icon_size = 32,
-        tint = { 0, 1, 0 },
         icon_mipmaps = 1,
         subgroup = "tlbe-virtual-signal",
         order = "g"
@@ -114,7 +113,7 @@ data:extend({
         icons = {
             {
                 icon = "__TLBE__/graphics/box-north-east.png",
-                tint = target_tint,
+                tint = targetTint,
             }
         },
         icon_size = 32,

scripts/gui.lua

@@ -1,11 +1,12 @@
 local GUI = {
-    allTrackers = { "area", "base", "player", "rocket" },
-    allTrackersLabels = { { "tracker-area" }, { "tracker-base" }, { "tracker-player" }, { "tracker-rocket" } },
+    allTrackers = { "area", "base", "cityblock", "player", "rocket" },
+    allTrackersLabels = { { "tracker-area" }, { "tracker-base" }, { "tracker-cityBlock" }, { "tracker-player" }, { "tracker-rocket" } },
     allTrackersLabelsMap = {
         area = { "tracker-area" },
         base = { "tracker-base" },
+        cityBlock = { "tracker-cityBlock" },
         player = { "tracker-player" },
-        rocket = { "tracker-rocket" }
+        rocket = { "tracker-rocket" },
     }
 }
 
@@ -212,6 +213,12 @@ function GUI.onClick(event)
             GUI.updateTrackerConfig(playerSettings.gui.trackerInfo, selectedTracker)
             GUI.updateTrackerInfo(playerSettings.gui.trackerInfo, selectedTracker)
         end
+    elseif event.element.name == "tlbe-tracker-cityblock-player" then
+        local selectedTracker = playerSettings.trackers[playerSettings.guiPersist.selectedTracker]
+        Tracker.focusCityBlock(selectedTracker, player.position)
+
+        GUI.updateTrackerConfig(playerSettings.gui.trackerInfo, selectedTracker)
+        GUI.updateTrackerInfo(playerSettings.gui.trackerInfo, selectedTracker)
     else
         local _, index
         _, _, index = event.element.name:find("^camera_tracker_(%d+)$")
@@ -591,6 +598,81 @@ function GUI.onTextChanged(event)
             selectedTracker.maxPos.x = value
             Tracker.areaUpdateCenterAndSize(selectedTracker)
 
+            GUI.updateTrackerConfig(playerSettings.gui.trackerInfo, selectedTracker)
+            GUI.updateTrackerInfo(playerSettings.gui.trackerInfo, selectedTracker)
+        end
+    elseif event.element.name == "tlbe-tracker-cityblock-size-x" and event.element.text ~= nil then
+        local selectedTracker = playerSettings.trackers[playerSettings.guiPersist.selectedTracker]
+        local value = tonumber(event.element.text)
+        if value ~= nil and value >= 1 then
+            selectedTracker.cityBlock.blockSize.x = math.floor(value)
+            Tracker.recalculateCityBlock(selectedTracker)
+
+            GUI.updateTrackerConfig(playerSettings.gui.trackerInfo, selectedTracker)
+            GUI.updateTrackerInfo(playerSettings.gui.trackerInfo, selectedTracker)
+        end
+    elseif event.element.name == "tlbe-tracker-cityblock-size-y" and event.element.text ~= nil then
+        local selectedTracker = playerSettings.trackers[playerSettings.guiPersist.selectedTracker]
+        local value = tonumber(event.element.text)
+        if value ~= nil and value >= 1 then
+            selectedTracker.cityBlock.blockSize.y = math.floor(value)
+            Tracker.recalculateCityBlock(selectedTracker)
+
+            GUI.updateTrackerConfig(playerSettings.gui.trackerInfo, selectedTracker)
+            GUI.updateTrackerInfo(playerSettings.gui.trackerInfo, selectedTracker)
+        end
+    elseif event.element.name == "tlbe-tracker-cityblock-offset-x" and event.element.text ~= nil then
+        local selectedTracker = playerSettings.trackers[playerSettings.guiPersist.selectedTracker]
+        local value = tonumber(event.element.text)
+        if value ~= nil then
+            selectedTracker.cityBlock.blockOffset.x = math.floor(value)
+            Tracker.recalculateCityBlock(selectedTracker)
+
+            GUI.updateTrackerConfig(playerSettings.gui.trackerInfo, selectedTracker)
+            GUI.updateTrackerInfo(playerSettings.gui.trackerInfo, selectedTracker)
+        end
+    elseif event.element.name == "tlbe-tracker-cityblock-offset-y" and event.element.text ~= nil then
+        local selectedTracker = playerSettings.trackers[playerSettings.guiPersist.selectedTracker]
+        local value = tonumber(event.element.text)
+        if value ~= nil then
+            selectedTracker.cityBlock.blockOffset.y = math.floor(value)
+            Tracker.recalculateCityBlock(selectedTracker)
+
+            GUI.updateTrackerConfig(playerSettings.gui.trackerInfo, selectedTracker)
+            GUI.updateTrackerInfo(playerSettings.gui.trackerInfo, selectedTracker)
+        end
+    elseif event.element.name == "tlbe-tracker-cityblock-currentblock-x" and event.element.text ~= nil then
+        local selectedTracker = playerSettings.trackers[playerSettings.guiPersist.selectedTracker]
+        local value = tonumber(event.element.text)
+        if value ~= nil then
+            selectedTracker.cityBlock.currentBlock.x = math.floor(value)
+            Tracker.recalculateCityBlock(selectedTracker)
+
+            GUI.updateTrackerConfig(playerSettings.gui.trackerInfo, selectedTracker)
+            GUI.updateTrackerInfo(playerSettings.gui.trackerInfo, selectedTracker)
+        end
+    elseif event.element.name == "tlbe-tracker-cityblock-currentblock-y" and event.element.text ~= nil then
+        local selectedTracker = playerSettings.trackers[playerSettings.guiPersist.selectedTracker]
+        local value = tonumber(event.element.text)
+        if value ~= nil then
+            selectedTracker.cityBlock.currentBlock.y = math.floor(value)
+            Tracker.recalculateCityBlock(selectedTracker)
+
+            GUI.updateTrackerConfig(playerSettings.gui.trackerInfo, selectedTracker)
+            GUI.updateTrackerInfo(playerSettings.gui.trackerInfo, selectedTracker)
+        end
+    end
+end
+
+function GUI.onGuiConfirmed(event)
+    local playerSettings = global.playerSettings[event.player_index]
+    if event.element.name == "tlbe-tracker-cityblock-blockScale-value" and event.element.text ~= nil then
+        local selectedTracker = playerSettings.trackers[playerSettings.guiPersist.selectedTracker]
+        local value = tonumber(event.element.text)
+        if value ~= nil then
+            selectedTracker.cityBlock.blockScale = math.floor(value * 100)/100
+            Tracker.recalculateCityBlock(selectedTracker)
+
             GUI.updateTrackerConfig(playerSettings.gui.trackerInfo, selectedTracker)
             GUI.updateTrackerInfo(playerSettings.gui.trackerInfo, selectedTracker)
         end
@@ -1426,6 +1508,110 @@ function GUI.createTrackerConfigAndInfo(trackerInfo, tracker)
                 tooltip = { "tooltip.tracker-until-build" },
                 state = tracker.untilBuild
             }
+        elseif tracker.type == "cityblock" then
+            trackerInfo.add { 
+                type = "label",
+                caption = { "gui.label-cityblock-size" },
+                tooltip = { "tooltip.tracker-cityblock-size" },
+                style = "description_property_name_label"
+            }
+            local sizeFlow = trackerInfo.add { type = "flow", name = "cityblock-size" }
+            sizeFlow.add {
+                type = "textfield",
+                name = "tlbe-tracker-cityblock-size-x",
+                style = "tlbe_config_half_width_textfield",
+                tooltip = { "tooltip.tracker-cityblock-size-x" },
+                numeric = true,
+                allow_negative = true
+            }
+            sizeFlow.add { type = "label", caption = "/", style = "tlbe_config_half_width_label" }
+            sizeFlow.add {
+                type = "textfield",
+                name = "tlbe-tracker-cityblock-size-y",
+                style = "tlbe_config_half_width_textfield",
+                tooltip = { "tooltip.tracker-cityblock-size-y" },
+                numeric = true,
+                allow_negative = true
+            }
+
+            trackerInfo.add { 
+                type = "label",
+                caption = { "gui.label-cityblock-offset" },
+                tooltip = { "tooltip.tracker-cityblock-offset" },
+                style = "description_property_name_label"
+            }
+            local offsetFlow = trackerInfo.add { type = "flow", name = "cityblock-offset" }
+            offsetFlow.add {
+                type = "textfield",
+                name = "tlbe-tracker-cityblock-offset-x",
+                style = "tlbe_config_half_width_textfield",
+                tooltip = { "tooltip.tracker-cityblock-offset-x" },
+                numeric = true,
+                allow_negative = true
+            }
+            offsetFlow.add { type = "label", caption = "/", style = "tlbe_config_half_width_label" }
+            offsetFlow.add {
+                type = "textfield",
+                name = "tlbe-tracker-cityblock-offset-y",
+                style = "tlbe_config_half_width_textfield",
+                tooltip = { "tooltip.tracker-cityblock-offset-y" },
+                numeric = true,
+                allow_negative = true
+            }
+
+            trackerInfo.add { 
+                type = "label",
+                caption = { "gui.label-cityblock-currentblock" },
+                tooltip = { "tooltip.tracker-cityblock-currentblock" },
+                style = "description_property_name_label"
+            }
+            local blockFlow = trackerInfo.add { type = "flow", name = "cityblock-block" }
+            blockFlow.add {
+                type = "textfield",
+                name = "tlbe-tracker-cityblock-currentblock-x",
+                style = "tlbe_config_half_width_textfield",
+                tooltip = { "tooltip.tracker-cityblock-currentblock-x" },
+                numeric = true,
+                allow_negative = true
+            }
+            blockFlow.add { type = "label", caption = "/", style = "tlbe_config_half_width_label" }
+            blockFlow.add {
+                type = "textfield",
+                name = "tlbe-tracker-cityblock-currentblock-y",
+                style = "tlbe_config_half_width_textfield",
+                tooltip = { "tooltip.tracker-cityblock-currentblock-y" },
+                numeric = true,
+                allow_negative = true
+            }
+
+            trackerInfo.add { 
+                type = "label",
+                caption = { "gui.label-cityblock-blockScale" },
+                tooltip = { "tooltip.tracker-cityblock-blockScale" },
+                style = "description_property_name_label"
+            }
+            trackerInfo.add {
+                type = "textfield",
+                name = "tlbe-tracker-cityblock-blockScale-value",
+                style = "tlbe_config_half_width_textfield",
+                tooltip = { "tooltip.tracker-cityblock-blockScale-value" },
+                numeric = true,
+                allow_decimal = true,
+                allow_negative = false
+            }
+
+            trackerInfo.add {
+                type = "label",
+                caption = { "gui.label-cityblock-centerOnPlayer" },
+                style = "description_property_name_label"
+            }
+            trackerInfo.add {
+                type = "sprite-button",
+                name = "tlbe-tracker-cityblock-player",
+                tooltip = { "tooltip.tracker-cityblock-player" },
+                sprite = "utility/show_player_names_in_map_view_black",
+                style = "tlbe_config_button"
+            }
         end
     end
 
@@ -1447,6 +1633,8 @@ function GUI.createTrackerConfigAndInfo(trackerInfo, tracker)
     GUI.updateTrackerInfo(trackerInfo, tracker)
 end
 
+---@param trackerInfo any
+---@param tracker Tracker.tracker
 function GUI.updateTrackerConfig(trackerInfo, tracker)
     if tracker == nil then
         trackerInfo["tracker-name"].enabled = false
@@ -1488,6 +1676,25 @@ function GUI.updateTrackerConfig(trackerInfo, tracker)
             blFlow["tlbe-tracker-left"].style = style
         elseif tracker.type == "player" then
             trackerInfo["tracker-untilbuild"].state = tracker.untilBuild
+        elseif tracker.type == "cityblock" then
+            local cityBlock = tracker.cityBlock
+            if cityBlock == nil then
+                return
+            end
+
+            local sizeFlow = trackerInfo["cityblock-size"]
+            sizeFlow["tlbe-tracker-cityblock-size-x"].text = string.format("%d", cityBlock.blockSize.x)
+            sizeFlow["tlbe-tracker-cityblock-size-y"].text = string.format("%d", cityBlock.blockSize.y)
+
+            local offsetFlow = trackerInfo["cityblock-offset"]
+            offsetFlow["tlbe-tracker-cityblock-offset-x"].text = string.format("%d", cityBlock.blockOffset.x)
+            offsetFlow["tlbe-tracker-cityblock-offset-y"].text = string.format("%d", cityBlock.blockOffset.y)
+
+            local blockFlow = trackerInfo["cityblock-block"]
+            blockFlow["tlbe-tracker-cityblock-currentblock-x"].text = string.format("%d", cityBlock.currentBlock.x)
+            blockFlow["tlbe-tracker-cityblock-currentblock-y"].text = string.format("%d", cityBlock.currentBlock.y)
+
+            trackerInfo["tlbe-tracker-cityblock-blockScale-value"].text = string.format("%g", cityBlock.blockScale)
         end
     end
 end