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

# Factorio Prototype Docs Version 2.0.77

# TilePrototype - Prototype Docs

## TilePrototype 'tile'

A tile.

Prototype limited to 65535 total instances.

Inherits from Prototype « PrototypeBase

## Properties

- default
- sorted

collision_mask | :: CollisionMaskConnector |
layer | :: uint8 | Specifies transition drawing priority. [...]
Specifies transition drawing priority. [...]
layer_group optional | :: TileRenderLayer | The base group of render layers this tile belongs to. [...]
The base group of render layers this tile belongs to. [...]
build_animations optional | :: Animation4Way | The build animation used when this tile is built on a space platform.
The build animation used when this tile is built on a space platform.
build_animations_background optional | :: Animation4Way |
built_animation_frame optional | :: uint32 | When the build_animations frame reaches this point the tile is built. [...]
When the build_animations frame reaches this point the tile is built. [...]
variants | :: TileTransitionsVariants | Graphics for this tile.
Graphics for this tile.
map_color | :: Color |
icons optional | :: array[IconData] | Can't be an empty array. [...]
Can't be an empty array. [...]
icon optional | :: FileName | Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional | :: SpriteSizeType | The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
lowland_fog optional | :: boolean | For surfaces that use fog effect of type `gleba`, this property determines whether given tile should contribute to fog intensity on a chunk or not.
For surfaces that use fog effect of type `gleba`, this property determines whether given tile should contribute to fog intensity on a chunk or not.
transition_overlay_layer_offset optional | :: int8 |
sprite_usage_surface optional | :: SpriteUsageSurfaceHint |
transition_merges_with_tile optional | :: TileID |
effect_color optional | :: Color |
tint optional | :: Color |
particle_tints optional | :: TileBasedParticleTints |
walking_sound optional | :: Sound |
landing_steps_sound optional | :: Sound |
driving_sound optional | :: InterruptibleSound |
build_sound optional | :: Sound or TileBuildSound | If this is loaded as one Sound, it is loaded as the "small" build sound.
If this is loaded as one Sound, it is loaded as the "small" build sound.
mined_sound optional | :: Sound |
walking_speed_modifier optional | :: double |
vehicle_friction_modifier optional | :: double |
decorative_removal_probability optional | :: float |
allowed_neighbors optional | :: array[TileID] | Array of tile names that are allowed next to this one.
Array of tile names that are allowed next to this one.
needs_correction optional | :: boolean | Whether the tile needs tile correction logic applied when it's generated in the world, to prevent graphical artifacts. [...]
Whether the tile needs tile correction logic applied when it's generated in the world, to prevent graphical artifacts. [...]
minable optional | :: MinableProperties | If you want the tile to not be mineable, don't specify the minable property. [...]
If you want the tile to not be mineable, don't specify the minable property. [...]
fluid optional | :: FluidID |
next_direction optional | :: TileID |
can_be_part_of_blueprint optional | :: boolean |
is_foundation optional | :: boolean |
destroys_dropped_items optional | :: boolean | If items dropped on this tile are destroyed.
If items dropped on this tile are destroyed.
allows_being_covered optional | :: boolean |
searchable optional | :: boolean |
max_health optional | :: float | Must be equal to or greater than 0.
Must be equal to or greater than 0.
weight optional | :: Weight |
dying_explosion optional | :: ExplosionDefinition or array[ExplosionDefinition] | Triggers when a foundation tile is destroyed by an asteroid.
Triggers when a foundation tile is destroyed by an asteroid.
absorptions_per_second optional | :: dictionary[AirbornePollutantID → double] |
default_cover_tile optional | :: TileID |
frozen_variant optional | :: TileID |
thawed_variant optional | :: TileID |
effect optional | :: TileEffectDefinitionID |
trigger_effect optional | :: TriggerEffect | Called by InvokeTileEffectTriggerEffectItem.
Called by InvokeTileEffectTriggerEffectItem.
default_destroyed_dropped_item_trigger optional | :: Trigger | The effect/trigger that runs when an item is destroyed by being dropped on this tile. [...]
The effect/trigger that runs when an item is destroyed by being dropped on this tile. [...]
scorch_mark_color optional | :: Color |
check_collision_with_entities optional | :: boolean | If set to true, the game will check for collisions with entities before building or mining the tile. [...]
If set to true, the game will check for collisions with entities before building or mining the tile. [...]
effect_color_secondary optional | :: Color | Used by the pollution shader.
Used by the pollution shader.
effect_is_opaque optional | :: boolean |
transitions optional | :: array[TileTransitionsToTiles] | Extra transitions.
Extra transitions.
transitions_between_transitions optional | :: array[TileTransitionsBetweenTransitions] |
autoplace optional | :: AutoplaceSpecification |
placeable_by optional | :: ItemToPlace or array[ItemToPlace] |
bound_decoratives optional | :: DecorativeID or array[DecorativeID] |
ambient_sounds_group optional | :: TileID |
ambient_sounds optional | :: WorldAmbientSoundDefinition or array[WorldAmbientSoundDefinition] |

