Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Runtime Docs Version 2.0.77

# LuaTilePrototype - Runtime Docs

## Class LuaTilePrototype extends LuaPrototypeBase

Prototype of a tile.

Inherits from LuaPrototypeBase

## Members

collision_mask | :: R CollisionMask | The collision mask this tile uses
The collision mask this tile uses
layer | :: R uint32 |
autoplace_specification | :: R AutoplaceSpecification? | Autoplace specification for this prototype, if any.
Autoplace specification for this prototype, if any.
walking_speed_modifier | :: R float |
vehicle_friction_modifier | :: R float |
map_color | :: R Color |
decorative_removal_probability | :: R float | The probability that decorative entities will be removed from on top of this tile when this tile is generated.
The probability that decorative entities will be removed from on top of this tile when this tile is generated.
automatic_neighbors | :: R boolean |
allowed_neighbors | :: R dictionary[string → LuaTilePrototype] |
needs_correction | :: R boolean | If this tile needs correction logic applied when it's generated in the world.
If this tile needs correction logic applied when it's generated in the world.
mineable_properties | :: R table |
fluid | :: R LuaFluidPrototype? | The fluid offshore pump produces on this tile, if any.
The fluid offshore pump produces on this tile, if any.
next_direction | :: R LuaTilePrototype? | The next direction of this tile, if any. [...]
The next direction of this tile, if any. [...]
items_to_place_this | :: R array[ItemToPlace]? | Items that when placed will produce this tile, if any. [...]
Items that when placed will produce this tile, if any. [...]
can_be_part_of_blueprint | :: R boolean | False if this tile is not allowed in blueprints regardless of the ability to build it.
False if this tile is not allowed in blueprints regardless of the ability to build it.
absorptions_per_second | :: R dictionary[string → double] | A table of pollution emissions per second this tile will absorb, indexed by the name of each absorbed pollution type.
A table of pollution emissions per second this tile will absorb, indexed by the name of each absorbed pollution type.
is_foundation | :: R boolean | True if this tile can be used as a foundation for other tiles, false otherwise. [...]
True if this tile can be used as a foundation for other tiles, false otherwise. [...]
allows_being_covered | :: R boolean | True if this tile can be hidden or replaced by another tile through player actions.
True if this tile can be hidden or replaced by another tile through player actions.
check_collision_with_entities | :: R boolean | True if building this tile should check for colliding entities above and prevent building if such are found. [...]
True if building this tile should check for colliding entities above and prevent building if such are found. [...]
destroys_dropped_items | :: R boolean |
max_health | :: R float |
weight | :: R Weight |
default_cover_tile | :: R LuaTilePrototype? |
frozen_variant | :: R LuaTilePrototype? |
thawed_variant | :: R LuaTilePrototype? |
trigger_effect | :: R array[TriggerEffectItem]? |
default_destroyed_dropped_item_trigger | :: R array[TriggerItem]? |
scorch_mark_color | :: R Color? |
bound_decoratives | :: R array[LuaDecorativePrototype]? |
ambient_sounds_group | :: R LuaTilePrototype? |
factoriopedia_alternative | :: R LuaTilePrototype? | An alternative prototype that will be used to display info about this prototype in Factoriopedia.
An alternative prototype that will be used to display info about this prototype in Factoriopedia.
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. [...]

Inherited from LuaPrototypeBase

type | :: R string | Type of this prototype.
Type of this prototype.
name | :: R string | Name of this prototype.
Name of this prototype.
order | :: R string | The string used to alphabetically sort these prototypes. [...]
The string used to alphabetically sort these prototypes. [...]
localised_name | :: R LocalisedString |
localised_description | :: R LocalisedString |
factoriopedia_description | :: R LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
group | :: R LuaGroup | Group of this prototype.
Group of this prototype.
subgroup | :: R LuaGroup | Subgroup of this prototype.
Subgroup of this prototype.
hidden | :: R boolean |
hidden_in_factoriopedia | :: R boolean |
parameter | :: R boolean |
custom_tooltip_fields | :: R array[CustomTooltipField]? | Extra description items in the tooltip and Factoriopedia.
Extra description items in the tooltip and Factoriopedia.

