feat: add remote interface to add a new locomotive type

changelog.txt

@@ -3,6 +3,8 @@ Version: 1.2.0
 Date: 2020.12.12
   Features:
     - More mods compatibility. Battery Locomotive has come to handle `script_raised_built` and `script_raised_destroy` events.
+  Modding:
+    - Added remote interface to add a new battery locomotive type.
 ---------------------------------------------------------------------------------------------------
 Version: 1.1.0
 Date: 2020.12.05

control.lua

@@ -1,10 +1,27 @@
+require "remote-interface"
+
 local key = require "utils.key"
 local train = require "utils.train"
 local receiver = require "utils.receiver"
 
 script.on_init(function()
     global = {}
     global.entities = {}
+    global.locomotive_type_names = {
+        key.locomotive, key.locomotive_mk2, key.locomotive_mk3
+    }
+    global.schema_version = 2
+end)
+
+script.on_configuration_changed(function(data)
+    -- migrate global table
+    local version = global.schema_version or 1
+    if version < 2 then
+        global.locomotive_type_names = {
+            key.locomotive, key.locomotive_mk2, key.locomotive_mk3
+        }
+    end
+    global.schema_version = 2
 end)
 
 local function create_receiver(locomotive)

info.json

@@ -1,6 +1,6 @@
 {
   "name": "BatteryLocomotive",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "title": "Battery Locomotive",
   "author": "KoharaKazuya",
   "factorio_version": "1.1",

remote-interface.lua

@@ -0,0 +1,12 @@
+--- register a new locomotive type
+-- @param name string of lomotive type name
+local function register_locomotive_type(name)
+    local contains = false
+    for _, v in pairs(global.locomotive_type_names) do
+        if v == name then contains = true end
+    end
+    if not (contains) then table.insert(global.locomotive_type_names, name) end
+end
+
+remote.add_interface("BatteryLocomotive",
+                     {["register_locomotive_type"] = register_locomotive_type})

utils/train.lua

@@ -45,8 +45,10 @@ end
 local function is_battery_locomotive(entity)
     if not entity then return false end
     local name = entity.name
-    return (name == key.locomotive) or (name == key.locomotive_mk2) or
-               (name == key.locomotive_mk3)
+    for _, v in pairs(global.locomotive_type_names) do
+        if v == name then return true end
+    end
+    return false
 end
 
 return {