Inherited from Prototype

factoriopedia_alternative optional | :: string | The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]
custom_tooltip_fields optional | :: array[CustomTooltipField] | Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.

Inherited from PrototypeBase

type | :: string | Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name | :: string | Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional | :: Order | Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional | :: LocalisedString | Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional | :: LocalisedString | Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
factoriopedia_description optional | :: LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroup optional | :: ItemSubGroupID | The name of an ItemSubGroup.
The name of an ItemSubGroup.
hidden optional | :: boolean |
hidden_in_factoriopedia optional | :: boolean |
parameter optional | :: boolean | Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
factoriopedia_simulation optional | :: SimulationDefinition | The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.

collision_mask | :: CollisionMaskConnector |
layer | :: uint8 | Specifies transition drawing priority. [...]
Specifies transition drawing priority. [...]
map_color | :: Color |
variants | :: TileTransitionsVariants | Graphics for this tile.
Graphics for this tile.
absorptions_per_second optional | :: dictionary[AirbornePollutantID → double] |
allowed_neighbors optional | :: array[TileID] | Array of tile names that are allowed next to this one.
Array of tile names that are allowed next to this one.
allows_being_covered optional | :: boolean |
ambient_sounds optional | :: WorldAmbientSoundDefinition or array[WorldAmbientSoundDefinition] |
ambient_sounds_group optional | :: TileID |
autoplace optional | :: AutoplaceSpecification |
bound_decoratives optional | :: DecorativeID or array[DecorativeID] |
build_animations optional | :: Animation4Way | The build animation used when this tile is built on a space platform.
The build animation used when this tile is built on a space platform.
build_animations_background optional | :: Animation4Way |
build_sound optional | :: Sound or TileBuildSound | If this is loaded as one Sound, it is loaded as the "small" build sound.
If this is loaded as one Sound, it is loaded as the "small" build sound.
built_animation_frame optional | :: uint32 | When the build_animations frame reaches this point the tile is built. [...]
When the build_animations frame reaches this point the tile is built. [...]
can_be_part_of_blueprint optional | :: boolean |
check_collision_with_entities optional | :: boolean | If set to true, the game will check for collisions with entities before building or mining the tile. [...]
If set to true, the game will check for collisions with entities before building or mining the tile. [...]
decorative_removal_probability optional | :: float |
default_cover_tile optional | :: TileID |
default_destroyed_dropped_item_trigger optional | :: Trigger | The effect/trigger that runs when an item is destroyed by being dropped on this tile. [...]
The effect/trigger that runs when an item is destroyed by being dropped on this tile. [...]
destroys_dropped_items optional | :: boolean | If items dropped on this tile are destroyed.
If items dropped on this tile are destroyed.
driving_sound optional | :: InterruptibleSound |
dying_explosion optional | :: ExplosionDefinition or array[ExplosionDefinition] | Triggers when a foundation tile is destroyed by an asteroid.
Triggers when a foundation tile is destroyed by an asteroid.
effect optional | :: TileEffectDefinitionID |
effect_color optional | :: Color |
effect_color_secondary optional | :: Color | Used by the pollution shader.
Used by the pollution shader.
effect_is_opaque optional | :: boolean |
fluid optional | :: FluidID |
frozen_variant optional | :: TileID |
icon optional | :: FileName | Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional | :: SpriteSizeType | The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
icons optional | :: array[IconData] | Can't be an empty array. [...]
Can't be an empty array. [...]
is_foundation optional | :: boolean |
landing_steps_sound optional | :: Sound |
layer_group optional | :: TileRenderLayer | The base group of render layers this tile belongs to. [...]
The base group of render layers this tile belongs to. [...]
lowland_fog optional | :: boolean | For surfaces that use fog effect of type `gleba`, this property determines whether given tile should contribute to fog intensity on a chunk or not.
For surfaces that use fog effect of type `gleba`, this property determines whether given tile should contribute to fog intensity on a chunk or not.
max_health optional | :: float | Must be equal to or greater than 0.
Must be equal to or greater than 0.
minable optional | :: MinableProperties | If you want the tile to not be mineable, don't specify the minable property. [...]
If you want the tile to not be mineable, don't specify the minable property. [...]
mined_sound optional | :: Sound |
needs_correction optional | :: boolean | Whether the tile needs tile correction logic applied when it's generated in the world, to prevent graphical artifacts. [...]
Whether the tile needs tile correction logic applied when it's generated in the world, to prevent graphical artifacts. [...]
next_direction optional | :: TileID |
particle_tints optional | :: TileBasedParticleTints |
placeable_by optional | :: ItemToPlace or array[ItemToPlace] |
scorch_mark_color optional | :: Color |
searchable optional | :: boolean |
sprite_usage_surface optional | :: SpriteUsageSurfaceHint |
thawed_variant optional | :: TileID |
tint optional | :: Color |
transition_merges_with_tile optional | :: TileID |
transition_overlay_layer_offset optional | :: int8 |
transitions optional | :: array[TileTransitionsToTiles] | Extra transitions.
Extra transitions.
transitions_between_transitions optional | :: array[TileTransitionsBetweenTransitions] |
trigger_effect optional | :: TriggerEffect | Called by InvokeTileEffectTriggerEffectItem.
Called by InvokeTileEffectTriggerEffectItem.
vehicle_friction_modifier optional | :: double |
walking_sound optional | :: Sound |
walking_speed_modifier optional | :: double |
weight optional | :: Weight |

