Official Factorio Wiki - User contributions [en]

Prototype/Entity

2015-11-24T22:06:33Z

Gwynbleidd: /* fast_replacable_group */ fix typo

==Basics==
The common properties of all entities in the game.
Entity is basically everything that can be on the map (except tiles).
For in game script access to entity, take a look at [[Lua/Entity]]
== Extensions ==
*[[Prototype/EntityWithHealth]]
**[[Prototype/Accumulator]]
**[[Prototype/Character]]
**[[Prototype/Unit]]
**[[Prototype/PipeConnectable]]
**[[Prototype/Car]]
**[[Prototype/Market]]
*[[Prototype/Resource]]
*[[Prototype/ItemEntity]]

== Mandatory properties ==
=== type ===
'''Type''': [[Types/string]]

Specification of the [[Prototypes/EntityPrototypeTypes|type]] of the prototype.

=== name ===
'''Type''': [[Types/string]]

Unique identification of the prototype.

=== flags ===
'''Type''': [[Types/EntityPrototypeFlags]]

=== icon ===
'''Type''': [[Types/FileName]]

Mandatory for entities that have at least one of these flags active placeable-neutral, placeable-player, placeable-neutral.

The icon will be used in the editor building selection.
icon = "__base__/graphics/icons/wooden-chest.png"

== Optional properties ==
=== collision_box ===
'''Type''': [[Types/AABBbox]]

'''Default''': Empty={{0, 0}, {0, 0}} it means no collisions.

Specification of the entity collision boundaries.

Empty collision box is used for smoke, projectiles, particles, explosions etc.
collision_box = {{-0.4, -0.4}, {0.4, 0.4}}
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.

Note, that for buildings, it is custom 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. and prevents stucked items on transport belt in some special cases (curves around the corner etc).
=== collision_mask ===
'''type''': [[Types/CollisionMask]]

'''Default''': Depends on Entity type

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

=== selection_box ===
'''Type''': [[Types/AABBbox]]

'''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).
selection_box = {{-0.5, -0.5}, {0.5, 0.5}}
The selection box is usualy little bit bigger than the collision box, for tilable entities (like buildings) it should match the tile size of the building.

=== drawing_box ===
'''Type''': [[Types/AABBbox]]

'''Default''': The value of selection_box

Specification of space needed to see the whole entity.

This is used to calculate the correct zoom and positioning in the entity info gui.
drawing_box = {{-0.5, -0.5}, {0.5, 0.5}}

=== sticker_box ===
'''Type''': [[Types/AABBbox]]

'''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.
It is optional and the collision box is used when not specified.
sticker_box = {{-0.5, -0.5}, {0.5, 0.5}}

=== weight ===
'''Type''': [[Types/float]]

'''Default''': 1

Weight of the entity used for physics calculation when car hits something.
weight = 5.7

=== minable ===
'''Type''': [[Types/MinableProperties]]

=== emissions_per_tick ===
'''Type''': [[Types/double]]

Amount of emissions created (positive number) or cleaned (negative number) every tick by the entity.
This is passive, and it is independent concept of the emissions of machines, these are created actively depending on the power consumption.
Currently used just for trees.
emissions_per_tick = -0.0005 -- cleaning effect of big tree

=== fast_replaceable_group ===
'''Type''': [[Types/string]]

=== tile_width ===
'''Type''': [[Types/unsigned]]

'''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 offgrid [[Types/EntityPrototypeFlags|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.

=== tile_height ===
'''Type''': [[Types/unsigned]]

'''Default''': calculated by the collision box height rounded up.

=== autoplace ===
'''Type''': [[Types/AutoplaceSpecification]]

'''Default''': Entity is not autoplacable

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

autoplace =
{
sharpness = 0.5,
control = "forest",
peaks =
{
{
influence = 0.2,
water_optimal = 0.3,
water_range = 0.2,
water_max_range = 0.4
},
{
influence = 0.9,
noise_layer = "trees",
noise_persistence = 0.5,
}
}
}

== Example ==
{
type = "container",
name = "wooden-chest",
icon = "__base__/graphics/icons/wooden-chest.png",
flags = {"placeable-neutral", "player-creation"},
minable = {mining_time = 1, result = "wooden-chest"},
collision_box = {{-0.4, -0.4}, {0.4, 0.4}},
selection_box = {{-0.5, -0.5}, {0.5, 0.5}},
max_health = 50,
corpse = "small-remnants",
fast_replaceable_group = "container",
inventory_size = 16,
picture =
{
filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",
priority = "extra-high",
width = 46,
height = 33,
shift = {0.3, 0}
}
}

Inserters

2015-11-20T18:48:48Z

Gwynbleidd: /* Inserter speed */ fix inserter speed (from entities.lua)

{{Languages}}
[[File:Mpstark-KVmf6LZ.gif|right]]
'''Inserters''' are devices which are used to move items over short distances. When placed, they have a fixed direction. They can move items from behind and place them in front of them, this way, they can move items from one transport belt to another, but also extract items from and insert items into machines or storage devices. There are five types of inserters, all of them but the Burner Inserter, which requires fuel, using electricity.

'''IMPORTANT NOTE: Many behavioral things described on this page have changes with version 0.12. Be careful, this page is not fully updated yet!

