Prototype/Pump: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (Protected "Prototype/Pump": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
(Removed old prototype docs)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
'''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/PumpPrototype.html https://lua-api.factorio.com/latest/prototypes/PumpPrototype.html]
<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/PumpPrototype.html https://lua-api.factorio.com/latest/prototypes/PumpPrototype.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 [https://forums.factorio.com/viewforum.php?f=233 on the forums].
</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>
 
 
 
{{Prototype parent|Prototype/EntityWithOwner}}
The Pump is used to transfer liquids or gas between tanks, and pipes.
 
{{Prototype TOC|pump}}
 
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithOwner]].
 
{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]}}
The area of the entity where fluid inputs and outputs.
 
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
The type of energy the pump uses.
 
{{Prototype property|energy_usage|[[Types/Energy|Energy]]}}
The amount of energy the pump uses.
 
{{Prototype property|pumping_speed|[[Types/double|double]]}}
The amount of fluid this pump transfers per tick.
 
{{Prototype property|animations|[[Types/Animation4Way|Animation4Way]]}}
The animation for the pump.
 
== Optional properties ==
 
{{Prototype property|fluid_wagon_connector_speed|[[Types/double|double]]|1 / 64.0|optional=true}}
 
{{Prototype property|fluid_wagon_connector_alignment_tolerance|[[Types/double|double]]|2 / 32.0|optional=true}}
 
{{Prototype property|fluid_wagon_connector_frame_count|[[Types/uint8|uint8]]|1|optional=true}}
 
{{Prototype property|fluid_animation|[[Types/Animation4Way|Animation4Way]]|optional=true}}
 
{{Prototype property|glass_pictures|[[Types/Sprite4Way|Sprite4Way]]|optional=true}}
 
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
 
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|circuit_wire_connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Mandatory if circuit_wire_max_distance  > 0.
 
{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
Mandatory if circuit_wire_max_distance  > 0.
 
{{Prototype property|fluid_wagon_connector_graphics|[[Types/table|table]] of [[Types/PumpConnectorGraphics|PumpConnectorGraphics]]|optional=true}}
Needs <code>load_animations</code> and <code>unload_animations</code> keys, both with a [[Types/PumpConnectorGraphics|PumpConnectorGraphics]] as the value.

Latest revision as of 14:32, 25 October 2024

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/PumpPrototype.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.