push to 1.10.7

- updated changelog
- updated event descriptions

Author: 0ptera

README.md

@@ -1,7 +1,6 @@
 # Factorio - Logistic Train Network
 Factorio mod  adding "logistic-train-stops" acting as anchor points for building a train powered logistic network.<br/>
 It can handle multiple train configurations and will pick the best available train for a delivery.<br/>
-With Choumiko's RailTanker it will also deliver liquids.<br/>
 
 Forum: https://forums.factorio.com/viewforum.php?f=214<br/>
 Download: https://mods.factorio.com/mods/Optera/LogisticTrainNetwork<br/>

changelog.txt

@@ -1,4 +1,11 @@
 ---------------------------------------------------------------------------------------------------
+Version: 1.10.7
+Date: 2019-04-13
+  Features:
+    - Added on_dispatcher_no_train_found event #173
+  Bugfixes:
+    - Fixed nil error in debug log introduced in 1.10.6
+---------------------------------------------------------------------------------------------------
 Version: 1.10.6
 Date: 2019-04-06
   Bugfixes:

info.json

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

script/dispatcher.lua

@@ -521,15 +521,7 @@ function ProcessRequest(reqIndex)
   if not selectedTrain or not trainInventorySize then
     if message_level >= 2 then printmsg({"ltn-message.no-train-found", from, to, matched_network_id_string, tostring(minTraincars), tostring(maxTraincars) }, requestForce, true) end
     if debug_log then log("No train with "..tostring(minTraincars).." <= length <= "..tostring(maxTraincars).." to transport "..tostring(totalStacks).." stacks from "..from.." to "..to.." in network "..matched_network_id_string.." found in Depot.") end
-    script.raise_event(on_dispatcher_no_train_found_event, {
-      to = to,
-      to_id = toID,
-      from = from,
-      from_id = fromID,
-      network_id = requestStation.network_id,
-      minTraincars = minTraincars,
-      maxTraincars = maxTraincars,
-      shipment = loadingList,
+    script.raise_event(on_dispatcher_no_train_found_event, { to = to, to_id = toID, from = from, from_id = fromID, network_id = requestStation.network_id, minTraincars = minTraincars, maxTraincars = maxTraincars, shipment = loadingList,
     })
     return nil
   end

script/interface.lua

@@ -21,7 +21,7 @@ remote.add_interface("logistic-train-network", {
   on_dispatcher_no_train_found = function() return on_dispatcher_no_train_found_event end,
 
   -- update for updated deliveries after leaving provider
-  on_delivery_pickup_complete = function() return on_delivery_pickup_complete_event end,´
+  on_delivery_pickup_complete = function() return on_delivery_pickup_complete_event end,
 
   -- update for completing deliveries
   on_delivery_completed = function() return on_delivery_completed_event end,
@@ -38,67 +38,83 @@ end
 
 
 --[[ EVENTS
-on_stops_updated ->
-  called after LTN finished gathering stop data and created deliveries
-
-Contains:
-  logistic_train_stops = {
-    [stopID], {
-      -- stop data
-      activeDeliveries,
-      entity,
-      input,
-      output,
-      lampControl,
-      errorCode,
-
-      -- control signals
-      isDepot,
-      network_id,
-      maxTraincars,
-      minTraincars,
-      trainLimit,
-      provideThreshold,
-      provideStackThreshold,
-      providePriority,
-      requestThreshold,
-      requestStackThreshold,
-      requestPriority,
-      lockedSlots,
-      noWarnings,
-
-      -- parked train data
-      parkedTrain,
-      parkedTrainID,
-      parkedTrainFacesStop,
-    }
-  }
-
-
-on_dispatcher_updated ->
-  called after LTN finished gathering stop data and created deliveries
-
-Contains:
-  update_interval = int -- LTN update interval (depends on existing ltn stops and stops per tick setting
-  provided_by_stop = { [stopID], { [item], count } }
-  requests_by_stop = { [stopID], { [item], count } }
-  deliveries = { trainID = {force, train, from, to, networkID, started, shipment = { item = count } } }
-  available_trains = { [trainID ], { capacity, fluid_capacity, force, network_id, train } }
-
-
-on_delivery_completed ->
-  Called when train leaves delivery target stop
-
-Contains:
-  event.delivery = {force, train, from, to, networkID, started, shipment = { [item], count } }
+on_stops_updated
+Raised every UpdateInterval, after delivery generation
+-> Contains:
+event.logistic_train_stops = {  [stopID],  {
+    -- stop data
+    activeDeliveries,
+    entity,
+    input,
+    output,
+    lampControl,
+    errorCode,
+
+    -- control signals
+    isDepot,
+    network_id,
+    maxTraincars,
+    minTraincars,
+    trainLimit,
+    provideThreshold,
+    provideStackThreshold,
+    providePriority,
+    requestThreshold,
+    requestStackThreshold,
+    requestPriority,
+    lockedSlots,
+    noWarnings,
+
+    -- parked train data
+    parkedTrain,
+    parkedTrainID,
+    parkedTrainFacesStop,
+}}
+
+
+on_dispatcher_updated
+Raised every UpdateInterval, after delivery generation
+-> Contains:
+  event.update_interval = int -- LTN update interval (depends on existing ltn stops and stops per tick setting
+  event.provided_by_stop = { [stopID], { [item], count } }
+  event.requests_by_stop = { [stopID], { [item], count } }
+  event.deliveries = { trainID = {force, train, from, to, networkID, started, shipment = { item = count } } }
+  event.available_trains = { [trainID ], { capacity, fluid_capacity, force, network_id, train } }
+
+
+on_dispatcher_no_train_found
+Raised when no train was found to handle a request
+-> Contains:
+  event.to = requester.backer_name
+  event.to_id = requester.unit_number
+  event.network_id
+  (optional) event.item
+  (optional) event.from
+  (optional) event.from_id
+  (optional) event.minTraincars
+  (optional) event.maxTraincars
+  (optional) event.shipment = { [item], count }
+
+
+on_delivery_pickup_complete
+Raised when a train leaves provider stop
+-> Contains:
   event.trainID
+  event.delivery = {force, train, from, to, networkID, started, shipment = { [item], count } } -- updated shipment to current train inventory
+  event.original_shipment = { [item], count } }
 
 
-on_delivery_failed ->
-  Called when rolling stock of a train gets removed or the delivery timed out
-
-Contains:
+on_delivery_completed
+Raised when train leaves requester stop
+-> Contains:
+  event.trainID
   event.delivery = {force, train, from, to, networkID, started, shipment = { [item], count } }
+
+
+on_delivery_failed
+Raised when rolling stock of a train gets removed or the delivery timed out
+-> Contains:
   event.trainID
+  event.delivery = {force, train, from, to, networkID, started, shipment = { [item], count } }
 
 --]]