Merge pull request #131 from mamoniot/dev

1.3.0

cybersyn/changelog.txt

@@ -1,15 +1,19 @@
 ---------------------------------------------------------------------------------------------------
 Version: 1.3.0
-Date: 2023-9-24
+Date: 2023-10-10
   Features:
-    - Added an alert when no provider is found for an item, indicating a bottleneck in your factory - contributed by FinalFrag
+    - Added improved combinator display sprites - contributed by jagoly
     - The manager gui now displays control signals - contributed by Shadowvoices
     - The manager gui now excludes requests that do not exceed the request threshold - contributed by Shadowvoices
   Bugfixes:
     - Fixed a crash when clicking on a combinator when the GUI is open - contributed by PeteyPii
-    - Fixed a crash when setting a combinator to depot mode without a network - contributed by download13
+    - Fixed a crash when setting a combinator to depot mode without a network - contributed by download13 and TheXIFC
-    - Fixed a crash when opening the manager when adding cybersyn to an existing save - contributed by Mjonir
     - Stations with provider item thresholds can no longer generate empty train orders - contributed by svr8450
+    - Added missing loader entity type to the automatic allow-list - contributed by gillett-hernandez
+    - Fixed a case where combinator changes not being applied for depots and refuelers - contributed by jagoly
+    - Fixed provide/request orders for the same item getting generated simultaneously - contributed by jagoly
+    - Fixed a crash when opening the manager when adding cybersyn to an existing save - contributed by Mjonir
+    - Fixed a crash when enabling the manager on an existing save - contributed by freyacodes
   Translation:
     - Swedish language added - contributed by Sharparam
     - Chinese language update - contributed by luaotix

cybersyn/info.lua

@@ -3,4 +3,4 @@
 --- It is used in migrations.lua to determine if any migrations need to be run for beta testers.
 --- It is expected these are only meaningful between releases during beta testing.
 --- It should be set to nil for any release version.
-return 0
+return 1

cybersyn/locale/en/base.cfg

@@ -67,7 +67,6 @@ depot-broken=A train is lost because its depot was broken
 refueler-broken=A train is lost because its refueler was broken
 station-broken=A train is lost because one of its delivery stations was broken
 train-at-incorrect=A train parked at a station it was not scheduled to delivered to
-missing-provider=Could not find a station providing __1__ to make a delivery to __2__
 missing-train=Could not find any train on the correct network to make a delivery from __2__ to __1__
 no-train-has-capacity=Could not find a train with enough cargo capacity to make a delivery from __2__ to __1__
 no-train-matches-r-layout=Could not find a train on the allow-list of __1__ to make a delivery

cybersyn/scripts/central-planning.lua

@@ -287,6 +287,12 @@ local function tick_dispatch(map_data, mod_settings)
 				goto continue
 			end
 
+			--don't request when already providing
+			local item_deliveries = station.deliveries[item_name]
+			if item_deliveries and item_deliveries < 0 then
+				goto continue
+			end
+
 			local threshold = station.r_threshold
 			local prior = station.priority
 			local item_threshold = station.item_thresholds and station.item_thresholds[item_name] or nil
@@ -300,6 +306,7 @@ local function tick_dispatch(map_data, mod_settings)
 				goto continue
 			end
 
+			--prioritize by last delivery time if priorities are equal
 			if prior == best_r_prior and station.last_delivery_tick > best_timestamp then
 				goto continue
 			end
@@ -348,7 +355,7 @@ local function tick_dispatch(map_data, mod_settings)
 		---@type uint
 		local j = 1
 		while j <= #p_stations do
-			local p_flag, r_flag, netand, best_p_train_id, best_t_prior, best_capacity, best_t_to_p_dist, effective_count, override_threshold, p_prior, best_p_to_r_dist, effective_threshold, slot_threshold
+			local p_flag, r_flag, netand, best_p_train_id, best_t_prior, best_capacity, best_t_to_p_dist, effective_count, override_threshold, p_prior, best_p_to_r_dist, effective_threshold, slot_threshold, item_deliveries
 
 			local p_station_id = p_stations[j]
 			local p_station = stations[p_station_id]
