Factorio Runtime Docs

Class LuaTilePrototype

Prototype of a tile.

Members

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

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
collision_mask [R] :: CollisionMask

The collision mask this tile uses

The collision mask this tile uses

collision_mask_with_flags [R] :: CollisionMaskWithFlags
layer [R] :: uint
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
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[ItemStackDefinition]?

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.

emissions_per_second [R] :: double

Amount of pollution emissions per second this tile will absorb.

Amount of pollution emissions per second this tile will absorb.

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.

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.

Methods

help()  → string

All methods and properties that this object supports.

Attributes

name :: string Read

Name of this prototype.


order :: string Read

The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.


localised_name :: LocalisedString Read


localised_description :: LocalisedString Read


collision_mask :: CollisionMask Read

The collision mask this tile uses


collision_mask_with_flags :: CollisionMaskWithFlags Read


layer :: uint Read


autoplace_specification :: AutoplaceSpecification? Read

Autoplace specification for this prototype, if any.


walking_speed_modifier :: float Read


vehicle_friction_modifier :: float Read


map_color :: Color Read


decorative_removal_probability :: float Read

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


automatic_neighbors :: boolean Read


allowed_neighbors :: dictionary[string → LuaTilePrototype] Read


needs_correction :: boolean Read

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


mineable_properties :: table Read

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.


next_direction :: LuaTilePrototype? Read

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


items_to_place_this :: array[ItemStackDefinition]? Read

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 :: boolean Read

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


emissions_per_second :: double Read

Amount of pollution emissions per second this tile will absorb.


check_collision_with_entities :: boolean Read

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.


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.

Classes

Events

Concepts

Defines

Builtin types

>|