search

GlassBricks / typed-factorio

Complete and featureful Typescript defintions for the Factorio modding API
MIT License
33 stars 3 forks source link

CraftingMachinePrototype::fluid_boxes needs manual type def #19

Closed Bilka2 closed 10 months ago

Bilka2 commented 1 year ago

I have not tried this project but I was taking a look through the files to see how people use our docs. I wanted to note that CraftingMachinePrototype::fluid_boxes needs a manual type definition, the machine readable docs don't include the off_when_no_fluid_recipe property. This is the case because we currently don't have a way to represent an array that also has a named key. This prototype property is the only place where this special format is used, everything else should be complete in the machine readable docs.

GlassBricks commented 1 year ago

Hi Bilka, Thanks for nothing this! I quickly added it in v2.0.1.

Also, if you want to look at where the docs are used, and some other places where docs are still lacking, you could look at /generator/input/manual-defs-runtime.ts. Some things there are typescript-specific, but many are not, e.g. BlueprintEntity and related definitions.

Bilka2 commented 10 months ago

We're aware of the lacking docs for blueprint entity (https://forums.factorio.com/108368), the rest seem more like typescript-specific things for me. Thank you for the pointer to the file though!