[MOD 0.12.x] Lua Combinator 0.0.1

[JamesOFarrell]

Type: Mod
Name: Lua Cominator
Description: Run a lua script in response to wire network. Can be used to query and control most in game objects. Basically command blocks for Factorio
License: MIT
Version: 0.0.1
Release: 2015-08-30
Tested-With-Factorio-Version: 0.12.x
Category: Item
Tags: Logistics, Scripting, Lua
Download-Url: Download v0.0.2
Website: Forum Thread (you are here!)

Long description

Long description

Usage
Using the Lua Combinator requires lua scripting knowledge. A good way to start with this mod is by basing away in the console and editing the examples.

The Lua Combinator will trigger a lua script when a logistics condition is met. It has option to repeat the script, to run it once after the condition changes and it to loop over entities.
This can be used for smart trains, accumulator, gates signals, roboports. logistics networks. Anything ht emod API can touch you can script with a Lua Combinator.
Repeat, will cause your command to run every half second
Post, run-once, will run your script once after the condition turns to false
Loop, will run your script once for every entity around it (in the 9x9 square)

Your script has access to the following variables (subject to change, sorry)

• global: global table shared between all Lua Combinators
  condition.value: the condition valu (true if it is met)
  condition.changed: has the condition changed?
  output: object to write to the wire network
  output.entity:, constant-combinator entity
  output:clear():, clear output
  output:get_count(item): count of item
  output:set_count(type,name,count): count of type name. see signals
  state: persistent state of Lua Combinator
  player: player who built combinator
  game: factorio game object (have fun!)
  entities: out of loop mode, this is the surrounding entities
  entity: in loop mode, this is one of the surrounding entities

Please post your scripts. I'll try to update the examples with every release!

Version history

Version history
v0.0.1 initial release.
v0.0.2 fixed bug with zipped version

License

License
The MIT License (MIT)

Copyright (c) 2015 James O'Farrell

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.


http://opensource.org/licenses/MIT

Example Scripts

Example Scripts

Code: Select all

--Wagon Inventory detector (no loop, repeat, post)
if (condition.value) then output:clear() for _,entity in pairs(entities) do if entity.name == "cargo-wagon" then inv = entity.get_inventory(1); for name,count in pairs(inv.get_contents()) do  output:set_count("item",name,count); end end end elseif (not condition.value) then output:clear() end

--locomotive-detector (no loop, repeat, post)
if (condition.value) then output:clear() for _,entity in pairs(entities) do if entity.name == "diesel-locomotive" then output:set_count("item","diesel-locomotive",1) end end else output:clear() end 

--locomotive pause(loop, repeat, post)
if entity.name == "diesel-locomotive" then entity.train.manual_mode = condition.value end

--rocket launch (loop, repeat)
if (entity.name == "rocket-silo") then player.print("lift off!"); entity.launch_rocket() end

-- rocket detector
output:clear(); for _,entity in pairs(entities) do if entity.name == "rocket-silo"  and entity.get_item_count("satellite") > 0 then output:set_count("item","rocket-silo",1) end end

-- rocket banner
if condition.value and not state.banner then state.banner = banner("Ready for launch", output.entity.position, {r=1,g=0,b=0},player,true); player.print("Ready for launch") elseif not condition.value and is_valid(state.banner) then state.banner.destroy(); state.banner = nil; player.print("Life off!") end

--Power detector (no loop, repeat, post)
if (condition.value) then output:clear() for _,entity in pairs(entities) do if entity.type == "accumulator" then output:set_count("virtual","signal-E",math.floor(entity.energy/1000 + 0.5)) end end elseif not condition.value then output:clear() end

--lock the gate - signal (no loop, repeat, post)
output:clear(); for _,entity in pairs(entities) do if entity.name == "rail-signal"  and entity.signal_state == 1 then output:set_count("item","rail-signal",1) end end

-- lock the gate- gate (loop, repeat, post)
if entity.name == "gate" then entity.active = not condition.value end

-- floating text (no loop, repeat, post)
if condition.value then banner("Hello World", output.entity.position, {r=0,g=0,b=1},player) end

-- robot usage output
output:clear() if condition.value then if state.net == nil then state.net = output.entity.surface.find_logistic_network_by_position(output.entity.position,player.force.name) end if state.net then output:set_count("item","construction-robot",state.net.available_construction_robots); output:set_count("item","logistic-robot",state.net.available_logistic_robots) end end