## Attributes

### collision_mask :: Read CollisionMask

The collision mask this tile uses

### layer :: Read uint32

### autoplace_specification :: Read AutoplaceSpecification?

Autoplace specification for this prototype, if any.

### walking_speed_modifier :: Read float

### vehicle_friction_modifier :: Read float

### map_color :: Read Color

### decorative_removal_probability :: Read float

The probability that decorative entities will be removed from on top of this tile when this tile is generated.

### automatic_neighbors :: Read boolean

### allowed_neighbors :: Read dictionary[string → LuaTilePrototype]

### needs_correction :: Read boolean

If this tile needs correction logic applied when it's generated in the world.

### mineable_properties :: Read table

#### Table fields

minable | :: boolean | Is this tile mineable at all?
Is this tile mineable at all?
mining_time | :: double | Energy required to mine a tile.
Energy required to mine a tile.
mining_particle | :: string? | Prototype name of the particle produced when mining this tile. Will only be present if this tile produces any particle during mining.
Prototype name of the particle produced when mining this tile. Will only be present if this tile produces any particle during mining.
products | :: array[Product] | Products obtained by mining this tile.
Products obtained by mining this tile.

### fluid :: Read LuaFluidPrototype?

The fluid offshore pump produces on this tile, if any.

### next_direction :: Read LuaTilePrototype?

The next direction of this tile, if any. Used when a tile has multiple directions (such as hazard concrete)

### items_to_place_this :: Read array[ItemToPlace]?

Items that when placed will produce this tile, if any. Construction bots will choose the first item in the list to build this tile.

### can_be_part_of_blueprint :: Read boolean

False if this tile is not allowed in blueprints regardless of the ability to build it.

### absorptions_per_second :: Read dictionary[string → double]

A table of pollution emissions per second this tile will absorb, indexed by the name of each absorbed pollution type.

### is_foundation :: Read boolean

True if this tile can be used as a foundation for other tiles, false otherwise. Foundation tiles can be hidden.

### allows_being_covered :: Read boolean

True if this tile can be hidden or replaced by another tile through player actions.

### check_collision_with_entities :: Read boolean

True if building this tile should check for colliding entities above and prevent building if such are found. Also during mining tiles above this tile checks for entities colliding with this tile and prevents mining if such are found.

### destroys_dropped_items :: Read boolean

### max_health :: Read float

### weight :: Read Weight

### default_cover_tile :: Read LuaTilePrototype?

### frozen_variant :: Read LuaTilePrototype?

### thawed_variant :: Read LuaTilePrototype?

### trigger_effect :: Read array[TriggerEffectItem]?

### default_destroyed_dropped_item_trigger :: Read array[TriggerItem]?

### scorch_mark_color :: Read Color?

### bound_decoratives :: Read array[LuaDecorativePrototype]?

### ambient_sounds_group :: Read LuaTilePrototype?

### factoriopedia_alternative :: Read LuaTilePrototype?

An alternative prototype that will be used to display info about this prototype in Factoriopedia.

### 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.

Class used in

- LuaEntity::ghost_prototype
- LuaItemCommon::set_tile_filter()
- LuaItemPrototype::get_tile_filters()
- LuaPrototypes::get_tile_filtered()
- LuaPrototypes::tile
- LuaRecord::set_tile_filter()
- LuaSurface::get_default_cover_tile()
- LuaTile::prototype
- LuaTilePrototype::allowed_neighbors
- LuaTilePrototype::next_direction
- LuaTilePrototype::default_cover_tile
- LuaTilePrototype::frozen_variant
- LuaTilePrototype::thawed_variant
- LuaTilePrototype::ambient_sounds_group
- LuaTilePrototype::factoriopedia_alternative
- FactoriopediaID
- OldTileAndPosition
- PipetteID
- PlaceAsTileResult
- SpacePlatformTileDefinition
- TileID
- on_player_built_tile
- on_robot_built_tile
- on_space_platform_built_tile