Version: 1.16.10

Date: 2022-07-22
  Features:
    - use RichText [train-stop=uid] for stations
    - use RichText [train=uid] for trains
  Changes:
    - GPS tags disabled by default, was too spammy

Author: 0ptera

changelog.txt

@@ -1,4 +1,12 @@
 ---------------------------------------------------------------------------------------------------
+Version: 1.16.10
+Date: 2022-07-22
+  Features:
+    - use RichText [train-stop=uid] for stations
+    - use RichText [train=uid] for trains
+  Changes:
+    - GPS tags disabled by default, was too spammy
+---------------------------------------------------------------------------------------------------
 Version: 1.16.9
 Date: 2022-06-19
   Bugfixes:

info.json

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

locale/de/base.cfg

@@ -74,8 +74,8 @@ delivery-removed-depot=[LTN] Lieferung von __1__ nach __2__ entfernt. Zug ist in
 delivery-removed-train-invalid=[LTN] Lieferung von __1__ nach __2__ entfernt. Zug existiert nicht mehr.
 delivery-removed-timeout=[LTN] Lieferung von __1__ nach __2__ wegen Time-Out nach __3__ Ticks entfernt.
 
-train-arrived=[LTN] Zug __1__ ist in __2__ angekommen.
-train-left=[LTN] Zug __1__ hat __2__ verlassen.
+train-arrived=[LTN] __1__ ist in __2__ angekommen.
+train-left=[LTN] __1__ hat __2__ verlassen.
 
 provider_missing_cargo=[LTN] Zug __1__ hat Anbieterhaltestelle __2__ mit fehlender Fracht verlassen.
 provider_unscheduled_cargo=[LTN] Zug __1__ hat Anbieterhaltestelle __2__ mit ungeplanter Fracht verlassen.

locale/en/base.cfg

@@ -74,8 +74,8 @@ delivery-removed-depot=[LTN] Delivery from __1__ to __2__ removed. Train returne
 delivery-removed-train-invalid=[LTN] Delivery from __1__ to __2__ removed. Train no longer valid.
 delivery-removed-timeout=[LTN] Delivery from __1__ to __2__ running for __3__ ticks removed after time out.
 
-train-arrived=[LTN] Train __1__ arrived at __2__.
-train-left=[LTN] Train __1__ left __2__.
+train-arrived=[LTN] __1__ arrived at __2__.
+train-left=[LTN] __1__ departed from __2__.
 
 provider_missing_cargo=[LTN] Train __1__ left provider __2__ with missing cargo.
 provider_unscheduled_cargo=[LTN] Train __1__ left provider __2__ with unscheduled cargo.

script/dispatcher.lua

@@ -63,8 +63,8 @@ function OnTick(event)
         if message_level >= 1 then
           printmsg({
             "ltn-message.delivery-removed-train-invalid",
-            MakeGpsString(from_entity, delivery.from),
-            MakeGpsString(to_entity, delivery.to)
+            Make_Stop_RichText(from_entity) or delivery.from,
+            Make_Stop_RichText(to_entity) or delivery.to
           }, delivery.force, false)
         end
         if debug_log then log("(OnTick) Delivery from "..delivery.from.." to "..delivery.to.." removed. Train no longer valid.") end
@@ -77,8 +77,8 @@ function OnTick(event)
         if message_level >= 1 then
           printmsg({
             "ltn-message.delivery-removed-timeout",
-            MakeGpsString(from_entity, delivery.from),
-            MakeGpsString(to_entity, delivery.to),
+            Make_Stop_RichText(from_entity) or delivery.from,
+            Make_Stop_RichText(to_entity) or delivery.to,
             tick-delivery.started
           }, delivery.force, false)
         end
@@ -438,7 +438,7 @@ function ProcessRequest(reqIndex, request)
   local to = requestStation.entity.backer_name
   local to_rail = requestStation.entity.connected_rail
   local to_rail_direction = requestStation.entity.connected_rail_direction
-  local to_gps = MakeGpsString(requestStation.entity, to)
+  local to_gps = Make_Stop_RichText(requestStation.entity) or to
   local to_network_id_string = format("0x%x", band(requestStation.network_id))
   local item = request.item
   local count = request.count
@@ -507,7 +507,7 @@ function ProcessRequest(reqIndex, request)
   local from_rail = providerData.entity.connected_rail
   local from_rail_direction = providerData.entity.connected_rail_direction
   local from = providerData.entity.backer_name
