LuaChunkIterator - Runtime Docs

ClassLuaChunkIterator

A chunk iterator can be used for iterating chunks coordinates of a surface.

The returned type is a ChunkPositionAndArea containing the chunk coordinates and its area.

Example

for chunk in some_surface.get_chunks() do
  game.player.print("x: " .. chunk.x .. ", y: " .. chunk.y)
  game.player.print("area: " .. serpent.line(chunk.area))
end

Members

valid	:: R boolean	Is this object valid? [...]
Is this object valid? [...]
object_name	:: R string	The class name of this object. [...]
The class name of this object. [...]
() (call)	→ ChunkPositionAndArea?	Gets the next chunk position if the iterator is not yet done and increments the it.
Gets the next chunk position if the iterator is not yet done and increments the it.

Attributes

valid :: Read boolean

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

object_name :: Read string

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Operators

() (call) → ChunkPositionAndArea?

Gets the next chunk position if the iterator is not yet done and increments the it.

Classes - Concepts - Events - Defines

Factorio Runtime DocsVersion 2.0.28

ClassLuaChunkIterator

Example

Members

Attributes

valid :: Read boolean

object_name :: Read string

Operators

() (call) → ChunkPositionAndArea?

Classes

Concepts

Events

Defines

Factorio Runtime Docs Version 2.0.28