LuaSurface.find_tiles_filtered needs more detail

Place to report issues and suggest improvements to the API documentation.
Post Reply
Honktown
Smart Inserter
Smart Inserter
Posts: 1025
Joined: Thu Oct 03, 2019 7:10 am
Contact:

LuaSurface.find_tiles_filtered needs more detail

Post by Honktown »

LuaSurface.find_tiles_filtered

Code: Select all

has_hidden_tile :: boolean (optional)
Was looking at this and wasn't sure if it would mean: must vs can have a hidden tile (true), must not (false), and the default, tiles with and without hidden tiles ("doesn't matter") or does not have a hidden tile? (false) .

There are some other same/similar parameters in other functions:
count_entities_filtered
to_be_deconstructed :: boolean (optional)
to_be_upgraded :: boolean (optional)

count_tiles_filtered has another has_hidden_tile
I have mods! I guess!
Link

Honktown
Smart Inserter
Smart Inserter
Posts: 1025
Joined: Thu Oct 03, 2019 7:10 am
Contact:

Re: Documentation Improvement Requests

Post by Honktown »

find_tiles_filtered
A small request for clarification on "force". Tiles don't have forces, and a tile ghost is a LuaEntity (as well as a decon proxy). Is force used in the context of returning tile ghosts, tiles with deconstruction proxies?

-- edit (boskid):
Note: `force` parameter is only used if `to_be_deconstructed` or `has_tile_ghost` is also used as those require a related entity searches.
I have mods! I guess!
Link

Post Reply

Return to “Documentation Improvement Requests”