-- basic fluid detector
if condition.value and entity.type == "pipe" and entity.fluidbox[1] and entity.fluidbox[1].amount < 1 then if not state.on then player.print("Fluid low"); state.on = true end banner("Fluid: " .. entity.fluidbox[1].amount, output.entity.position, {r=1,g=0,b=0},player) end

--Banner, Power (post)
if condition.value and not state.banner then state.banner = banner("Backup power online", output.entity.position, {r=1,g=0,b=0},player,true); player.print("Backup power online") elseif not condition.value and is_valid(state.banner) then state.banner.destroy(); state.banner = nil end

[JamesOFarrell]

This mod only works unzipped for some reason. I am looking into it now but if you have issue just unzip the mod.

Edit fixed i think, also bonus picture

[Adil]

Impressive work. Truly impressive. If only those who code were actually playing the game

[GopherAtl]

nice, this was pretty high on my to-do list, but I'm glad to have someone beat me to it. Too many mods, not enough time, after all

[Smarty]

Moved to Work in progress by smarty

[JamesOFarrell]

Moved to Work in progress by smarty

Thanks Smarty!

[British_Petroleum]

is it possible to write a script in the lua combinator that (when the conditions are met) will spawn another lua combinator at a specified location on the map with a specified script in the newely spawned lua combinator?

[JamesOFarrell]

is it possible to write a script in the lua combinator that (when the conditions are met) will spawn another lua combinator at a specified location on the map with a specified script in the newely spawned lua combinator?

You can spawn a lua combinator but you can't set the script. it is a really good idea though so I'll put it on the todo list.

[s0ulcub3]

Hello there. I'd very much love to try this mod but it appears that it does not work with the latest Factorio build. Are there any plans to continue updates to this mod? Thanks.

[NoriSilverrage]

I'm guessing the author isn't around anymore.. The mod errors on loading a game. I looked into it and it seems pretty simple.
In control.lua lines 119-126 reference game.x and it appears that is no longer in use. Simply changing them to the following allowed the mod to work.
I ran a few basic scripts through the combinator and it worked just fine.

Code: Select all

script.on_event(defines.events.on_gui_click, on_gui_click)

script.on_event(defines.events.on_tick, on_tick)

script.on_load(on_load)

script.on_event(defines.events.on_built_entity, on_built_entity)
script.on_event(defines.events.on_robot_built_entity, on_built_entity)

[xmnovotny]

I have upgraded mod for Factorio 0.13.

Both circuit condition and logistic condition works. I have added new script variable - "circuit_network" - it is a table of LuaCircuitNetwork for red and green wire {defines.wire_type.red = .., defines.wire_type.green = ...}.

URL for download will be on the next post due to forum restrictions.

[xmnovotny]

I have added another new script variable - circuit_network_signals - table of combined values of signals from both wires.

Here is file to download:
https://www.dropbox.com/s/ef3ierbvco8h5 ... 3.zip?dl=1

[aahaxor]

I have posted a updated version for factorio version 0.14 on the official factorio mods site.

I will post the URL in the next post due to forum restrictions.

If you have a problem with it please post a bug report or whatever there.

Hope you enjoy and use!

[aahaxor]

Here is the URL for downloading the mod:

https://mods.factorio.com/mods/aahaxor/LuaCombinator

Hope you enjoy!

[nosferato]

Thanks to JamesOFarrell, for creating this and aahaxor for updating, I have been using this to work out how lua works

[poetter]

Hey aahaxor,

hope you are still around. Would it be possible for you to update this mod to 0.15? I would really like to get my hands on this mod in combination with AAI Programmable Vehicles.

[smitty]

Hey do you have this up on git hub? I'd like to help maintain it and such. If you like I can put it up there for you. And if you're not around I suppose I can just do that anyway since it's MIT licensed.

[smitty]

I created a reop here. PM me if you want to do anything with it.

https://github.com/smitty42/LuaCombinator

[deltaone]

look on http://github.com/deltaone/factorio-lua-processor as alternative ...

[martijnenco]

I created a reop here. PM me if you want to do anything with it.

How is it going with this project? Looking forward using it