-  local from_gps = MakeGpsString(providerData.entity, from)
+  local from_gps = Make_Stop_RichText(providerData.entity) or 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, "[" .. itype .. "=" .. iname .. "]"}, requestForce, true) end
@@ -584,7 +584,7 @@ function ProcessRequest(reqIndex, request)
   local selectedTrain = free_trains[1].train
   local trainInventorySize = free_trains[1].inventory_size
 
-  if message_level >= 3 then printmsg({"ltn-message.train-found", from, to, matched_network_id_string, tostring(trainInventorySize), tostring(totalStacks) }, requestForce) end
+  if message_level >= 3 then printmsg({"ltn-message.train-found", from_gps, to_gps, matched_network_id_string, tostring(trainInventorySize), tostring(totalStacks) }, requestForce) end
   if debug_log then log("Train to transport "..tostring(trainInventorySize).."/"..tostring(totalStacks).." stacks from "..from.." to "..to.." in network "..matched_network_id_string.." found in Depot.") end
 
   -- recalculate delivery amount to fit in train

script/train-events.lua

@@ -41,7 +41,8 @@ function TrainArrives(train)
     end
     local is_provider = false
 
-    if message_level >= 3 then printmsg({"ltn-message.train-arrived", tostring(trainName), stop_name}, trainForce, false) end
+    -- if message_level >= 3 then printmsg({"ltn-message.train-arrived", tostring(trainName), stop_name}, trainForce, false) end
+    if message_level >= 3 then printmsg({"ltn-message.train-arrived", Make_Train_RichText(train, trainName), format("[train-stop=%d]", stopID)}, 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
 
     if stop.error_code == 0 then
@@ -52,8 +53,8 @@ function TrainArrives(train)
           if message_level >= 1 then
             printmsg({
               "ltn-message.delivery-removed-depot",
-              MakeGpsString(from_entity, delivery.from),
-              MakeGpsString(to_entity, delivery.to)
+              Make_Stop_RichText(from_entity) or delivery.from,
+              Make_Stop_RichText(to_entity) or delivery.to
             }, delivery.force, false)
           end
           if debug_log then log(format("(TrainArrives) Train [%d] \"%s\": Entered Depot with active Delivery. Failing Delivery and reseting train.", train.id, trainName)) end
@@ -318,7 +319,8 @@ function TrainLeaves(trainID)
   -- remove train reference
   stop.parked_train = nil
   stop.parked_train_id = nil
-  if message_level >= 3 then printmsg({"ltn-message.train-left", tostring(stoppedTrain.name), stop.entity.backer_name}, stoppedTrain.force) end
+  -- if message_level >= 3 then printmsg({"ltn-message.train-left", tostring(stoppedTrain.name), stop.entity.backer_name}, stoppedTrain.force) end
+  if message_level >= 3 then printmsg({"ltn-message.train-left", Make_Train_RichText(train, stoppedTrain.name), format("[train-stop=%d]", stopID)}, stoppedTrain.force, false) end
   UpdateStopOutput(stop)
 
   global.StoppedTrains[trainID] = nil

script/utils.lua

@@ -40,12 +40,25 @@ function GetTrainCapacity(train)
   return inventorySize, fluidCapacity
 end
 
--- returns gps string from entity or just string if entity is invalid
-function MakeGpsString(entity, name)
-  if message_include_gps and entity and entity.valid then
-    return format("%s [gps=%s,%s,%s]", name, entity.position["x"], entity.position["y"], entity.surface.name)
+-- returns rich text string for train stops, or nil if entity is invalid
+function Make_Stop_RichText(entity)
+  if entity and entity.valid then
+    if message_include_gps then
+      return format("[train-stop=%d] [gps=%s,%s,%s]", entity.unit_number, entity.position["x"], entity.position["y"], entity.surface.name)
+    else
+      return format("[train-stop=%d]", entity.unit_number)
+    end
   else
-    return name
+    return nil
   end
 end
 
+-- returns rich text string for trains, or nil if entity is invalid
+function Make_Train_RichText(train, train_name)
+  local loco = Get_Main_Locomotive(train)
+  if loco and loco.valid then
+    return format("[train=%d] %s", loco.unit_number, train_name)
+  else
+    return format("[train=] %s", train_name)
+  end
+end

settings.lua

@@ -52,7 +52,7 @@ data:extend({
     name = "ltn-interface-message-gps",
     order = "af",
     setting_type = "runtime-global",
-    default_value = true
+    default_value = false
   },
   {
     type = "bool-setting",