Inherited from Prototype

custom_tooltip_fields optional | :: array[CustomTooltipField] | Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.
factoriopedia_alternative optional | :: string | The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]

Inherited from PrototypeBase

name | :: string | Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
type | :: string | Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
factoriopedia_description optional | :: LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
factoriopedia_simulation optional | :: SimulationDefinition | The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.
hidden optional | :: boolean |
hidden_in_factoriopedia optional | :: boolean |
localised_description optional | :: LocalisedString | Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
localised_name optional | :: LocalisedString | Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
order optional | :: Order | Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
parameter optional | :: boolean | Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
subgroup optional | :: ItemSubGroupID | The name of an ItemSubGroup.
The name of an ItemSubGroup.

## Properties

### collision_mask :: CollisionMaskConnector

### layer :: uint8

Specifies transition drawing priority. This represents the positive offset from this tile's `layer_group`. Internally, the final layer is computed as `layer_group + layer` (a uint16), wrapping back to `"zero"` after the `"top"` layer.

### layer_group :: TileRenderLayer optional

Default: `"ground-natural"`

The base group of render layers this tile belongs to. It can be moved up inside this group using the `layer` property. See the TileRenderLayer page to see the sizes of all layer groups.

### build_animations :: Animation4Way optional

The build animation used when this tile is built on a space platform.

### build_animations_background :: Animation4Way optional

### built_animation_frame :: uint32 optional

When the build_animations frame reaches this point the tile is built.

Mandatory if `build_animations` is defined.

### variants :: TileTransitionsVariants

Graphics for this tile.

### map_color :: Color

### icons :: array[IconData] optional

Can't be an empty array. If this and `icon` is not set, the `material_background` in `variants` is used as the icon.

### icon :: FileName optional

Path to the icon file. If this and `icons` is not set, the `material_background` in `variants` is used as the icon.

Only loaded if `icons` is not defined.

