Prototype definitions reference format

[kovarex]

I started building the reference of all configurable parameters of individual prototypes, so you won't have to guess what works there etc.
I'm not sure about the format, as this will be quite big, I would like you to look at the two sample pages I made, and criticise it before I write the rest

https://forums.factorio.com/wiki/inde ... efinitions

[Nirahiel]

Looks good
If the format needs to be remade, I'm sure we can do it later

[FreeER]

Looks great to me

[drs9999]

Yep, nothing to complain about

[Dysoch]

those 2 pages alone helped me alot.

especially the event page, which will be needed for my mod in a few updates once i figured it out how to add it using your starter campaign.

SO YES, write more

[JamesOFarrell]

those 2 pages alone helped me alot.... SO YES, write more

Yes, this. Those 2 pages were the most useful tools while I was programming, Thank you so much.

[kitsune9tails]

This page is really cool (thank you so much!) and is a necessity, I believe, to true mod development. However, it is still incomplete and is missing several fairly important class definitions (like the "Technology" class). Is there a place where we can actually see all the class prototypes for the Prototype objects? I need to know what properties and subclasses are available for each class and what they mean before I can really dive into modding.

[FreeER]

Is there a place where we can actually see all the class prototypes for the Prototype objects? I need to know what properties and subclasses are available for each class and what they mean before I can really dive into modding.

Not really... All I can say is check out the base game prototypes and you'll see the obvious/common ones (look hard enough and you should see everything with maybe a tiny number of exceptions). Of course you are free to add your 'discoveries' to the wiki It's incomplete mainly because it's a long (boring) process of improving the wiki and, of course, everyone only has so much time.

[Plorntus]

Currently trying to automatically dump all the prototypes for quick wiki upload, its not 100% working yet however kitsune9tails I have managed to dump the valid parameters of the Technology class:

Code: Select all

  "technology": {
    "effects": {
      "ammo_category": "string",
      "modifier": "number",
      "type": "string",
      "recipe": "string"
    },
    "icon": "string",
    "name": "string",
    "order": "string",
    "prerequisites": "string",
    "type": "string",
    "unit": {
      "count": "number",
      "ingredients": "number",
      "time": "number"
    },
    "upgrade": "string",
    "enabled": "boolean"
  },

EDIT: hah did not realize how old this thread was.

[TheSim]

Is there are fresh Modding API reference?

[wahming]

Bump. Is there any way we modders can get a list of available properties/methods for all prototypes? At the moment it's a struggle getting the info we need from the game.

[GotLag]

Any news on getting this updated?

[johanwanderer]

Bump. Is there any way we modders can get a list of available properties/methods for all prototypes? At the moment it's a struggle getting the info we need from the game.

For Lua objects:

Code: Select all

/c sel = function() return game.player.selected; end
/c mh = function()  game.make_file("help/" .. sel().name, sel().help()); end

Move your mouse over something, and then "/c mh()", then look under script-output/help/ for the help text

For the prototypes themselves, I would just look under data/base/prototypes/... what you see is what you get there.

[orzelek]

You can also call the help method on objects like player or game to see what are the available functions and properties.

[GotLag]

Bump. Is there any way we modders can get a list of available properties/methods for all prototypes? At the moment it's a struggle getting the info we need from the game.

For Lua objects:

Code: Select all

/c sel = function() return game.player.selected; end
/c mh = function()  game.make_file("help/" .. sel().name, sel().help()); end

Move your mouse over something, and then "/c mh()", then look under script-output/help/ for the help text

For the prototypes themselves, I would just look under data/base/prototypes/... what you see is what you get there.

This outputs a file with the name of the entity selected, but the content is always the same: LuaEntity