==Mechanics==
Inserters will:
* '''Pick up''' [[Items]] off the [[Ground]], off a [[Transport belts|Transport belt]], or from any object that has storage space for [[Storages/Stack|stacks]] (including [[Storages/Chests|chests]], [[furnace|furnaces]] and [[Assembling machine|assembling machines]])
* '''Place''' the item onto the ground, onto a transport belt, or into any object that has storage space for [[Storages/Stack|stacks]].

Inserters act differently depending on what they are moving items to/into so as not to monopolize all of the items being picked up. This allows other machines and inserters on the same transport belt to pick up a share of the items. If two inserters are picking up from the same tile, the first placed inserter has priority.

==Insertion limits==
Inserters will stop inserting items into certain buildings if they already have enough of that item. For example, if a boiler has 5 or more items of fuel in it, an inserter will not insert additional fuel. When the fuel drops below 5 items, the inserter will continue to insert more fuel, up to the limit of 5 items.

The reason for this behavior is, that otherwise the buffers would get too big; you would have resource problems for things further down the chain/line if the first things where trying to fill the input slot constantly.

{| class="wikitable"
! Entity !! Item type !! Inserter limit !! Comment
|-
| [[Boiler]]s, [[Burner inserter]]s, [[Furnace]]s || [[Fuel]] || align="center" | 5 || Modders should avoid recipes for furnaces with fuel.
|-
| [[Gun turret]]s || [[Magazines]] || align="center" | 10 || Since v0.8.4
|-
| [[Assembling machine]]s || Items needed for the recipe || Double the number of items needed in the recipe ||
|-
| [[Furnace]]s || Items needed for the recipe || Double the number of items needed in the recipe ||
|-
| [[Lab]]s || [[Science pack]]s || Double the number of items needed for one research point ||
|}

An inserter that takes items from an object containing [[Storage/Stack|stacks]] of items (such as a chest) can overfill the target building due to the [[Inserter item stack size]]. Overfilling can also happen if you use multiple inserters to insert items into the building.

