Prototype/Inserter: Difference between revisions
(Created page.) |
(Updated styling of prototype doc migration note) |
||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
= | <div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/InserterPrototype.html https://lua-api.factorio.com/latest/prototypes/InserterPrototype.html] | ||
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div> | |||
This | |||
{{Prototype parent|Prototype/EntityWithOwner}} | |||
An [[inserter]]. | |||
{{Prototype TOC|inserter}} | |||
== | == Mandatory properties == | ||
This prototype inherits all the properties from [[Prototype/EntityWithOwner]]. | |||
{{Prototype property|extension_speed|[[Types/double|double]]|}} | |||
{{Prototype property|rotation_speed|[[Types/double|double]]}} | |||
{{Prototype property|insert_position|[[Types/vector|vector]]}} | |||
{{Prototype property|pickup_position|[[Types/vector|vector]]}} | |||
{{Prototype property|platform_picture|[[Types/Sprite4Way|Sprite4Way]]}} | |||
{{Prototype property|hand_base_picture|[[Types/Sprite|Sprite]]}} | |||
{{Prototype property|hand_open_picture|[[Types/Sprite|Sprite]]}} | |||
{{Prototype property|hand_closed_picture|[[Types/Sprite|Sprite]]}} | |||
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}} | |||
Defines how this inserter gets energy. The emissions set on the energy source are ignored so inserters cannot produce pollution. | |||
=== | == Optional properties == | ||
{{Prototype property|energy_per_movement|[[Types/Energy|Energy]]|0|optional=true}} | |||
{{Prototype property|energy_per_rotation|[[Types/Energy|Energy]]|0|optional=true}} | |||
= | {{Prototype property|stack|[[Types/bool|bool]]|false|optional=true}} | ||
Whether this inserter is considered a stack inserter. Relevant for determining how [[Inserter capacity bonus (research)]] applies to the inserter. | |||
{{Prototype property|allow_custom_vectors|[[Types/bool|bool]]|false|optional=true}} | |||
Whether pickup and insert position can be set run-time. | |||
{{Prototype property|allow_burner_leech|[[Types/bool|bool]]|false|optional=true}} | |||
Whether this burner inserter can fuel itself from the fuel inventory of the entity it is picking up items from. | |||
{{Prototype property|draw_held_item|[[Types/bool|bool]]|true|optional=true}} | |||
Whether the item that the inserter is holding should be drawn. | |||
{{Prototype property|use_easter_egg|[[Types/bool|bool]]|true|optional=true}} | |||
Whether the inserter should be able to fish [[raw fish|fish]]. | |||
{{Prototype property|filter_count|[[Types/uint8|uint8]]|0|optional=true}} | |||
How many filters this inserter has. Maximum count of filtered items in inserter is 5. | |||
{{Prototype property|hand_base_shadow|[[Types/Sprite|Sprite]]}} | |||
{{Prototype property|hand_open_shadow|[[Types/Sprite|Sprite]]}} | |||
{{Prototype property|hand_closed_shadow|[[Types/Sprite|Sprite]]}} | |||
{{Prototype property|hand_size|[[Types/double|double]]|0.75|optional=true}} | |||
Used to determine how long the arm of the inserter is when drawing it. Does not affect gameplay. The lower the value, the straighter the arm. Increasing the value will give the inserter a bigger bend due to its longer parts. | |||
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}} | |||
The maximum circuit wire distance for this entity. | |||
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}} | |||
{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}} | |||
{{Prototype property|default_stack_control_input_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}} | |||
{{Prototype property|draw_inserter_arrow|[[Types/bool|bool]]|true|optional=true}} | |||
Whether the yellow arrow that indicates the drop point of the inserter and the line that indicates the pickup position should be drawn. | |||
{{Prototype property|chases_belt_items|[[Types/bool|bool]]|true|optional=true}} | |||
Whether the inserter hand should move to the items it picks up from belts, leading to item chasing behaviour. If this is off, the inserter hand will stay in the center of the belt and any items picked up from the edges of the belt "teleport" to the inserter hand. | |||
{{Prototype property|stack_size_bonus|[[Types/uint8|uint8]]|0|optional=true}} | |||
Stack size bonus that is inherent to the prototype without having to be researched. | |||
{{Prototype property|circuit_wire_connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}} | |||
{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}} | |||
Revision as of 10:43, 21 September 2023
The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/InserterPrototype.html
This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.
Template:Prototype parent An inserter.
Mandatory properties
This prototype inherits all the properties from Prototype/EntityWithOwner.
Template:Prototype property Defines how this inserter gets energy. The emissions set on the energy source are ignored so inserters cannot produce pollution.
Optional properties
Template:Prototype property Whether this inserter is considered a stack inserter. Relevant for determining how Inserter capacity bonus (research) applies to the inserter.
Template:Prototype property Whether pickup and insert position can be set run-time.
Template:Prototype property Whether this burner inserter can fuel itself from the fuel inventory of the entity it is picking up items from.
Template:Prototype property Whether the item that the inserter is holding should be drawn.
Template:Prototype property Whether the inserter should be able to fish fish.
Template:Prototype property How many filters this inserter has. Maximum count of filtered items in inserter is 5.
Template:Prototype property Used to determine how long the arm of the inserter is when drawing it. Does not affect gameplay. The lower the value, the straighter the arm. Increasing the value will give the inserter a bigger bend due to its longer parts.
Template:Prototype property The maximum circuit wire distance for this entity.
Template:Prototype property Whether the yellow arrow that indicates the drop point of the inserter and the line that indicates the pickup position should be drawn.
Template:Prototype property Whether the inserter hand should move to the items it picks up from belts, leading to item chasing behaviour. If this is off, the inserter hand will stay in the center of the belt and any items picked up from the edges of the belt "teleport" to the inserter hand.
Template:Prototype property Stack size bonus that is inherent to the prototype without having to be researched.