LuaTile

A single "square" on the map.

Attributes

name

• Read: string
• Write: unknown
• Optional: false

Prototype name of this tile. E.g. "sand-3" or "grass-2".

prototype

• Read: LuaTilePrototype
• Write: unknown
• Optional: false

position

• Read: TilePosition
• Write: unknown
• Optional: false

The position this tile references.

hidden_tile

• Read: string
• Write: unknown
• Optional: true

The name of the LuaTilePrototype hidden under this tile, if any.

During normal gameplay, only non-mineable or foundation tiles can become hidden. This can however be circumvented with LuaSurface::set_hidden_tile.

double_hidden_tile

• Read: string
• Write: unknown
• Optional: true

The name of the LuaTilePrototype double hidden under this tile or nil if there is no double hidden tile.

During normal gameplay, only non-mineable tiles can become double hidden. This can however be circumvented with LuaSurface::set_double_hidden_tile.

surface

• Read: LuaSurface
• Write: unknown
• Optional: false

The surface this tile is on.

valid

• Read: boolean
• Write: unknown
• Optional: false

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
• Write: unknown
• Optional: false

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.

Methods

collides_with

LuaTile.collides_with(layer: CollisionLayerID) -> boolean

Call As

tile.collides_with(layer)

Call Convention

• takes_table: false
• table_optional: false

What type of things can collide with this tile?

Parameters

• layer: CollisionLayerID

Returns

• boolean

to_be_deconstructed

LuaTile.to_be_deconstructed(force?: ForceID) -> boolean

Call As

tile.to_be_deconstructed()

Call Convention

• takes_table: false
• table_optional: false

Is this tile marked for deconstruction?

Parameters

• force?: ForceID — The force whose robots are supposed to do the deconstruction. If not given, checks if to be deconstructed by any force.

Returns

• boolean

order_deconstruction

LuaTile.order_deconstruction(force: ForceID, player?: PlayerIdentification) -> LuaEntity?

Call As

tile.order_deconstruction(force, player)

Call Convention

• takes_table: false
• table_optional: false

Orders deconstruction of this tile by the given force.

Parameters

• force: ForceID — The force whose robots are supposed to do the deconstruction.
• player?: PlayerIdentification — The player to set the last_user to if any.

Returns

• LuaEntity? — The deconstructible tile proxy created, if any.

cancel_deconstruction

LuaTile.cancel_deconstruction(force: ForceID, player?: PlayerIdentification)

Call As

tile.cancel_deconstruction(force, player)

Call Convention

• takes_table: false
• table_optional: false

Cancels deconstruction if it is scheduled, does nothing otherwise.

Parameters

• force: ForceID — The force who did the deconstruction order.
• player?: PlayerIdentification — The player to set the last_user to if any.

has_tile_ghost

LuaTile.has_tile_ghost(force?: ForceID) -> boolean

Call As

tile.has_tile_ghost()

Call Convention

• takes_table: false
• table_optional: false

Does this tile have any tile ghosts on it.

Parameters

• force?: ForceID — Check for tile ghosts of this force.

Returns

• boolean

get_tile_ghosts

LuaTile.get_tile_ghosts(force?: ForceID) -> Array<LuaEntity>

Call As

tile.get_tile_ghosts()

Call Convention

• takes_table: false
• table_optional: false

Gets all tile ghosts on this tile.

Parameters

• force?: ForceID — Get tile ghosts of this force.

Returns

• Array<LuaEntity> — The tile ghosts.