Hello everyone, we’ve been working on a design refresh of the API docs . There were a couple of big and many small problems that we wanted to address to improve readability and usability. The functionality and content stayed mostly the same, this was mainly about presentation. The redesign was also ...

Ah yeah I was looking at the mod portal ones, great news then, thanks!

Hi there, I just noticed that one of your mods (not sure which one) adds a beacon called "hidden-beacon", presumably for some module effects shenanigans. The entity prototype for it is however not marked as hidden, which makes it hard for my mod (https://mods.factorio.com/mod/factoryplanne...

Something else, when exploring the API docs site from a phone, it’s difficult to find anything because there is no search field like on desktops. URL appears to be the same, and using the “Request desktop site” feature from my phone appears to make no difference, so I assume this is an automatic fo...

So this is a bit of a weird case, as the second parameter is not actually optional. It always needs to be there, but it can be 'nil'. This kind of API design pattern isn't used a lot in the API, but in some places it is. I updated the docs to show the type as 'string or nil' for the next release, wh...

ixu wrote: ↑

Tue May 03, 2022 11:25 pm

Sorry for complaining so much.
Perhaps the documentation should mention that the force is also provided in event interface.

Good spot, I fixed the docs for the next release.

On the main page (https://lua-api.factorio.com/latest/index.html) the Classes header isn't clickable, but the Events header further down the page is. Capture.PNG There is the Classes page that I assume the header should link to: https://lua-api.factorio.com/latest/Classes.html You are absolutely ri...

I just wanted to make a quick note on all the Position conversation: I agree that it's all a pretty big mess at the moment. The fundamental issue is that read and write have to have the same type in the docs, even when they don't behave the same, so you end up with confusing concepts that try to en...

Can confirm, crashes for me too, macos log attached.

Silari is right in this case, I actually put that x/y line there myself pretty recently. The whole situation isn't great, it's on my list to come up with a better solution to it, but the underlying issue is that it's just inconsistently implemented in the APIs, sometimes it's one way, sometimes the ...

I attached the mod to this message for those that are interested. The script likely won't run though since it uses some non-release API calls. But the map should be able to be migrated step by step to a recent release.

Hi, thanks for the very detailed report, appreciate it! I‘ll try to have a look soon.

Edit: I fixed this bug, more info on the mod portal.

That is great! Unfortunately not retroactive, but awesome fo the future. Can we have such a json output for prototype definitions as well (even though they are only in the wiki and mostly manually updated)? I'd have liked to make it work retroactively, but unfortunately getting this to work well re...

This is a thing now!

Appreciate all the feedback, I'll change the method description to lay out these nuances.

Added a machine-readable JSON format of the runtime documentation, which can be used by developer tools to provide code completion and related functionality. is this json schema and where can I find it so I can use it as a linter! Information about it can be found here , and support for code comple...

You're right, probably best to be explicit. Fixed for the next release.

The whole 'Can only be used if' system is kind of bad in general though, it's due for a re-do at some point I feel like.

Doesn't CraftingMachine already imply that?

https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.get_recipe Works on a ghost of a crafting machine. Not sure if it is intentional or not (there is no other obvious way to check the recipe on a ghost), but it works. get_recipe() and previous_recipe don't do anything on a blueprint of a f...

I'll look into it.