Factorio Forums

Type: Library
Name: Factorio Standard Library
Description: The Factorio Standard Library is a project to bring Factorio modders high-quality, commonly-required utilities and tools
License: MIT License
Version: 0.8.0
Release: 2017-01-12
Tested-With-Factorio-Version: 0.13.11+, 0.14.X, 0.15.X
Category: Library
Github: https://github.com/Afforess/Factorio-Stdlib
Releases: https://github.com/Afforess/Factorio-Stdlib/releases
Wiki: https://github.com/Afforess/Factorio-Stdlib/wiki
Lua Docs: http://afforess.github.io/Factorio-Stdlib/

What is the Factorio Standard Library?
Why the Factorio Standard Library?
How do I use the Factorio Standard Library?
Contributing to the Factorio Standard Library
Version history

Outstanding. Thank you for your work

Another nice bit to have would be a function to copy the contents of one inventory into another (perhaps even with filters to only copy certain types of items?)

A simplistic example:
I'm not sure the above code will work in all cases, though -- like for blueprints, it might not copy over the set-up blueprint but just give a blank one instead. And it hardcodes the #define for chest, rather than allowing others like player inventory, etc.

Supercheese wrote:Another nice bit to have would be a function to copy the contents of one inventory into another (perhaps even with filters to only copy certain types of items?)

A simplistic example:

Code: Select all

function copyInventory(from, to)
	local inventory = from.get_inventory(defines.inventory.chest)
	local contents = inventory.get_contents()
	for n, c in pairs(contents) do
		to.insert({name=n, count=c})
	end
end

I'm not sure the above code will work in all cases, though -- like for blueprints, it might not copy over the set-up blueprint but just give a blank one instead. And it hardcodes the #define for chest, rather than allowing others like player inventory, etc.

Inventory.copy_inventory is now in release 0.1.0.

Also notable, all of the code except the logging is currently unit tested. This actually caught a bug in the codebase, and has already proven valuable.

Version 0.2.0 released. More functions, more unit tests, and now, error messages for missing arguments when using stdlib apis. See the API docs or changelog for details.

Version 0.2.1 is released. Two new Area functions, and improved the documentation for the Area functions.

