[MOD 0.14.x] Macromanaged Turrets v1.1.5

[Macros]

Type: Mod
Name: Macromanaged Turrets
Description: Create turrets that request ammo from the logistic network.
Version: v1.1.5
Release: 2017-4-1
Tested-With-Factorio-Version: 0.14.22
Website: https://mods.factorio.com/mods/Subach/M ... ed_Turrets

Long description

This mod can turn any turret into a logistic turret that requests ammo from the logistic network. This mod adds no turrets of its own; it is intended to be used as a supplement to the base game or other mods.

Using this mod
To use this mod, it is recommended that you extract the .zip file into your mod folder, instead of leaving it packaged. This will allow you to edit the configuration file, config.lua.
For this mod to be of any use, a turret must be added the the logistic turret table in the configuration file. Instructions for doing so are found within that file.
Adding a turret to the logistic turret table in config.lua enables the mod for that turret type. Those turrets will then behave just like requester chests, with the limitation that they can only request ammo.

The logistic turret remote
You can change the request slots of turrets in-game by using the logistic turret remote.
The remote is an item that is crafted with one electronic circuit. The recipe is unlocked when you have finished researching the logistic system. To use the remote, click-and-drag its selection box over your turrets, the way you would use a blueprint. This will open a GUI that allows you to edit your logistic turrets' settings.

Circuit network integration
Turrets can also be connected to circuit networks. Each turret has a small selection box near its center that indicates where its circuit connector is. Red and green wires attach to this interface.
Unlike most other entities, an extra step is required to connect a turret to a circuit network. Use the logistic turret remote to open a turret's GUI, click on the Circuit Network icon, and change its mode of operation from "None" to either "Read Contents" or "Set Requests". Then, click on one or both wire icons so the turret knows which wires to connect to.

Mod compatibility

Bob's Warfare
This mod automatically turns the turrets in Bob's Warfare into logistic turrets, with no configuration necessary. By editing the configuration file, you can:

• Change the default settings for all of Bob's turrets
• Override the default setting for specific turrets
• Disable the default settings and turn them back into normal turrets

Autofill
Autofill profiles are automatically created for logistic turrets, using the ammo specified in their table entry.

For mod authors
This mod has a remote interface that you can use to configure turrets via remote.call. Documentation on the remote interface can be found here.

Uninstallation

If you no longer wish to use this mod, do simply disable it in the mod list. Doing so would probably delete a lot of ammo from your world. To properly remove this mod, follow these instructions:

• Extract the .zip file if you have not yet done so
• Open config.lua
• Scroll down to the section titled Uninstallation
• Change MMT.UninstallMod to true
• Save and close config.lua
• Load and re-save your world

You can now safely remove or disable this mod.

Known limitations

• Turrets only store half the ammo they are requesting in their own inventory. The other half is stored in an invisible inventory that is accessed as needed. This means the selection GUI (when hovering your mouse over a turret) will show an inaccurate ammo count.
• Circuit network wires are only saved in blueprints if the turret has undergone a "wire update" after the wire was attached. A wire update occurs whenever a turret is selected with the logistic turret remote, and all turrets are updated whenever a world is loaded. The circuit connector light will turn green after the turret has been updated (assuming you have circuit connector sprites enabled). When Factorio v0.15 is released, it will be possible to update turrets simply by hovering your mouse over them, making the process nearly invisible.
• It is possible to create a blueprint containing a "logistic turret requester module" without an associated turret. This won't hurt anything, and will essentially be an empty space in the blueprint.
• When placing a blueprint containing a logistic turret, an alert for missing construction materials will be shown for the requester module.

Version history

