Version: 1.16.8

Date: 2022-06-19
  Features:
    - show cargo as rich text in no-provider-found, provider-found, creating-delivery #283
    - added map-setting: Providers output existing cargo (default on), workaround for inserters stuck with items # 272, #294

Author: 0ptera

changelog.txt

@@ -1,4 +1,10 @@
 ---------------------------------------------------------------------------------------------------
+Version: 1.16.8
+Date: 2022-06-19
+  Features:
+    - show cargo as rich text in no-provider-found, provider-found, creating-delivery #283
+    - added map-setting: Providers output existing cargo (default on), workaround for inserters stuck with items # 272, #294
+---------------------------------------------------------------------------------------------------
 Version: 1.16.7
 Date: 2021-11-17
   Bugfixes:

info.json

@@ -1,6 +1,6 @@
 {
   "name": "LogisticTrainNetwork",
-  "version": "1.16.7",
+  "version": "1.16.8",
   "title": "LTN - Logistic Train Network",
   "author": "Optera",
   "contact": "https://forums.factorio.com/memberlist.php?mode=viewprofile&u=21729",

locale/de/settings.cfg

@@ -18,6 +18,7 @@ ltn-dispatcher-finish-loading=Beladung abschließen
 ltn-depot-reset-filters=Waggonfilter in Depots löschen
 ltn-depot-fluid-cleaning=Automatisch entfernte Flüssigkeitsmenge
 ltn-stop-default-network=Standard Netzwerk ID
+ltn-provider-show-existing-cargo=Anbieter zeigen existierende Ladung
 
 [mod-setting-description]
 ltn-interface-console-level=Nachrichten Detailgrad.\n\n0: Aus\nKeine Nachrichten werden generiert.\n\n1: Fehler & Warnungen\nNur Fehler & Warnungen werden generiert.\n\n2: Informationen (Standardwert)\nInformiert über grundlegende Informationen wie fehlende Ressourcen und erstellte Lieferungen.\n\n3: Ausführliche Nachrichten\nErweiterte Informationen über Stations- und Zug-Suche.
@@ -39,6 +40,7 @@ ltn-dispatcher-finish-loading=Aktiv: (Standardwert)\nVerhindert verlassen von Ha
 ltn-depot-reset-filters=Aktiv: (Standardwert)\nFilter und Stapelbegrenzungen in Güterwaggons werden bei Ankunft im Depot gelöscht.
 ltn-depot-fluid-cleaning=Maximale Flüssigkeitsmenge pro Waggon die bei Ankunft im Depot automatisch zerstört wird.\n0 schaltet diese Funktion aus.
 ltn-stop-default-network=Netzwerk ID wenn kein Signal "Kodierte Netzwerk ID" existiert.
+ltn-provider-show-existing-cargo=Aktiv: (Standardwert)\nExistierende Ladung von Zügen bei Ankunft am Anbieter wird im Haltestellen Signalausgang gezeigt.\nBeinhaltet Gegenstände die Greifarme auf die Gleise halten.
 
 [string-mod-setting]
 #<setting-name>-<dropdown-item-name>=<translated item>

locale/en/settings.cfg

@@ -19,6 +19,7 @@ ltn-dispatcher-finish-loading=Finish loading
 ltn-depot-reset-filters=Depots reset filters
 ltn-depot-fluid-cleaning=Depot fluid removal limit
 ltn-stop-default-network=Default network ID
+ltn-provider-show-existing-cargo=Providers output existing cargo
 
 [mod-setting-description]
 ltn-interface-console-level=Detail level of in game messages.\n\n0: Off\nNo messages will be generated.\n\n1: Errors & Warnings\nPrint only errors and warnings.\n\n2: Notifications (default)\nPrint basic information like missing resources or generating deliveries.\n\n3: Detailed Messages\nPrint detailed information about finding providers and trains.
@@ -40,6 +41,7 @@ ltn-dispatcher-finish-loading=True: (default)\nPrevents trains from leaving whil
 ltn-depot-reset-filters=True: (default)\nCargo wagons have their filters and stack limitations cleared when entering a depot.
 ltn-depot-fluid-cleaning=Maximum amount of fluid per wagon automatically destroyed when entering depots.\nSet to 0 to disable.
 ltn-stop-default-network=Network ID used for stops without "Encoded Network ID" signal.
+ltn-provider-show-existing-cargo=True: (default)\nCargo inside train when arriving at provider is shown in LTN Output.\nIncludes items from inserters holding items on tracks.
 
 [string-mod-setting]
 #<setting-name>-<dropdown-item-name>=<translated item>

script/dispatcher.lua

@@ -496,7 +496,7 @@ function ProcessRequest(reqIndex, request)
   -- get providers ordered by priority
   local providers = getProviders(requestStation, item, count, min_carriages, max_carriages)
   if not providers or #providers < 1 then
-    if requestStation.no_warnings == false and message_level >= 1 then printmsg({"ltn-message.no-provider-found", to_gps, localname, to_network_id_string}, requestForce, true) end
+    if requestStation.no_warnings == false and message_level >= 1 then printmsg({"ltn-message.no-provider-found", to_gps, "[" .. itype .. "=" .. iname .. "]", to_network_id_string}, requestForce, true) end
     if debug_log then log(format("No supply of %s found for Requester %s: surface: %s min length: %s, max length: %s, network-ID: %s", item, to, surface_name, min_carriages, max_carriages, to_network_id_string) ) end
     -- goto skipRequestItem
     return nil
@@ -510,7 +510,7 @@ function ProcessRequest(reqIndex, request)
   local from_gps = MakeGpsString(providerData.entity, from)
   local matched_network_id_string = format("0x%x", band(providerData.network_id))
 
-  if message_level >= 3 then printmsg({"ltn-message.provider-found", from_gps, tostring(providerData.priority), tostring(providerData.activeDeliveryCount), providerData.count, localname}, requestForce, true) end
+  if message_level >= 3 then printmsg({"ltn-message.provider-found", from_gps, tostring(providerData.priority), tostring(providerData.activeDeliveryCount), providerData.count, "[" .. itype .. "=" .. iname .. "]"}, requestForce, true) end
   -- if debug_log then
     -- for n, provider in pairs (providers) do
       -- log("Provider["..n.."] "..provider.entity.backer_name..": Priority "..tostring(provider.priority)..", "..tostring(provider.activeDeliveryCount).." deliveries, "..tostring(provider.count).." "..item.." available.")
@@ -615,7 +615,7 @@ function ProcessRequest(reqIndex, request)
   -- create delivery
   if message_level >= 2 then
     if #loadingList == 1 then
-      printmsg({"ltn-message.creating-delivery", from_gps, to_gps, loadingList[1].count, loadingList[1].localname}, requestForce)
+      printmsg({"ltn-message.creating-delivery", from_gps, to_gps, loadingList[1].count, "[" .. loadingList[1].type .. "=" .. loadingList[1].name .. "]"}, requestForce)
     else
       printmsg({"ltn-message.creating-delivery-merged", from_gps, to_gps, totalStacks}, requestForce)
     end

script/settings.lua

@@ -27,6 +27,7 @@ end
 depot_reset_filters = settings.global["ltn-depot-reset-filters"].value
 depot_fluid_cleaning = settings.global["ltn-depot-fluid-cleaning"].value
 default_network = settings.global["ltn-stop-default-network"].value
+provider_show_existing_cargo = settings.global["ltn-provider-show-existing-cargo"].value
 
 
 script.on_event(defines.events.on_runtime_mod_setting_changed, function(event)
@@ -99,4 +100,7 @@ script.on_event(defines.events.on_runtime_mod_setting_changed, function(event)
   if event.setting == "ltn-stop-default-network" then
     default_network = settings.global["ltn-stop-default-network"].value
   end
+  if event.setting == "ltn-provider-show-existing-cargo" then
+    provider_show_existing_cargo = settings.global["ltn-provider-show-existing-cargo"].value
+  end
 end)

script/stop-update.lua

@@ -361,7 +361,7 @@ function setLamp(trainStop, color, count)
 end
 
 
-function UpdateStopOutput(trainStop)
+function UpdateStopOutput(trainStop, ignore_existing_cargo)
   -- skip invalid stop outputs
   if not trainStop.output.valid then
     return
@@ -375,8 +375,8 @@ function UpdateStopOutput(trainStop)
     local carriages = trainStop.parked_train.carriages
     local encoded_positions_by_name = {}
     local encoded_positions_by_type = {}
-    local inventory = trainStop.parked_train.get_contents() or {}
-    local fluidInventory = trainStop.parked_train.get_fluid_contents() or {}
+    local inventory = not(ignore_existing_cargo) and trainStop.parked_train.get_contents() or {}
+    local fluidInventory = not(ignore_existing_cargo) and trainStop.parked_train.get_fluid_contents() or {}
 
     if #carriages < 32 then --prevent circuit network integer overflow error
       if trainStop.parked_train_faces_stop then --train faces forwards >> iterate normal
@@ -425,8 +425,6 @@ function UpdateStopOutput(trainStop)
 
     if not trainStop.is_depot then
       -- Update normal stations
-      local loadingList = {}
-      local fluidLoadingList = {}
       local conditions = trainStop.parked_train.schedule.records[trainStop.parked_train.schedule.current].wait_conditions
       if conditions ~= nil then
         for _, c in pairs(conditions) do

script/train-events.lua

@@ -39,6 +39,7 @@ function TrainArrives(train)
     else
       stop.parked_train_faces_stop = true
     end
+    local is_provider = false
 
     if message_level >= 3 then printmsg({"ltn-message.train-arrived", tostring(trainName), stop_name}, trainForce, false) end
     if debug_log then log(format("(TrainArrives) Train [%d] \"%s\": arrived at LTN-stop [%d] \"%s\"; train_faces_stop: %s", train.id, trainName, stopID, stop_name, stop.parked_train_faces_stop )) end
@@ -135,28 +136,31 @@ function TrainArrives(train)
       else -- stop is no Depot
         -- check requester for incorrect shipment
         local delivery = global.Dispatcher.Deliveries[train.id]
-        if delivery and delivery.to_id == stop.entity.unit_number then
-          local requester_unscheduled_cargo = false
-          local unscheduled_load = {}
-          local train_items = train.get_contents()
-          for name, count in pairs(train_items) do
-            local typed_name = "item,"..name
-            if not delivery.shipment[typed_name] then
-              requester_unscheduled_cargo = true
-              unscheduled_load[typed_name] = count
+        if delivery then
+          is_provider = delivery.from_id == stop.entity.unit_number
+          if delivery.to_id == stop.entity.unit_number then
+            local requester_unscheduled_cargo = false
+            local unscheduled_load = {}
+            local train_items = train.get_contents()
+            for name, count in pairs(train_items) do
+              local typed_name = "item,"..name
+              if not delivery.shipment[typed_name] then
+                requester_unscheduled_cargo = true
+                unscheduled_load[typed_name] = count
+              end
             end
-          end
-          local train_fluids = train.get_fluid_contents()
-          for name, count in pairs(train_fluids) do
-            local typed_name = "fluid,"..name
-            if not delivery.shipment[typed_name] then
-              requester_unscheduled_cargo = true
-              unscheduled_load[typed_name] = count
+            local train_fluids = train.get_fluid_contents()
+            for name, count in pairs(train_fluids) do
+              local typed_name = "fluid,"..name
+              if not delivery.shipment[typed_name] then
+                requester_unscheduled_cargo = true
+                unscheduled_load[typed_name] = count
+              end
+            end
+            if requester_unscheduled_cargo then
+              create_alert(stop.entity, "cargo-alert", {"ltn-message.requester_unscheduled_cargo", trainName, stop_name}, trainForce)
+              script.raise_event(on_requester_unscheduled_cargo_alert, {train = train, station = stop.entity, planned_shipment = delivery.shipment, unscheduled_load = unscheduled_load})
             end
-          end
-          if requester_unscheduled_cargo then
-            create_alert(stop.entity, "cargo-alert", {"ltn-message.requester_unscheduled_cargo", trainName, stop_name}, trainForce)
-            script.raise_event(on_requester_unscheduled_cargo_alert, {train = train, station = stop.entity, planned_shipment = delivery.shipment, unscheduled_load = unscheduled_load})
           end
         end
 
@@ -170,7 +174,7 @@ function TrainArrives(train)
       end
     end
 
-    UpdateStopOutput(stop)
+    UpdateStopOutput(stop, is_provider and not(provider_show_existing_cargo) )
   end
 end
 

settings.lua

@@ -156,4 +156,11 @@ data:extend({
     setting_type = "runtime-global",
     default_value = -1, -- any
   },
+  {
+    type = "bool-setting",
+    name = "ltn-provider-show-existing-cargo",
+    order = "eb",
+    setting_type = "runtime-global",
+    default_value = true
+  },
 })