Hey, perhaps you can include my code for finding all entities (or filtered entities):
Input is a table containing:
name (string)
type (string)
force (string or force (eg game.player.force)
surface (string eg "nauvis" or table of surfaces eg {game.player.surface}, you can't input game.player.surface directly without brackets)
all optional.

The create_number_array() function is optional, it just make sure that your returned array is nicely ordered so you can do a #operator on it.

It could technically overwrite entities if they are on the same spot since I just their location as key for the array. (This is on purpose so that entities that are on chuck borders don't appear twice in the array, without the need to check the array whether or not that entity is already in it.)

Factorio Stdlib 0.3.0 is released, with many new additions. See the changelog for full details.

MrDoomah wrote:Hey, perhaps you can include my code for finding all entities (or filtered entities)

Thanks for the suggestion. 0.3.0 includes Surface.find_all_entities, which closely matches what you suggested.

Factorio Standard Library 0.4.0 is released! Many improvements to core classes, like table and string. Factorio Standard Library is entirely forward compatible, if you are on an old version, there is zero risk in upgrading.

I've updated the wiki with two new examples on how to use the Factorio Standard Library:

The first new example is on avoiding iteration, and general stdlib tools: https://github.com/Afforess/Factorio-St ... dlib-tools

The second new example is on how to take advantage of entity data storage: https://github.com/Afforess/Factorio-St ... ntity-data

I know a few functions I'd like to have easier acces to. dysoch use them a lot in Dytech. If you check Dytech Core and the Ovvrire functions, the functions like change recipe, addtorecipe etc are really helpful to use

kasandraen wrote:I know a few functions I'd like to have easier acces to. dysoch use them a lot in Dytech. If you check Dytech Core and the Ovvrire functions, the functions like change recipe, addtorecipe etc are really helpful to use

Sounds like a good idea. I haven't written a utility for the data class yet, but it is high on my list of things to improve.

Afforess wrote:

kasandraen wrote:I know a few functions I'd like to have easier acces to. dysoch use them a lot in Dytech. If you check Dytech Core and the Ovvrire functions, the functions like change recipe, addtorecipe etc are really helpful to use

Sounds like a good idea. I haven't written a utility for the data class yet, but it is high on my list of things to improve.

You should talk with bobbingabout - he wrote boblibrary and those kind of functions are there already.

orzelek wrote:

Afforess wrote:

kasandraen wrote:I know a few functions I'd like to have easier acces to. dysoch use them a lot in Dytech. If you check Dytech Core and the Ovvrire functions, the functions like change recipe, addtorecipe etc are really helpful to use

Sounds like a good idea. I haven't written a utility for the data class yet, but it is high on my list of things to improve.

You should talk with bobbingabout - he wrote boblibrary and those kind of functions are there already.

I've seen and used a few of those myself for Marathon, so I know exactly what you are referring to

Like this !

Hi, just leaving a note to say thanks for your work

By the way, is there an easy way to trigger events on a clock? For example every sunset and so on...

Something that would be really great would be a gui library (like what I already do in diplomacy) that would permit :

• Creating template (with styles) that can later be used needing less repetition of code and a better understanding of the code.
• Anonymous gui elements (sometimes you don't need a name for a label you never touch again)
• Advanced element event callback :
  • All : custom function callback and arguments per elements (like I do to pass arguments in diplomacy)
  • Checkbox : Current state
  • Text Area : Text content
  {*]Widgets groups : They will act like a single wigdet and so modifying a property would modify the widget inside it :
  • An example would be a progressbar with label.
  • Simple question dialog.
    {*]Item cell.

CorrettoSambuca wrote:Hi, just leaving a note to say thanks for your work

By the way, is there an easy way to trigger events on a clock? For example every sunset and so on...

There isn't (you could do an event on tick, and check the time of day), but clock events are an interesting idea.

y.petremann wrote:Something that would be really great would be a gui library (like what I already do in diplomacy) that would permit :

• Creating template (with styles) that can later be used needing less repetition of code and a better understanding of the code.
• Anonymous gui elements (sometimes you don't need a name for a label you never touch again)
• Advanced element event callback :
  • All : custom function callback and arguments per elements (like I do to pass arguments in diplomacy)
  • Checkbox : Current state
  • Text Area : Text content
  {*]Widgets groups : They will act like a single wigdet and so modifying a property would modify the widget inside it :
  • An example would be a progressbar with label.
  • Simple question dialog.
    {*]Item cell.

Yea, I have some minor experience with the GUI library, and I will suffice to say it could be massively improved by a library like stdlib. I agree with custom callbacks (the one giant event the game currently offers leads to terrible code most of the time), and the idea of creating gui templates is intriguing. I think there is a lot of ideas that for this particular part of the API.

The Factorio Standard Library 0.5.0 is released, with a number of improvements & a few bug fixes:

Version 0.5.0

• Improved table.map, filter, and each to also include additional arguments and index.
• Added Event.core_events, allows registering Events for on_init, on_load, and on_configuration_changed
• Added options to Logger.new, adds option to modify the file extension and alter the timestamp format
• Added Chunk.get to calculate the chunk coordinates for a given tile position
• Added Chunk.get_data, retrieves mod data stored on a chunk position
• Added Chunk.set_data sets mod data on a chunk position
• Added Tile.from_position, calculates tile coordinates from a position
• Added Tile.to_area, returns the area that a single tile occupies
• Added Tile.get_data, retrieves mod data stored on a tile position
• Added Tile.set_data, sets mod data on a tile position
• Added Area.spiral_iterate, is an alternate iterator (compared to Area.iterate) that iterates the Area in an inside-out spiral fashion
• Added Area.center, returns the center position of an Area
• Added string.contains, tests if a string contains a substring
• Added Time contants, provides easy reference for Time.SECOND, Time.MINUTE, Time.HOUR, Time.DAY, and Time.WEEK in factorio tick time
• Improved the lua docs, so they share the same look and feel as the factorio lua docs
• Fixed Logger writing after one hour instead of one minute
• Fixed Event registry with Event.core_events.init not raising errors correctly
• Note: Thanks to mojo2012, Choumiko, and Supercheese for their contributions to 0.5.0