@@ -356,6 +363,12 @@ local function tick_dispatch(map_data, mod_settings)
 				goto p_continue
 			end
 
+			--don't provide when already requesting
+			item_deliveries = p_station.deliveries[item_name]
+			if item_deliveries and item_deliveries > 0 then
+				goto p_continue
+			end
+
 			p_flag = get_network_mask(p_station, network_name)
 			r_flag = get_network_mask(r_station, network_name)
 			netand = band(p_flag, r_flag)
@@ -498,9 +511,8 @@ local function tick_dispatch(map_data, mod_settings)
 			create_delivery(map_data, r_station_id, p_station_id, best_train_id, manifest)
 			return false
 		else
-			if correctness == 0 then
+			if closest_to_correct_p_station then
-				send_alert_missing_provider(item_name, r_station.entity_stop)
+				if correctness == 1 then
-			elseif correctness == 1 then
 					send_alert_missing_train(r_station.entity_stop, closest_to_correct_p_station.entity_stop)
 				elseif correctness == 2 then
 					send_alert_no_train_has_capacity(r_station.entity_stop, closest_to_correct_p_station.entity_stop)
@@ -509,6 +521,7 @@ local function tick_dispatch(map_data, mod_settings)
 				elseif correctness == 4 then
 					send_alert_no_train_matches_p_layout(r_station.entity_stop, closest_to_correct_p_station.entity_stop)
 				end
+			end
 			if band(r_station.display_state, 2) == 0 then
 				r_station.display_state = r_station.display_state + 2
 				update_display(map_data, r_station)

cybersyn/scripts/factorio-api.lua

@@ -776,17 +776,6 @@ function send_alert_sounds(train)
 end
 
 
----@param item_name string
----@param r_stop LuaEntity
-function send_alert_missing_provider(item_name, r_stop)
-	for _, player in pairs(r_stop.force.players) do
-		player.add_custom_alert(
-		r_stop,
-		send_alert_about_missing_train_icon,
-		{"cybersyn-messages.missing-provider", item_name, r_stop.backer_name},
-		true)
-	end
-end
 ---@param r_stop LuaEntity
 ---@param p_stop LuaEntity
 function send_alert_missing_train(r_stop, p_stop)

cybersyn/scripts/global.lua

@@ -131,6 +131,7 @@
 ---@field public react_to_train_early_to_depot boolean --interface setting
 ---@field public enable_manager boolean
 ---@field public manager_ups double
+---@field public manager_enabled boolean
 
 --if this is uncommented it means there are migrations to write
 

cybersyn/scripts/gui.lua

@@ -89,13 +89,6 @@ local function handle_drop_down(e)
 		set_comb_operation(comb, MODE_PRIMARY_IO)
 	elseif element.selected_index == 2 then
 		set_comb_operation(comb, MODE_DEPOT)
-		--prevent the use of the each signal with depots
-		local network = element.parent.parent.bottom.network--[[@as LuaGuiElement]]
-		local signal = network.elem_value--[[@as SignalID]]
-		if signal and (signal.name == NETWORK_EACH) then
-			network.elem_value = nil
-			set_comb_network_name(comb, nil)
-		end
 	elseif element.selected_index == 3 then
 		set_comb_operation(comb, MODE_REFUELER)
 	elseif element.selected_index == 4 then

cybersyn/scripts/gui/main.lua

@@ -161,6 +161,10 @@ end
 
 
 function manager_gui.on_migration()
+	if not global.manager then
+		manager_gui.on_init()
+	end
+	
 	for i, p in pairs(game.players) do
 		if global.manager.players[i] == nil then
 			create_player(i)

cybersyn/scripts/layout.lua

@@ -215,7 +215,7 @@ function set_p_wagon_combs(map_data, station, train)
 		if carriage.type == "cargo-wagon" then
 			local inv = carriage.get_inventory(defines.inventory.cargo_wagon)
 			if inv then
