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.
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
operator () → ChunkPositionAndArea
Get the next chunk position or
nil, and increments the iterator.
help () → string
All methods and properties that this object supports.
valid :: boolean[Read]
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 :: string[Read]
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.