### icon_size :: SpriteSizeType optional

Default: `64`

The size of the square icon, in pixels. E.g. `32` for a 32px by 32px icon. Must be larger than `0`.

Only loaded if `icons` is not defined.

### lowland_fog :: boolean optional

Default: `false`

For surfaces that use fog effect of type `gleba`, this property determines whether given tile should contribute to fog intensity on a chunk or not.

### transition_overlay_layer_offset :: int8 optional

Default: `0`

### sprite_usage_surface :: SpriteUsageSurfaceHint optional

Default: `"any"`

### transition_merges_with_tile :: TileID optional

### effect_color :: Color optional

Default: `{r=1, g=1, b=1, a=1} (white)`

### tint :: Color optional

Default: `{r=1, g=1, b=1, a=1} (white)`

### particle_tints :: TileBasedParticleTints optional

### walking_sound :: Sound optional

### landing_steps_sound :: Sound optional

### driving_sound :: InterruptibleSound optional

### build_sound :: Sound or TileBuildSound optional

If this is loaded as one Sound, it is loaded as the "small" build sound.

#### TileBuildSound :: struct

## Properties

### small :: Sound optional

### medium :: Sound optional

### large :: Sound optional

### animated :: Sound optional

### mined_sound :: Sound optional

### walking_speed_modifier :: double optional

Default: `1`

### vehicle_friction_modifier :: double optional

Default: `1`

### decorative_removal_probability :: float optional

Default: `0.0`

### allowed_neighbors :: array[TileID] optional

Default: All tiles

Array of tile names that are allowed next to this one.

### needs_correction :: boolean optional

Default: `false`

Whether the tile needs tile correction logic applied when it's generated in the world, to prevent graphical artifacts. The tile correction logic disallows 1-wide stripes of the tile, see Friday Facts #346.

### minable :: MinableProperties optional

If you want the tile to not be mineable, don't specify the minable property. Only non-mineable tiles become hidden tiles when placing mineable tiles on top of them.

### fluid :: FluidID optional

### next_direction :: TileID optional

### can_be_part_of_blueprint :: boolean optional

Default: `true`

### is_foundation :: boolean optional

Default: `false`

### destroys_dropped_items :: boolean optional

Default: `false`

If items dropped on this tile are destroyed.

### allows_being_covered :: boolean optional

Default: `true`

### searchable :: boolean optional

Default: `false`

### max_health :: float optional

Default: `0`

Must be equal to or greater than 0.

### weight :: Weight optional

Default: `0`

### dying_explosion :: ExplosionDefinition or array[ExplosionDefinition] optional

Triggers when a foundation tile is destroyed by an asteroid.

### absorptions_per_second :: dictionary[AirbornePollutantID → double] optional

### default_cover_tile :: TileID optional

### frozen_variant :: TileID optional

### thawed_variant :: TileID optional

### effect :: TileEffectDefinitionID optional

### trigger_effect :: TriggerEffect optional

Called by InvokeTileEffectTriggerEffectItem.

### default_destroyed_dropped_item_trigger :: Trigger optional

The effect/trigger that runs when an item is destroyed by being dropped on this tile.

If the item defines its own trigger it will override this.

If this is defined, `destroys_dropped_items` must be `true`.

### scorch_mark_color :: Color optional

### check_collision_with_entities :: boolean optional

Default: `true`

If set to true, the game will check for collisions with entities before building or mining the tile. If entities are in the way it is not possible to mine/build the tile.

### effect_color_secondary :: Color optional

Used by the pollution shader.

### effect_is_opaque :: boolean optional

Default: true if `effect_color` alpha equals 1

### transitions :: array[TileTransitionsToTiles] optional

Extra transitions.

### transitions_between_transitions :: array[TileTransitionsBetweenTransitions] optional

### autoplace :: AutoplaceSpecification optional

### placeable_by :: ItemToPlace or array[ItemToPlace] optional

### bound_decoratives :: DecorativeID or array[DecorativeID] optional

### ambient_sounds_group :: TileID optional

### ambient_sounds :: WorldAmbientSoundDefinition or array[WorldAmbientSoundDefinition] optional