emk
commented
1 week ago OK, some notes from the API:
- Signals appear to be represented as ItemIDAndQualityIDPair
- Filters should be represented as ItemFilter.
Signals. If we look up .signals on a circuit network like this:
/c helpers.write_file('quality-signals.json', serpent.block(game.surfaces[5].find_entities_filtered{name='hud-combinator'}[1].get_circuit_network(2).signals))...we get an array of signals in ItemIDAndQualityIDPair format:
{
count = 707,
signal = {
name = "quality-module-3"
}
},
{
count = 384,
signal = {
name = "quality-module-3",
quality = "uncommon"
}
},
{
count = 63,
signal = {
name = "quality-module-3",
quality = "rare"
}
},If quality is omitted, that means it's common.
Filters. If I'm reading the docs right, these should look something like:
{
name = "quality-module-3',
quality = 'uncommon',
comparator = '≥'
}But name is optional, so we may get filters like:
{
quality = 'uncommon',
comparator = '≥'
}Or we may see filters like:
{
name = "quality-module-3',
}Presumably, if we make sure that we recognize these values when returned from the API, and we pass them to the right API calls, we should be able to get most things working pretty quickly.
Other things we may need to do. We might also need to:
- [x] Implement signal filtering using
comparatorandquality, if present. This is implemented byfilter_signalinhud-gui.lua, and it should be easy to fix. Migrate data from earlier versions of the mod. The only data affected would beNo migration needed!storage.filtersincombinator.lua, I believe. This would probably need to change from a list of strings to a list of filter tables, as seen above. There's alreadymigration.luawith support for migrating data.- [x] Fix signal icons to include quality indicators. It's actually unclear how to do this with UI elements like
sprite-button. The existing code usessprite-buttonwithsprite = 'signal_type/signal_name, but there's no documented way to pass quality. But quality doesn't seem to be 100% documented, either, so it might be worth looking at other mods.
JasonLandbridge
hgschmie
(Since people are interested, let's make this a real issue.)
How quality works. Factorio 2.0 adds an (optional) quality mechanism. If you insert "quality modules" in a machine, it will occasionally produce higher quality outputs. For example, a furnace with quality mods might produce:
The game treats these as five entirely different items. You can't make steel, for example, by mixing 4 common and 1 uncommon iron plate. You can either make common steel using 5 common iron plates, or uncommon steel using 5 uncommon iron plates. (And of course you can put quality mods in your steel furnace, for a random chance of jumping up a tier.)
Supporting quality in Circuit HUD. There are a number of things that would need to happen. Let's break these down into categories. First, the essentials:
Finally, there's an advanced feature possible here:
Support "advanced"/"comparison-based" quality filters, like inserters and splitters do. These filters allow saying things like "show all iron plates of at least uncommon rarity", or "show all items which are rare or better."(See discussion; the Lua API seems to be missing what we need.)I think Cricuit HUD would be a ridiculously useful tool for monitoring high-quality production lines, which involve large numbers of similar items and feedback loops.
If I have time this weekend, I'll look at the mod API and see if I can start roughing out a PR. But if anyone else is interested, please go ahead!