Factorio Prototype DocsVersion 1.1.110

This will be used in the electric network statistics, editor building selection, and the bonus gui. Can't be an empty array.

Either this or icon is mandatory for entities that have at least one of these flags active: "placeable-neutral", "placeable-player", "placeable-enemy".

Path to the icon file.

Either this or icons is mandatory for entities that have at least one of these flags active: "placeable-neutral", "placeable-player", "placeable-enemy".

Only loaded if icons is not defined.

The size of the square icon, in pixels. E.g. 32 for a 32px by 32px icon.

Only loaded if icons is not defined, or if icon_size is not specified for all instances of icons.

Default: 0

Icons of reduced size will be used at decreased scale.

Default: Empty = {{0, 0}, {0, 0}}

Specification of the entity collision boundaries. Empty collision box means no collision and is used for smoke, projectiles, particles, explosions etc.

The {0,0} coordinate in the collision box will match the entity position. It should be near the center of the collision box, to keep correct entity drawing order. The bounding box must include the {0,0} coordinate.

Note, that for buildings, it is customary to leave 0.1 wide border between the edge of the tile and the edge of the building, this lets the player move between the building and electric poles/inserters etc.

Default: {"item-layer", "object-layer", "player-layer", "water-tile"}

Two entities can collide only if they share a layer from the collision mask.

Default: The value of collision_box.

Used instead of the collision box during map generation. Allows space entities differently during map generation, for example if the box is bigger, the entities will be placed farther apart.

Default: Empty = {{0, 0}, {0, 0}}

Specification of the entity selection area. When empty the entity will have no selection area (and thus is not selectable).

The selection box is usually a little bit bigger than the collision box. For tileable entities (like buildings) it should match the tile size of the building.

Default: The value of selection_box.

Specification of space needed to see the whole entity in GUIs. This is used to calculate the correct zoom and positioning in the entity info gui, for example in the entity tooltip.

Default: The value of collision_box.

Used to set the area of the entity that can have stickers on it, currently only used for units to specify the area where the green slow down stickers can appear.

Default: Empty = {{0, 0}, {0, 0}}

Where beams should hit the entity. Useful if the bounding box only covers part of the entity (e.g. feet of the character) and beams only hitting there would look weird.

Defaults to the mask from UtilityConstants::default_trigger_target_mask_by_type.

Default: not minable

The item given to the player when they mine the entity and other properties relevant to mining this entity.

The name of the subgroup this entity should be sorted into in the map editor building selection.

Default: true

Default: true

Default: 50

The entity with the higher number is selectable before the entity with the lower number. When two entities have the same selection priority, the one with the highest collision mask (as determined by the order on that page) is selected.

Default: 1

Supported values are 1 (for 1x1 grid) and 2 (for 2x2 grid, like rails).

Internally forced to be 2 for RailPrototype, RailRemnantsPrototype and TrainStopPrototype.

Default: "automatic"

Whether this entity should remove decoratives that collide with it when this entity is built. When set to "automatic", if the entity type is considered a building (e.g. an assembling machine or a wall) it will remove decoratives.

Using boolean values for this property is deprecated, however they have the same meaning as the corresponding strings.

Default: 0

Amount of emissions created (positive number) or cleaned (negative number) every second by the entity. This is passive and currently used just for trees and fires. This is independent of the emissions of energy sources used by machines, which are created actively depending on the power consumption.

The cursor size used when shooting at this entity.

Default: The "smoke-building"-smoke

The smoke that is shown when the entity is placed.

Will also work on entities that don't actually do work.

The effect/trigger that happens when the entity is placed.

When playing this sound, the volume is scaled by the speed of the vehicle when colliding with this entity.

Default: 0

Default: ""

This allows you to replace an entity that's already placed, with a different one in your inventory. For example, replacing a burner inserter with a fast inserter. The replacement entity can be a different rotation to the replaced entity and you can replace an entity with the same type.

This is simply a string, so any string can be used here. The entity that should be replaced simply has to use the same string here.

Name of the entity that will be automatically selected as the upgrade of this entity when using the upgrade planner without configuration.

This entity may not have "not-upgradable" flag set and must be minable. This entity mining result must not contain item product with "hidden" flag set. Mining results with no item products are allowed. This entity may not be a RollingStockPrototype.

The upgrade target entity needs to have the same bounding box, collision mask, and fast replaceable group as this entity. The upgrade target entity must have least 1 item that builds it that isn't hidden.

Default: true

When this is true, this entity prototype should be included during tile collision checks with tiles that have TilePrototype::check_collision_with_entities set to true.

Item that when placed creates this entity. Determines which item is picked when "Q" (smart pipette) is used on this entity. Determines which item and item amount is needed in a blueprint of this entity and to revive a ghost of this entity.

The item count specified here can't be larger than the stack size of that item.

The entity that remains when this one is mined, deconstructed or fast-replaced. The entity wont actually be spawned if it would collide with the entity that is in the process of being mined.

Names of the entity prototypes this entity prototype can be pasted on to in addition to the standard supported types.

This is used to allow copying between types that aren't compatible on the C++ code side, by allowing mods to receive the on_entity_settings_pasted event for the given entity and do the setting pasting via script.

Default: calculated by the collision box width rounded up.

Used to determine how the center of the entity should be positioned when building (unless the off-grid flag is specified).

When the tile width is odd, the center will be in the center of the tile, when it is even, the center is on the tile transition.

Default: calculated by the collision box height rounded up.

Default: nil (entity is not autoplacable)

Used to specify the rules for placing this entity during map generation.

May also be defined inside graphics_set instead of directly in the entity prototype. This is useful for entities that use a graphics_set property to define their graphics, because then all graphics can be defined in one place.

Currently only renders for EntityWithHealthPrototype.

Used to order prototypes in inventory, recipes and GUIs. May not exceed a length of 200 characters.

The order string is taken from the items in placeable_by if they exist, or from an item that has its place_result set to this entity.