Small documentation improvement requests
Re: Small documentation improvement requests
https://wiki.factorio.com/Types/LightDefinition#type - the dependent property listing is inconsistent with other pages, where they are listed on the same level as the independent ones.
Re: Small documentation improvement requests
https://lua-api.factorio.com/latest/Con ... ventFilter:
This looks incomplete -- perhaps somebody removed the rest of the sentence accidentally?
-> This is actually just a bit of unfortunate formatting. That filter only supports "type", and is the only one to do so. I added a period at the end of those sentences for the next release though, to make it clearer that there's nothing missing. Thanks for bringing it up!
Fields
filter
:: string
The condition to filter on. One of "type"
-> This is actually just a bit of unfortunate formatting. That filter only supports "type", and is the only one to do so. I added a period at the end of those sentences for the next release though, to make it clearer that there's nothing missing. Thanks for bringing it up!
A good mod deserves a good changelog. Here's a tutorial (WIP) about Factorio's way too strict changelog syntax!
Re: Small documentation improvement requests
https://wiki.factorio.com/Types/SpriteFlags is in dire need of descriptions.
Re: Small documentation improvement requests
-> It's listed on all prototypes where it matters (maximum number is 255 or less).
-
- Burner Inserter
- Posts: 8
- Joined: Sun Jan 09, 2022 1:18 pm
- Contact:
Re: Small documentation improvement requests
-> This was fixed.
Re: Small documentation improvement requests
-> Thanks, added for the next release. It's [0, 1].
Re: Small documentation improvement requests
The description for `scroll_mode` for `scroll_to_element` seems to be identical, it is correct in that case, just make sure to not break that one if they are shared.
-> Thanks Jan. If I were pedantic, it could be interpreted as 'in the scroll-pane of the list-box', but you're right that it's confusing, so I changed it for the next release. No worries about them being shared, documentation like this is almost always just copy-pasted, not actually shared. Which is probably where the mistake came from in the first place!
Also known as JanSharp. jan1i3 was/is my old name ;)
Re: Small documentation improvement requests
Speaking of which:
jan1i3 wrote: ↑Mon Jan 10, 2022 4:44 pmThe description for `scroll_mode` for LuaGuiElement::scroll_to_item mentions "scroll-pane", contrary to the function's (correct) description saying "listbox".
-> Not sure if it didn't show when you made this comment, but the 'Can only be used if this is X' lines are present in the most recent version of the docs website. In that specific case, it only work for listboxes. 'scroll_to_element' can be used for scroll-panes.
Re: Small documentation improvement requests
Class LuaEquipment
The role of the power armor is not really clear in this example: Is the armor the item that can be placed in the equipment grid, or is the armor the grid where other things can be placed in? I'd put it this way:
-> Good spot, that is indeed confusing. Appreciate the alternate wording, fixed for the next release.
Code: Select all
An item in a LuaEquipmentGrid, for example one's power armor.
Code: Select all
An item in a LuaEquipmentGrid, for example a fusion reactor placed in one's power armor.
A good mod deserves a good changelog. Here's a tutorial (WIP) about Factorio's way too strict changelog syntax!
Re: Small documentation improvement requests
Pi-C wrote: ↑Thu Jan 06, 2022 7:16 pmhttps://lua-api.factorio.com/latest/Con ... ventFilter:This looks incomplete -- perhaps somebody removed the rest of the sentence accidentally?Fields
filter
:: string
The condition to filter on. One of "type"
-> This is true, see response in the next comment.
I have mods! I guess!
Link
Link
Re: Small documentation improvement requests
Logically the plural-ness could be split into two or three cases... one (first), two (first and last), and "many" (first, last, middles). -> one = "filter of type a", two = "filter of type a[,] or b", many = "filter of type a, [b, c, ...], or last

-> Alright, because you've been so nice about it, I added a separate case for when there's only one option for the next release. Thanks for bringing it up.
A good mod deserves a good changelog. Here's a tutorial (WIP) about Factorio's way too strict changelog syntax!
Re: Small documentation improvement requests
https://wiki.factorio.com/Prototype/AutoplaceControl
It shouldn't be "wasn't", probably "won't" or "will not"
-> Fixed the edit. Please keep in mind that the wiki can be edited by anyone, so some edits may not have the expected quality until they have been corrected by someone else. You are invited to do these corrections yourself.
you will not able to change it because gui wasn`t display it.
-> Fixed the edit. Please keep in mind that the wiki can be edited by anyone, so some edits may not have the expected quality until they have been corrected by someone else. You are invited to do these corrections yourself.
Re: Small documentation improvement requests
LuaSurface::create_entity (with "flying-text")
LuaGuiElement::add (lots of LocalisedStrings in here)
LuaEntity.add_market_item (with Offer with TechnologyModifier type "nothing" and effect_description)
Note that you can actually directly assign to the properties that take LocalisedStrings after creating the entity or gui element and it works (though it might not be the most intentional that it does, see link below). I don't think you can directly set the market offer's LocalisedString, so that's the only place where you truly can't use LuaProfilers, but that's also kind of ridiculous

And note that I only tested caption for LuaGuiElements, but I'm confident that the same applies to the others.
reference: viewtopic.php?p=560263#p560263
-> Thanks for the well-researched comment, I noted those three exceptions on LuaProfiler for the next release. I didn't bring up the fact that you could set them after the fact. If you have a good reason for me to mention that, please let me know.
Also known as JanSharp. jan1i3 was/is my old name ;)
Re: Small documentation improvement requests
-> Added, together with the other changes from 1.1.51.
I have mods! I guess!
Link
Link
Re: Small documentation improvement requests
https://lua-api.factorio.com/latest/Con ... kWithFlags should explain the flags or link to the explanations at https://wiki.factorio.com/Types/CollisionMask
-> Thanks for the hints, I did addressed both points for the next release.
My mods: Spidertron Patrols | Spidertron Enhancements | Factory Search | Spidertron Engineer | Spidertron Weapon Switcher | Power Overload
Re: Small documentation improvement requests
https://lua-api.factorio.com/1.1.53/Con ... otypeData
SelectedPrototypeData could use some details
SelectedPrototypeData could use some details
I have to guess and check at the moment.table SelectedPrototypeData
Fields
base_type
:: string
E.g. "entity".
derived_type
:: string
E.g. "tree".
name
:: string
E.g. "tree-05".
I have mods! I guess!
Link
Link
Re: Small documentation improvement requests
-> The Position concept has been removed for the next version, everything now uses the specialized positions like MapPosition and TilePosition. So this is now fixed by it no longer being confusing what Position is for.
Re: Small documentation improvement requests
-> I added an explanation for the next release. The front of the train is the one most locomotives are pointing to. If it's a tie, North and West take precedence.
Thank you for not ignoring this, because to me it looked like the issue was fixed in the worst possible way.Therenas wrote: ↑Sun Jan 23, 2022 10:36 amI 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 encompass both somehow, but make it hard to know what really applies. The solution to this in my mind is to allow differing read and write types on attributes if necessary. This is a somewhat involved solution though, so it'll take some time.
-
- Burner Inserter
- Posts: 14
- Joined: Mon Sep 13, 2021 6:53 pm
- Contact:
Re: Small documentation improvement requests
In previous versions of the API (like this one), this property had a note that it can only be used for crafting machines. This note is no longer there even though I still believe it applies.
-> As noted before, this has been fixed for the next release.
Re: Small documentation improvement requests
edit: ah, I see, it was fixed for methods, but not for properties.
->