• v1.1.5 (2017-4-1):
  Autofill integration improvements:
  Autofill profiles are only generated for turrets that don't already have one. Existing profiles are no longer overwritten.
  When generating a profile, the mod will attempt to match the turret to an existing item set. Only named item sets are considered.
  This mod is now aware of any custom item sets if that set is already being used by at least one other object (custom item sets are created through Autofill's "setItemArray" remote call).
  If a suitable item set cannot be found, then the turret will be autofilled with any ammo it is capable of using. Priority goes to whatever ammo you happen to have the most of in your inventory.
  A turret's default request (or lack of one) no longer has any bearing on what it can be autofilled with.
• v1.1.4 (2017-3-19):
  Features:
  Turrets' requests and circuit network wires can now be saved in blueprints.
  Turrets now remember what they were requesting when they die and a ghost is created.
  Wires between ghost turrets are now properly shown.
  Added the "TimeFactor" setting to the config file.
  Added an "UninstallMod" setting to the config file.
  Bug fixes:
  Fixed a bug that caused turrets to lose their logistic and circuit network functionality.
  Fixed a bug that caused construction robots to think turrets were damaged when they were not.
  Fixed a potential crash when mining the circuit network interface.
  Fixed the desyncs, again, for real this time.
  The clipboard is no longer cleared when loading a world in singleplayer.
  Scripting:
  Added "get_default_configuration" to the remote interface.
  Added "get_request_slot" to the remote interface.
  Added "get_circuit_mode" to the remote interface.
  Added "get_custom_label" to the remote interface.
  Added "change_custom_label" to the remote interface.
  Added "mod_info" to the remote interface.
  Renamed "reload_config" to "reset_mod".
• v1.1.3 (2016-11-26):
  Bug fix:
  Hotfix for a crash when changing the config file.
• v1.1.2 (2016-11-23):
  Bug fix:
  Fixed accumulators neither charging nor discharging when a logistic turret was part of their electric network.
• v1.1.1 (2016-11-4):
  Bug fixes:
  Fixed the configure_logistic_turret remote call. This function now only takes two arguments. The second argument follows the same format as config file entries.
  Deleting a surface that had ghost turrets will no longer cause a crash when loading that world.
  Turrets will now regain their custom labels when rebuilt from a ghost.
• v1.1.0 (2016-10-27):
  Updated for Factorio v0.14
  This changelong is too large to reasonably post here. Please see this pastebin for the full changelog.
• v1.0.4 (2016-05-22):
  Fixed multiplayer desync issue
  Added TimerInterval setting to the config file
• v1.0.3 (2016-05-13):
  Fixed the turret GUI display for Factorio v0.12.33
  GUIs now close when their turret is destroyed, mined, or marked for deconstruction
  GUIs no longer persist through a save and reload
  Fixed a method by which a turret could be set to request 0 items
  Cleaned up the codebase
  Minimum required Factorio version is now v0.12.33
• v1.0.2 (2016-05-08):
  Idle turrets are checked less often
  Smoothed the distribution of checks to prevent noticeable lag spikes
• v1.0.1 (2016-04-30):
  Fixed bots sometimes delivering the wrong item after using the remote
  Fixed a crash when clicking Save
• v1.0.0 (2016-04-29):
  Initial release

[Galacticruler]

Code: Select all

script.on_init(function()
	remote.call("Macromanaged_Turrets", "add_logistic_turret", "turret-name", "ammo-name", #)
end)

script.on_load(function()
	remote.call("Macromanaged_Turrets", "add_logistic_turret", "turret-name", "ammo-name", #)
end)

in this section, what does the # value do?
Also, does the ammo-name value differ at all from the one listed in the long description? Or does the mod auto-detect the ammo the turret can load?

[Macros]

Code: Select all

script.on_init(function()
	remote.call("Macromanaged_Turrets", "add_logistic_turret", "turret-name", "ammo-name", #)
end)

script.on_load(function()
	remote.call("Macromanaged_Turrets", "add_logistic_turret", "turret-name", "ammo-name", #)
end)

in this section, what does the # value do?
Also, does the ammo-name value differ at all from the one listed in the long description? Or does the mod auto-detect the ammo the turret can load?

The # represents a number - it's the amount you want the turret to request. Bots will carry this amount to the turret and stop when the count is met.

A turret can only request one type of ammo at a time. Replace "ammo-name" with the item name of the ammo you want the turret to request. For instance, "basic-bullet-magazine" or "piercing-shotgun-shell". This sets the default request that new turrets of that type are created with.
All three arguments (turret name, ammo name, amount) need to be present, and the turret needs to be able to use the ammo you are telling it to request.

Adding a turret via remote call is functionally identical to adding it to the table in the configuration file. It's just more convenient for your users.

[NoriSilverrage]

Wow this looks really nice.

[Supercheese]

Nice mod!

Known issues

• The logistic turret remote makes a lot of noise if you click-and-drag it around.

I believe that can be fixed with the addition of something like:

Code: Select all

local function onPutItem(event)

if global.tick ~= nil and global.tick > event.tick then 
	return 
end
global.tick = event.tick + 5

...

This is a method that test mode used that I copied for Orbital Ion Cannon.

[GameCharmer]

I'm writing a compatibility & balancing patch that makes several mods play nice together, and I'd love to be able to add this to the patch. Is there any way to define additions outside of control.lua? I'm currently using the data object to detect which bits and pieces of various mods are loaded, then apply changes there via data-final-fixes.

[Macros]

I'm writing a compatibility & balancing patch that makes several mods play nice together, and I'd love to be able to add this to the patch. Is there any way to define additions outside of control.lua? I'm currently using the data object to detect which bits and pieces of various mods are loaded, then apply changes there via data-final-fixes.

Unfortunately not. However, it is possible to do almost the same thing in control.lua. During on_init, use this code:

Code: Select all

global.MyTurretList = {}
for name, entity in pairs(game.entity_prototypes) do
  if entity.type == "ammo-turret" then
    table.insert(global.MyTurretList, name)
  end
end

... to iterate over all entity prototypes, and when it finds an ammo-turret (from any mod), add it to a global table.

Then, during on_init and on_load, do a remote call for all your table entries:

Code: Select all

for k, name in pairs(global.MyTurretList) do
  remote.call("Macromanaged_Turrets", "add_logistic_turret", name, <"some-ammo-name">, <#>)
end

Getting the right ammo into the remote call might be tricky; the simplest option would probably be to make a white-list of all the turrets from all the mods you plan on working with, with corresponding ammo for each one. You could also use the white-list to filter out any turrets from mods that you haven't accounted for, instead of doing the remote call for all of them.

[Macros]

Version 1.0.1 has been released:

Bugfixes:

• Fixed bots sometimes delivering the wrong item after using the remote
• Fixed a crash when clicking Save

[GameCharmer]

Thanks Macros! I'll give it a shot.

[Macros]

Version 1.0.2 has been released:

Optimizations:

• Idle turrets are checked less often
• Smoothed the distribution of checks to prevent noticeable lag spikes

Future plans:
I plan on adding the ability to connect logistic turrets to circuit networks once Factorio v0.13 is released. Hopefully it will be fairly straightforward.

I am aware of the issue with the turret GUI - the way images scale was changed in Factorio v0.12.31, and is producing some odd results. Version 0.13 should bring some improvements to the way GUIs work, so I'm going to hold off on fixing it until then. For now, the GUI remains usable, just ugly.

[Macros]

Version 1.0.3 has been released:

Fixes:

• Fixed the turret GUI display for Factorio v0.12.33
• GUIs now close when their turret is destroyed, mined, or marked for deconstruction
• GUIs no longer persist through a save and reload
• Fixed a method by which a turret could be set to request 0 items
• Cleaned up the codebase

As a result of these changes, the minimum required Factorio version has been increased to v0.12.33.

I know I said I wouldn't be fixing the GUI until Factorio v0.13 came out. This post by judos convinced me to change my mind and give it a whirl. The end result turned out to be almost, if not exactly, the same as it was prior to Factorio v0.12.31.

[Macros]

Version 1.0.4 has been released:

Fixes:

• Fixed multiplayer desync issue

Features:

• Added TimerInterval setting to the config file

[Lightning_Bird]

If anyone finds it useful here's

AutoFill DyTech code

Code: Select all

local turretFillSet = {group="turrets", limits= {10}, "ammo-bullets"}
local turretFillSet2 = {group="turrets", limits= {10}, "ammo-battery"}
local turretFillSet3 = {group="turrets", limits= {10}, "ammo-shotgun-shell"}
local turretFillSet4 = {group="turrets", limits= {10}, "ammo-rocket"}
local turretFillSet5 = {group="turrets", limits= {10}, "ammo-flame-thrower"}
local turretFillSet6 = {group="turrets", limits= {10}, "ammo-cannon-shell"}
local turretFillSet7 = {group="turrets", limits= {10}, "ammo-sniper-ammo"}
local turretFillSet8 = {group="turrets", limits= {10}, "ammo-battery-shotgun"}
local turretFillSet9 = {group="turrets", limits= {10}, "ammo-capsule"}

return {
--DyTech War--
["gun-turret-1"] = turretFillSet,
["sniper-turret"] = turretFillSet7,
["gun-turret-2"] = turretFillSet3,
["gun-turret-3"] = turretFillSet4,
["gun-turret-4"] = turretFillSet6,
["gun-turret-5"] = turretFillSet9,
["gun-turret-6"] = turretFillSet2,
["gun-turret-7"] = turretFillSet8,
["gun-turret-1-armored"] = turretFillSet,
["gun-turret-2-armored"] = turretFillSet3,
["gun-turret-3-armored"] = turretFillSet4,
["gun-turret-4-armored"] = turretFillSet9,
["gun-turret-5-armored"] = turretFillSet6,
["gun-turret-6-armored"] = turretFillSet2,
["gun-turret-7-armored"] = turretFillSet2,
["flame-thrower-turret"] = turretFillSet8,
}

Macromanaged Turrets DyTech code

Code: Select all

--DyTech turrets : 

LogisticTurret["sniper-turret"] = {ammo = "sniper-magazine", count = 5}
LogisticTurret["gun-turret-1"] = {ammo = "piercing-bullet-magazine", count = 5}
LogisticTurret["gun-turret-2"] = {ammo = "piercing-shotgun-shell", count = 5}
LogisticTurret["gun-turret-3"] = {ammo = "explosive-rocket", count = 5}
LogisticTurret["gun-turret-4"] = {ammo = "cannon-shell", count = 5}
LogisticTurret["gun-turret-5"] = {ammo = "poison-capsule-ammo-1", count = 5}
LogisticTurret["gun-turret-6"] = {ammo = "laser-clip-1", count = 5}
LogisticTurret["gun-turret-7"] = {ammo = "laser-clip-shotgun-1", count = 5}
LogisticTurret["gun-turret-1-armored"] = {ammo = "piercing-bullet-magazine", count = 5}
LogisticTurret["gun-turret-2-armored"] = {ammo = "piercing-shotgun-shell", count = 5}
LogisticTurret["gun-turret-3-armored"] = {ammo = "explosive-rocket", count = 5}
LogisticTurret["gun-turret-4-armored"] = {ammo = "explosive-cannon-shell", count = 5}
LogisticTurret["gun-turret-5-armored"] = {ammo = "poison-capsule-ammo-1", count = 5}
LogisticTurret["gun-turret-6-armored"] = {ammo = "laser-clip-1", count = 5}
LogisticTurret["gun-turret-7-armored"] = {ammo = "laser-clip-shotgun-1", count = 5}
LogisticTurret["flame-thrower-turret"] = {ammo = "flame-thrower-ammo", count = 5}

[NoriSilverrage]

Heya, is this going to be updated for 0.13?

[Macros]

Yes, I have an update almost ready to publish. I'm sorry it's taking me so long; I haven't had a stable internet connection in weeks. I've spent the time completely overhauling the GUI to use the new selection tool item, and have started work on the circuit network aspect. Turns out it's not very straightforward at all.

The plan is to fix my internet sometime next week.

[DUMBHA]

Just curious. Was a update for this mod still planned? Or has RL stuff put a hold on it.

[Macros]

I'm sorry for the tremendous delay. Version 1.1.0 is now available for download. For the time being, it's not on the mod portal, and I haven't yet updated the GitHub repo. You can find the download link in the attachments section of the first post.

The changelog is too large to post here, so please click this link to view it.

[Nexela]

Wow, That is not a change log, it is a change novel.


Great work on this mod, hopefully I will get a chance to try it out this weekend.

[Macros]

Version 1.1.1 has been released:

Bugfixes:

• Fixed the configure_logistic_turret remote call. This function now only takes two arguments. The second argument follows the same format as config file entries.
• Deleting a surface that had ghost turrets will no longer cause a crash when loading that world.
• Turrets will now regain their custom labels when rebuilt from a ghost.

With this release, the mod is now available on the mod portal.

[Semaphor]

0.14.19 bug. Looks like, despite my efforts, a turret will always show a 10 stack of ammo even though the amount should be 20 (logistics request set to 20). However, there appears to be multiple stacks of 10; one displayed and one hidden. When a turret is given 20 ammo, 10 appears. When you shift-click to pick up the turret contents, it picks up 10. But you can do that twice; once for the initial 10 stack, and another time for the hidden 10 stack.

Reproducible all the time.