==Inserters and transport belts==
[[Transport belts]] have two lanes on which items can travel. Inserters only place items onto one side of the belt. Which side they place it on depends on the orientation of the inserter and the belt, as described below. If you want to rearrange the items once they are on a belt see [[Transport_belts/Belt_lane#Changing_side_of_lane]].

: [[File:Mpstark-5RdLql0.gif|left]]
* Inserters will '''always''' place the item on the furthest lane.
{{clear}}
: [[File:Mpstark-8pfqtMV.gif|left]]
* Inserters '''prefer''' taking items from the <strike>nearest</strike> '''farest''' (since v0.11!) lane. The picture is wrong!
{{clear}}
: [[File:Mpstark-0XL7KBq.gif|left]]
* The behvior of this has changed completely with v0.12: This works now as described in this article: http://www.factorioforums.com/forum/viewtopic.php?f=5&t=16595
<strike>[http://www.factorioforums.com/forum/viewtopic.php?f=5&t=3920 When the direction of the inserter and the belt are the same, the inserter will place items in the '''direction of their rotation''']. By default, this is the top for horizontal belts, or the left for vertical belts. When '''taking''' from a belt, this direction might change.</strike>
{{clear}}
: [[File:Mpstark-UayT5wJ.gif|left]]
{{clear}}
* Inserters can place items on all types of conveyor belts (with v0.12 there is no limitation to splitters anymore; placing in curves will not longer have a chance to [[Transport belts/Blocking items|block]]).
* Inserters try to pick up items from all types of belts (with v0.12 there is no limitation anymore).
* Inserters have problems picking up items
** From fast belts, because the items are moving too quickly. (basic inserters cannot pick up from express belt for example, every try uses energy, burner inserters might not pick up from fast belts)
** From the entry or exit of an underground belt (because the time they have to pick up is shorter)

==Inserter Item Stack Size Bonus==

If an inserter moves items from stack to stack (for example from an assembler into a chest), it is able to transport more items at once. The secret behind this is the [[Inserter item stack size bonus]].

==Power usage==
* The electric driven inserters have a power-drain. This means, they are using energy, even when not moving.
* The energy usage is a fixed amount per movement. This is for all inserters the same.
* The [[Burner inserter]] has no drain, but uses more energy. It is quite useful for jobs, which don't need to move often.
* [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=5253 Inserter Power Efficiency]: Movements per energy and exact power usage numbers. See also [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=6258 this thread], where energy per movement is explained.
* [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=5400 Small Inserter Test]: Comparison if energy usage per item.
* [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=5524 Inserter heartbeats]: In some situations it is not possible to calculate the needed power usage.

==Inserter speed==
{| class="wikitable"
! Type
! Rotation-speed (turns per [[Tick]]) Extension-speed ([[Tile]]s per Tick)
! Turns per [[Game-second]] Tiles per Game-second
! Game-second per full turn Game-seconds per Tile
|- align="center"
| align="left"| {{imagelink|burner-inserter|Burner inserter}} || 0.01 0.02 || 0.6 1.2 || 1.667 0.833
|- align="center"
| align="left"| {{imagelink|basic-inserter|Basic inserter}} || 0.014 0.03 || 0.84 1.8 || 1.191 0.56
|- align="center"
| align="left"| {{imagelink|long-handed-inserter|Long handed inserter}} || 0.02 0.04 || 1.2 2.4 || 0.833 0.416
|- align="center"
| align="left"| {{imagelink|fast-inserter|Fast inserter}} || 0.04 0.07 || 2.4 4.2 || 0.417 0.238
|- align="center"
| align="left"| {{imagelink|smart-inserter|Smart inserter}} || 0.035 0.07 || 2.1 4.2 || 0.476 0.238
|-
|}

===Rotation speed===
Convention: 2π rad = 100% of a circle rotation = '''1 turn''' (or one full rotation).

Note, that an Inserter doesn't always need to make full turns. There are several situations, where you can optimize the angles (and so the speed) of inserters by placing them '''not''' in the symmetry axis!

===Extension speed===
The extension-speed is normally not visible (only when compared to other inserters), but there are measurable speed differences when taking - for example - from the near or the far side of a belt.

This effect is also important for [[Railway network/Train station|Train stations]], when unloading items from wagons, cause the inserters needs to stretch out to the center of a wagon, which is some tiles long and leads to visible slower speed.

The extension speed is especially important for [http://www.factorioforums.com/forum/viewtopic.php?f=8&t=9244 train unloading] (not loading!).

==Movement and energy usage==
The energy usage is not dependend on the amount of rotation or extension, it is depending if the inserter starts an action, which is like grabbing, moving, release and returning. The entry and exit-piece of underground belts is technically only a half belt. Inserters will have problems to grab/place items from there and every try costs energy.

==Types==
{| class="wikitable"
! Type !! Maximum power !! Description
|-
| {{imagelink|burner-inserter|Burner Inserter}} || 180 kW (burner) || Most basic inserter, needs burning fuel.
|-
| {{imagelink|basic-inserter|Inserter}} || 13 kW || Basic electric inserter.
|-
| {{imagelink|long-handed-inserter|Long handed inserter}} || 18 kW || Basic inserter able to grab [[Items]] from 2 tiles distance.
|-
| {{imagelink|fast-inserter|Fast inserter}} || 30 kW || Working at double speed.
|- style="background: #DDEEDD"
| {{imagelink|smart-inserter|Smart inserter}} || 40 kW || Able to connect to [[Circuit network]] and [[Logistic network]], to specify working conditions. Can grab also specified item types only.
|-
|}

==See also==
* [[Electric network]]
* [[Transport network]]

===Special behavior===
* [[Inserters/Interaction with other Entities]]
* [[Inserters/Instead of belt]]: Use it instead of a belt
* [[Inserter item stack size]]: Inserter moves more than an item per turn, works only for transport from stack to stack
* [[Inserters:Focus/Grep-Points]]
* [[Storages/Sorting]] (extended filtering)
* [http://www.factorioforums.com/forum/viewtopic.php?f=6&t=2640 Pick up only, if everything else is full]

{{MachineNav}}

[[Category:Items]]
[[Category:Transport network]]
[[Category:Circuit network]]