-				---@type ConstantCombinatorParameters
+				---@type ConstantCombinatorParameters[]
 				local signals = {}
 
 				local inv_filter_i = 1
@@ -421,7 +421,7 @@ function unset_wagon_combs(map_data, stop)
 	end
 end
 
-local type_filter = {"inserter", "pump", "arithmetic-combinator", "loader-1x1"}
+local type_filter = {"inserter", "pump", "arithmetic-combinator", "loader-1x1", "loader"}
 ---@param map_data MapData
 ---@param stop Station|Refueler
 ---@param is_station_or_refueler boolean
@@ -543,7 +543,7 @@ function reset_stop_layout(map_data, stop, is_station_or_refueler, forbidden_ent
 								end
 							end
 						end
-					elseif entity.type == "loader-1x1" then
+					elseif entity.type == "loader-1x1" or entity.type == "loader" then
 						if not supports_cargo then
 							local direction = entity.direction
 							if is_ver then

cybersyn/scripts/main.lua

@@ -115,7 +115,7 @@ end
 ---@param map_data MapData
 ---@param stop LuaEntity
 ---@param comb1 LuaEntity
----@param comb2 LuaEntity
+---@param comb2 LuaEntity?
 local function on_station_built(map_data, stop, comb1, comb2)
 	--NOTE: only place where new Station
 	local station = {
@@ -285,10 +285,11 @@ local function on_combinator_built(map_data, comb)
 		control.parameters = params
 	end
 
-	map_data.to_comb[comb.unit_number] = comb
+	local unit_number = comb.unit_number--[[@as uint]]
-	map_data.to_comb_params[comb.unit_number] = params
+	map_data.to_comb[unit_number] = comb
-	map_data.to_output[comb.unit_number] = out
+	map_data.to_comb_params[unit_number] = params
-	map_data.to_stop[comb.unit_number] = stop
+	map_data.to_output[unit_number] = out
+	map_data.to_stop[unit_number] = stop
 
 	if op == MODE_WAGON then
 		if rail then
@@ -328,6 +329,48 @@ local function on_combinator_built(map_data, comb)
 		end
 	end
 end
+
+---@param map_data MapData
+---@param comb LuaEntity
+---@param unit_number uint
+---@return uint, uint, Station|Depot|Refueler|nil, LuaEntity?
+--Returns the internal entity associated with the given combinator, if one exists.
+--`unit_number` must be equal to `comb.unit_number`.
+--Returns 1 if `comb` is `entity_comb1` of a station.
+--Returns 2 if `comb` is `entity_comb2` of a station.
+--Returns 3 if `comb` defines a depot.
+--Returns 4 if `comb` defines a refueler.
+--Returns 0 if `comb` is not a core component of any entity.
+local function comb_to_internal_entity(map_data, comb, unit_number)
+	local stop = map_data.to_stop[unit_number]
+	if stop and stop.valid then
+		local id = stop.unit_number--[[@as uint]]
+		local station = map_data.stations[id]
+		if station then
+			if station.entity_comb1 == comb then
+				return 1, id, station, stop
+			elseif station.entity_comb2 == comb then
+				return 2, id, station, stop
+			end
+		else
+			local depot = map_data.depots[id]
+			if depot then
+				if depot.entity_comb == comb then
+					return 3, id, depot, stop
+				end
+			else
+				local refueler = map_data.refuelers[id]
+				if refueler then
+					if refueler.entity_comb == comb then
+						return 4, id, refueler, stop
+					end
+				end
+			end
+		end
+	end
+	return 0, 0, nil, nil
+end
+
 ---@param map_data MapData
 ---@param comb LuaEntity
 function on_combinator_broken(map_data, comb)
@@ -335,33 +378,20 @@ function on_combinator_broken(map_data, comb)
 	---@type uint
 	local comb_id = comb.unit_number
 	local out = map_data.to_output[comb_id]
-	local stop = map_data.to_stop[comb_id]
 
-	if stop and stop.valid then
+	local type, id, entity, stop = comb_to_internal_entity(map_data, comb, comb_id)
-		local id = stop.unit_number--[[@as uint]]
+	if type == 1 then
-		local station = map_data.stations[id]
+		on_station_broken(map_data, id, entity--[[@as Station]])
-		if station then
+		on_stop_built_or_updated(map_data, stop--[[@as LuaEntity]], comb)
-			if station.entity_comb1 == comb then
+	elseif type == 2 then
-				on_station_broken(map_data, id, station)
+		local station = entity--[[@as Station]]
-				on_stop_built_or_updated(map_data, stop, comb)
+		station.entity_comb2 = search_for_station_combinator(map_data, stop--[[@as LuaEntity]], MODE_SECONDARY_IO, comb)
-			elseif station.entity_comb2 == comb then
+	elseif type == 3 then
-				station.entity_comb2 = search_for_station_combinator(map_data, stop, MODE_SECONDARY_IO, comb)
+		on_depot_broken(map_data, id, entity--[[@as Depot]])
-			end
+		on_stop_built_or_updated(map_data, stop--[[@as LuaEntity]], comb)
-		else
+	elseif type == 4 then
-			local depot = map_data.depots[id]
+		on_refueler_broken(map_data, id, entity--[[@as Refueler]])
-			if depot then
+		on_stop_built_or_updated(map_data, stop--[[@as LuaEntity]], comb)
-				if depot.entity_comb == comb then
-					on_depot_broken(map_data, id, depot)
-					on_stop_built_or_updated(map_data, stop, comb)
-				end
-			else
-				local refueler = map_data.refuelers[id]
-				if refueler and refueler.entity_comb == comb then
-					on_refueler_broken(map_data, id, refueler)
-					on_stop_built_or_updated(map_data, stop, comb)
-				end
-			end
-		end
 	end
 
 	if out and out.valid then
@@ -382,22 +412,19 @@ function combinator_update(map_data, comb, reset_display)
 	local params = control.parameters
 	local old_params = map_data.to_comb_params[unit_number]
 	local has_changed = false
-	local station = nil
+	local type, id, entity = nil, 0, nil
-	local id = nil
 
-
+	local op = params.operation
-	if params.operation == MODE_PRIMARY_IO_ACTIVE or params.operation == MODE_PRIMARY_IO_FAILED_REQUEST or params.operation == MODE_PRIMARY_IO then
+	--handle the combinator's display, if it is part of a station
+	if op == MODE_PRIMARY_IO or op == MODE_PRIMARY_IO_ACTIVE or op == MODE_PRIMARY_IO_FAILED_REQUEST then
 		--the follow is only present to fix combinators that have been copy-pasted by blueprint with the wrong operation
-		local stop = map_data.to_stop[comb.unit_number--[[@as uint]]]
+		local set_control_params = true
-		local should_reset = reset_display
+
-		if stop then
+		if reset_display then
-			id = stop.unit_number--[[@as uint]]
+			type, id, entity = comb_to_internal_entity(map_data, comb, unit_number)
-			station = map_data.stations[id]
+
-			if station and station.entity_comb1 ~= comb then
+			if type == 1 then
-				station = nil
+				local station = entity--[[@as Station]]
-			end
-			if should_reset and station then
-				--make sure only MODE_PRIMARY_IO gets stored on map_data.to_comb_params
 				if station.display_state == 0 then
 					params.operation = MODE_PRIMARY_IO
 				elseif station.display_state%2 == 1 then
@@ -405,16 +432,17 @@ function combinator_update(map_data, comb, reset_display)
 				else
 					params.operation = MODE_PRIMARY_IO_FAILED_REQUEST
 				end
-				control.parameters = params
+				set_control_params = false
-				should_reset = false
-			end
-		end
-		if should_reset then
-			params.operation = MODE_PRIMARY_IO
 				control.parameters = params
 			end
-		params.operation = MODE_PRIMARY_IO
 		end
+		--make sure only MODE_PRIMARY_IO gets stored on map_data.to_comb_params
+		params.operation = MODE_PRIMARY_IO
+		if set_control_params then
+			control.parameters = params
+		end
+	end
+
 	if params.operation ~= old_params.operation then
 		--NOTE: This is rather dangerous, we may need to actually implement operation changing
 		on_combinator_broken(map_data, comb)
@@ -422,6 +450,7 @@ function combinator_update(map_data, comb, reset_display)
 		interface_raise_combinator_changed(comb, old_params)
 		return
 	end
+
 	local new_signal = params.first_signal
 	local old_signal = old_params.first_signal
 	local new_network = new_signal and new_signal.name or nil
@@ -429,18 +458,17 @@ function combinator_update(map_data, comb, reset_display)
 	if new_network ~= old_network then
 		has_changed = true
 
-		local stop = map_data.to_stop[comb.unit_number]
+		if type == nil then
-		if stop and stop.valid then
+			type, id, entity = comb_to_internal_entity(map_data, comb, unit_number)
-			if station then
+		end
+		if type == 1 or type == 2 then
 			--NOTE: these updates have to be queued to occur at tick init since central planning is expecting them not to change between ticks
 			if not map_data.queue_station_update then
 				map_data.queue_station_update = {}
 			end
 			map_data.queue_station_update[id] = true
-			else
+		elseif type == 3 then
-				local depot = map_data.depots[id]
+			local depot = entity--[[@as Depot]]
-				if depot then
-					if depot.entity_comb == comb then
 			local train_id = depot.available_train_id
 			if train_id then
 				local train = map_data.trains[train_id]
@@ -448,27 +476,26 @@ function combinator_update(map_data, comb, reset_display)
 				add_available_train_to_depot(map_data, mod_settings, train_id, train, id, depot)
 				interface_raise_train_status_changed(train_id, STATUS_D, STATUS_D)
 			end
-					end
+		elseif type == 4 then
-				else
+			set_refueler_from_comb(map_data, mod_settings, id, entity--[[@as Refueler]])
-					local refueler = map_data.refuelers[id]
-					if refueler and refueler.entity_comb == comb then
-						set_refueler_from_comb(map_data, mod_settings, id, refueler)
-					end
-				end
-			end
 		end
 	end
+
 	if params.second_constant ~= old_params.second_constant then
 		has_changed = true
-		if station then
+
+		if type == nil then
+			type, id, entity = comb_to_internal_entity(map_data, comb, unit_number)
+		end
+		--depots do not cache any combinator values so we don't have to update them here
+		if type == 1 or type == 2 then
 			--NOTE: these updates have to be queued to occur at tick init since central planning is expecting them not to change between ticks
 			if not map_data.queue_station_update then
 				map_data.queue_station_update = {}
 			end
 			map_data.queue_station_update[id] = true
-		else
+		elseif type == 4 then
-			local refueler = map_data.refuelers[id]
+			local refueler = entity--[[@as Refueler]]
-			if refueler then
 			local pre = refueler.allows_all_trains
 			set_refueler_from_comb(map_data, mod_settings, id, refueler)
 			if refueler.allows_all_trains ~= pre then
@@ -476,7 +503,7 @@ function combinator_update(map_data, comb, reset_display)
 			end
 		end
 	end
-	end
+
 	if has_changed then
 		map_data.to_comb_params[unit_number] = params
 		interface_raise_combinator_changed(comb, old_params)

cybersyn/scripts/remote-interface.lua

@@ -353,7 +353,6 @@ interface.add_refueler_schedule = add_refueler_schedule
 --[[alerts]]
 ------------------------------------------------------------------
 
-interface.send_alert_missing_provider = send_alert_missing_provider
 interface.send_alert_missing_train = send_alert_missing_train
 interface.send_alert_unexpected_train = send_alert_unexpected_train
 interface.send_alert_nonempty_train_in_depot = send_alert_nonempty_train_in_depot