Up version

README.md

@@ -2,7 +2,7 @@
 <img src=https://raw.githubusercontent.com/Wyrrrd/Gun_Turret_Alerts/master/thumbnail.png width="128" height="128">
 
 ### Description
-Adds alerts when a gun turret, vehicle or artillery is out of ammo or has low ammo. The amount of ammo considered low can be configured. Alerts for turrets, vehicles and artillery can be disabled separately. Behaviour on vehicles with multiple ammo slots can be configured (for all vehicles at once).
+Adds alerts when a gun turret, vehicle or artillery is out of ammo or has low ammo. The amount of ammo considered low can be configured. Alerts for turrets, vehicles and artillery can be disabled separately. Behaviour on vehicles with multiple ammo slots can be configured (for all vehicles at once). Alerts on other planets or space platforms can be enabled.
 
 ### Locale
 If you want to contribute by translating this mod, you can view the existing translations on [Crowdin](https://crowdin.com/project/factorio-mods-localization). I'd be happy to add your language and credits to the next release.
@@ -12,4 +12,4 @@ Thanks to [unhott](https://mods.factorio.com/user/unhott) for the [original mod]
 Thanks to [snouz](https://mods.factorio.com/user/snouz) for the new icons and thumbnail.  
 Thanks to [Friendch](https://mods.factorio.com/user/Friendch) for the french locale.  
 Thanks to [eugenikus8](https://github.com/eugenikus8) for the russian locale.  
-Thanks to [Met_en_Bouldry](https://crowdin.com/profile/Met_en_Bouldry) for the ukranian locale.  
+Thanks to [Met_en_Bouldry](https://crowdin.com/profile/Met_en_Bouldry) for the ukrainian locale.  

changelog.txt

@@ -1,4 +1,45 @@
 ---------------------------------------------------------------------------------------------------
+Version: 2.0.7
+Date: 2024-11-10
+  Optimizations:
+    - Add cleanup of empty global tables
+    - Move global table creation from on_surface_created to on_built_entity to save on event
+      listeners
+    - Review force rename/removal handling
+    - Code cleanup and comments
+---------------------------------------------------------------------------------------------------
+Version: 2.0.6
+Date: 2024-11-10
+  Features:
+    - Add support to enable alerts for other surfaces (before, alerts were only generated for the
+      current surface)
+  Bugfixes:
+    - Fix additional surface handling (when a new surface was created, from then on entities were
+      not added to the global list until all players of a force leave and join again, which is
+      technically impossible in single player)
+---------------------------------------------------------------------------------------------------
+Version: 2.0.5
+Date: 2024-11-09
+  Bugfixes:
+    - Really fix the crash on surface deletion
+---------------------------------------------------------------------------------------------------
+Version: 2.0.4
+Date: 2024-11-09
+  Bugfixes:
+    - Fix another crash on surface deletion
+---------------------------------------------------------------------------------------------------
+Version: 2.0.3
+Date: 2024-11-08
+  Bugfixes:
+    - Fixed crash on invalid entity
+---------------------------------------------------------------------------------------------------
+Version: 2.0.2
+Date: 2024-11-08
+  Changes:
+    - Cleanup tracking table on surface rename/deletion
+  Bugfixes:
+    - Quick fix setting for manual turret fill
+---------------------------------------------------------------------------------------------------
 Version: 2.0.1
 Date: 2024-11-06
   Locale:
@@ -13,10 +54,6 @@ Date: 2024-10-27
     - Renamed car group to vehicle group in all languages
   Features:
     - Added spidertrons to vehicle group
-  Info:
-    - Planned: Switch from surface names to surface indexes (as names can change)
-    - Planned: Cleanup tracking table on surface deletion (may happen with space platforms)
-    - Planned: Add settings to allow players to view alerts for current or multiple/all surfaces
 ---------------------------------------------------------------------------------------------------
 Version: 1.1.11
 Date: 2023-03-12
@@ -41,12 +78,14 @@ Date: 2021-08-06
 Version: 1.1.7
 Date: 2021-06-21
   Compatibility:
-    - Added compatibility to Space Exploration's Meteor defence and other mods (no longer displays alert when ammo is dynamically loaded) (by snouz)
+    - Added compatibility to Space Exploration's Meteor defence and other mods (no longer displays
+      alert when ammo is dynamically loaded) (by snouz)
 ---------------------------------------------------------------------------------------------------
 Version: 1.1.6
 Date: 2021-04-22
   Bugfixes:
-    - Defaulting multislot mode "selected" to first slot, if no slot selected. Defaulting to "added" mode caused a crash.
+    - Defaulting multislot mode "selected" to first slot, if no slot selected. Defaulting to
+      "added" mode caused a crash.
   Scripting:
     - Simplified some boolean logic misusing it as ternary
 ---------------------------------------------------------------------------------------------------

control.lua

@@ -64,16 +64,23 @@ local get_ammo_flag = {
 }
 
 local function add_entity_to_list(event)
-	--Whenever an ammo-turret, car or artillery type entity is built, add it to the global table.
+	--Whenever an ammo-turret, vehicle or artillery type entity is built, add it to the global table.
 	local entity = event.created_entity or event.entity
 	local index = entity.surface.name.."_"..entity.force.name
+
+	-- Add table if it doesn't exist and a player of this force is connected
+	if entity.force.connected_players[1] and not storage.ammo_entities[index] then
+		storage.ammo_entities[index] = {}
+	end
+
+	-- Add entity to table
 	if storage.ammo_entities[index] then
 		table.insert(storage.ammo_entities[index], entity)
 	end
 end
 
 local function remove_entity_from_list(event)
-	--Whenever an ammo-turret, car or artillery type entity dies / is mined, remove it from the global table.
+	--Whenever an ammo-turret, vehicle or artillery type entity dies / is mined, remove it from the global table.
 	local index = event.entity.surface.name.."_"..event.entity.force.name
 	if storage.ammo_entities[index] then
 		for i,entity in pairs(storage.ammo_entities[index]) do
@@ -86,19 +93,21 @@ local function remove_entity_from_list(event)
 end
 
 local function add_force_to_list(event)
-	--Whenever a player of an unscanned force joins the game or a force is created, add all ammo-turret, car or artillery type entities of that force to the global table.
+	--Whenever a player of an unscanned force joins the game or a force is created, add all ammo-turret, vehicle or artillery type entities of that force to the global table.
 	local player, force
 	if event.player_index then
 		player = game.get_player(event.player_index)
+		if player and player.valid then
 			force = player.force
+		end
 	elseif event.force then
 		force = event.force
-		if force.connected_players then
+		if force.valid and force.connected_players then
 			player = force.connected_players[1]
 		end
 	end
 
-	if player and force and not storage.ammo_entities[player.surface.name.."_"..force.name] then
+	if player and player.valid and force and force.valid and not storage.ammo_entities[player.surface.name.."_"..force.name] then
 		for _,surface in pairs(game.surfaces) do
 			storage.ammo_entities[surface.name.."_"..force.name] = surface.find_entities_filtered{type = {"ammo-turret","car","artillery-turret","artillery-wagon","spider-vehicle"}, force = force, to_be_deconstructed = false}
 		end
@@ -123,15 +132,34 @@ local function remove_force_from_list(event)
 		force = event.source
 	end
 
-	if force and not force.connected_players then
+	if force then
+		if not force.valid or (force.valid and table_is_empty(force.connected_players)) then
 			for surface_name,_ in pairs(game.surfaces) do
 				storage.ammo_entities[surface_name.."_"..force.name] = nil
 			end
 		end
 	end
+end
+
+local function remove_surface_from_list(event)
+	--Whenever a surface is renamed or deleted, move/remove all entities in/from the global table.
+	for _,force in pairs(game.forces) do
+		local index
+		if event.new_name then
+			storage.ammo_entities[event.new_name.."_"..force.name] = table.deepcopy(storage.ammo_entities[event.old_name.."_"..force.name])
+			index = event.old_name.."_"..force.name
+		elseif event.surface_index then
+			index = game.surfaces[event.surface_index].name.."_"..force.name
+		end
+
+		if index then
+			storage.ammo_entities[index] = nil
+		end
+	end
+end
 
 local function init_list()
-	-- index init
+	--Create global table for existing forces
 	storage.ammo_entities = {}
 	local param = {}
 	for _,force in pairs(game.forces) do
@@ -141,7 +169,7 @@ local function init_list()
 end
 
 local function generate_alerts()
-	--Every 10 seconds recheck and give alerts to players for ammo-turret, car, spidertron or artillery type entities on the same force as them.
+	--Every 10 seconds recheck and give alerts to players for ammo-turret, vehicle, spidertron or artillery type entities on the same force as them.
 	for _,player in pairs(game.connected_players) do
 
 		local turret_enabled = player.mod_settings["gun-turret-alerts-enabled"].value
@@ -149,13 +177,24 @@ local function generate_alerts()
 		local artillery_enabled = player.mod_settings["gun-turret-alerts-artillery-enabled"].value
 		local mode = player.mod_settings["gun-turret-alerts-mode"].value
 		local player_threshold = player.mod_settings["gun-turret-alerts-threshold"].value
-		local ammo_entities = storage.ammo_entities[player.surface.name.."_"..player.force.name]
+		local auto_full = player.mod_settings["gun-turret-alerts-z-automated-full"].value
+		local show_planets = player.mod_settings["gun-turret-alerts-z-show-planets"].value
+		local show_platforms = player.mod_settings["gun-turret-alerts-z-show-platforms"].value
+
+		for _,surface in pairs(game.surfaces) do
+			local ammo_entities
+
+			if surface == player.surface or (show_platforms and surface.platform) or (show_planets and surface.planet) then
+				ammo_entities = storage.ammo_entities[surface.name.."_"..player.force.name]
+			end
 
 			if ammo_entities then
-			for _,entity in pairs(ammo_entities) do
-				if entity.valid and entity.force == player.force then
+				if not table_is_empty(ammo_entities) then
+					for index,entity in pairs(ammo_entities) do
+						if entity.valid then
+							if entity.force == player.force then
 
-					--Get ammo inventory based on entity type, skip cars without guns
+								--Get ammo inventory based on entity type, skip vehicles without guns
 								local inventory
 								if turret_enabled and entity.type == "ammo-turret" then
 									inventory = entity.get_inventory(defines.inventory.turret_ammo)
@@ -174,7 +213,8 @@ local function generate_alerts()
 								if inventory and get_ammo_flag[mode] then
 									if entity.type == "ammo-turret" or entity.type == "artillery-turret" or entity.type == "artillery-wagon" then
 										ammo_flag = get_ammo_flag[mode](inventory, player_threshold)
-							if entity.prototype.automated_ammo_count then
+										-- Automated amme count override (if activated)
+										if auto_full and entity.prototype.automated_ammo_count then
 											if entity.prototype.automated_ammo_count < player_threshold then
 												ammo_flag = get_ammo_flag[mode](inventory, entity.prototype.automated_ammo_count)
 											end
@@ -193,6 +233,15 @@ local function generate_alerts()
 									player.add_custom_alert(entity, {type = "virtual", name = "ammo-icon-yellow"}, {"gun-turret-alerts.message-low", entity.localised_name}, true)
 								end
 							end
+						else
+							-- Cleanup if entity is invalid
+							table.remove(ammo_entities, index)
+						end
+					end
+				else
+					-- Cleanup if table is empty
+					storage.ammo_entities[surface.name.."_"..player.force.name] = nil
+				end
 			end
 		end
 	end
@@ -211,13 +260,18 @@ script.on_event(defines.events.on_player_changed_force, remove_force_from_list)
 script.on_event(defines.events.on_force_created, add_force_to_list)
 script.on_event(defines.events.on_forces_merged, remove_force_from_list)
 
+script.on_event(defines.events.on_surface_renamed, remove_surface_from_list)
+script.on_event(defines.events.on_pre_surface_deleted, remove_surface_from_list)
+
 script.on_event(defines.events.on_built_entity, add_entity_to_list, {{filter="type", type = "ammo-turret"},{filter="type", type = "car"},{filter="type", type = "spider-vehicle"},{filter="type", type = "artillery-turret"},{filter="type", type = "artillery-wagon"}})
 script.on_event(defines.events.on_robot_built_entity, add_entity_to_list, {{filter="type", type = "ammo-turret"},{filter="type", type = "car"},{filter="type", type = "spider-vehicle"},{filter="type", type = "artillery-turret"},{filter="type", type = "artillery-wagon"}})
+script.on_event(defines.events.on_space_platform_built_entity, add_entity_to_list, {{filter="type", type = "ammo-turret"},{filter="type", type = "car"},{filter="type", type = "spider-vehicle"},{filter="type", type = "artillery-turret"},{filter="type", type = "artillery-wagon"}})
 script.on_event(defines.events.script_raised_built, add_entity_to_list, {{filter="type", type = "ammo-turret"},{filter="type", type = "car"},{filter="type", type = "spider-vehicle"},{filter="type", type = "artillery-turret"},{filter="type", type = "artillery-wagon"}})
 script.on_event(defines.events.script_raised_revive, add_entity_to_list, {{filter="type", type = "ammo-turret"},{filter="type", type = "car"},{filter="type", type = "spider-vehicle"},{filter="type", type = "artillery-turret"},{filter="type", type = "artillery-wagon"}})
 
 script.on_event(defines.events.on_player_mined_entity, remove_entity_from_list, {{filter="type", type = "ammo-turret"},{filter="type", type = "car"},{filter="type", type = "spider-vehicle"},{filter="type", type = "artillery-turret"},{filter="type", type = "artillery-wagon"}})
 script.on_event(defines.events.on_robot_mined_entity, remove_entity_from_list, {{filter="type", type = "ammo-turret"},{filter="type", type = "car"},{filter="type", type = "spider-vehicle"},{filter="type", type = "artillery-turret"},{filter="type", type = "artillery-wagon"}})
+script.on_event(defines.events.on_space_platform_mined_entity, remove_entity_from_list, {{filter="type", type = "ammo-turret"},{filter="type", type = "car"},{filter="type", type = "spider-vehicle"},{filter="type", type = "artillery-turret"},{filter="type", type = "artillery-wagon"}})
 script.on_event(defines.events.on_entity_died, remove_entity_from_list, {{filter="type", type = "ammo-turret"},{filter="type", type = "car"},{filter="type", type = "spider-vehicle"},{filter="type", type = "artillery-turret"},{filter="type", type = "artillery-wagon"}})
 script.on_event(defines.events.script_raised_destroy, remove_entity_from_list, {{filter="type", type = "ammo-turret"},{filter="type", type = "car"},{filter="type", type = "spider-vehicle"},{filter="type", type = "artillery-turret"},{filter="type", type = "artillery-wagon"}})
 

info.json

@@ -1,6 +1,6 @@
 {
     "name": "Gun_Turret_Alerts",
-    "version": "2.0.1",
+    "version": "2.0.7",
     "title": "Ammo Alerts",
     "author": "Wyrrrd",
     "factorio_version": "2.0",

locale/de/config.cfg

@@ -24,3 +24,8 @@ message-low=__1__ hat wenig Munition
 [virtual-signal-name]
 ammo-icon-red=Hat keine Munition
 ammo-icon-yellow=Hat wenig Munition
+
+[mod-name]
+
+[mod-description]
+

locale/en/config.cfg

@@ -4,6 +4,9 @@ gun-turret-alerts-car-enabled=Vehicle ammo alerts enabled
 gun-turret-alerts-artillery-enabled=Artillery ammo alerts enabled
 gun-turret-alerts-mode=Multi slot mode
 gun-turret-alerts-threshold=Low ammo threshold
+gun-turret-alerts-z-automated-full=Automated amount equals full
+gun-turret-alerts-z-show-planets=Show on all planets
+gun-turret-alerts-z-show-platforms=Show on all space platforms
 
 [mod-setting-description]
 gun-turret-alerts-enabled=Enables turret ammo alerts to be added to your player.
@@ -11,6 +14,9 @@ gun-turret-alerts-car-enabled=Enables vehicle ammo alerts to be added to your pl
 gun-turret-alerts-artillery-enabled=Enables artillery ammo alerts to be added to your player.
 gun-turret-alerts-mode=Controls, if the ammo slots are added up, every slot is counted individually, or just the selected slot is counted.\n(Only applies for more than one ammo slot, for example in vehicles.)
 gun-turret-alerts-threshold=If a turret, vehicle or artillery has less than this much ammo, an alert will be added to your player.
+gun-turret-alerts-z-automated-full=Send no alerts when a turret or artillery has an amount of ammo equal or higher than what inserters would automatically insert into them.
+gun-turret-alerts-z-show-planets=Show alerts for other planets, even if you are not there. (Default is to only show current planet/space platform.)
+gun-turret-alerts-z-show-platforms=Show alerts for other space platforms, even if you are not there. (Default is to only show current planet/space platform.)
 
 [string-mod-setting]
 gun-turret-alerts-mode-added=Added up
@@ -18,8 +24,8 @@ gun-turret-alerts-mode-individually=Individually
 gun-turret-alerts-mode-selected=Selected
 
 [gun-turret-alerts]
-message-empty=__1__ out of ammo
-message-low=__1__ low ammo
+message-empty=__1__ is out of ammo
+message-low=__1__ is low on ammo
 
 [virtual-signal-name]
 ammo-icon-red=Out of ammo signal

locale/fr/config.cfg

@@ -24,3 +24,8 @@ message-low=__1__ peu de munitions
 [virtual-signal-name]
 ammo-icon-red=Signal d'absence de munition
 ammo-icon-yellow=Signal de manque de munitions
+
+[mod-name]
+
+[mod-description]
+

locale/uk/config.cfg

@@ -24,3 +24,8 @@ message-low=__1__ мало боєприпасів
 [virtual-signal-name]
 ammo-icon-red=Сигнал про закінчення набоїв
 ammo-icon-yellow=Сигнал про низький рівень набоїв
+
+[mod-name]
+
+[mod-description]
+

settings.lua

@@ -34,4 +34,22 @@ data:extend({
         default_value = 8,
 		minimum_value = 0
     },
+    {
+        type = "bool-setting",
+        name = "gun-turret-alerts-z-automated-full",
+        setting_type = "runtime-per-user",
+        default_value = true
+    },
+    {
+        type = "bool-setting",
+        name = "gun-turret-alerts-z-show-planets",
+        setting_type = "runtime-per-user",
+        default_value = false
+    },
+    {
+        type = "bool-setting",
+        name = "gun-turret-alerts-z-show-platforms",
+        setting_type = "runtime-per-user",
+        default_value = false
+    },
 })