Prototype/Pump: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Set prototype parent)
(Removed old prototype docs)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Prototype parent|Prototype/EntityWithHealth}}
<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]


== Basics ==
</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 type: '''pump'''
 
The Pump is used to transfer liquids or gas between tanks, and pipes.  Based on [[Prototype/EntityWithHealth]].
 
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
 
=== fluid_box ===
'''Type''': [[Types/FluidBox]]
 
The area of the entity where fluid inputs and outputs.
 
=== energy_source ===
'''Type''': [[Types/EnergySource]]
 
The type of energy the pump uses.
 
=== energy_usage ===
'''Type''': [[Types/Energy]]
 
The amount of energy the pump uses.
 
=== pumping_speed ===
'''Type''': [[Types/double]]
 
The amount of fluid this pump transfers per tick.
 
=== animations ===
'''Type''': [[Types/Animation4Way]]
 
The animation for the pump.
 
== Optional properties ==
 
=== fluid_wagon_connector_speed ===
'''Type''': [[Types/double]]
 
'''Default''': 1 / 64.0
 
=== fluid_wagon_connector_frame_count ===
'''Type''': [[Types/uint8]]
 
'''Default''': 1
 
=== fluid_animation ===
'''Type''': [[Types/Animation4Way]]
 
=== glass_pictures ===
'''Type''': [[Types/Sprite4Way]]
 
=== circuit_wire_max_distance ===
'''Type''': [[Types/double]]
 
'''Default''': 0
 
=== draw_copper_wires ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== draw_circuit_wires ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== circuit_wire_connection_points ===
'''Type''': [[Types/table]] of [[Types/WireConnectionPoint]]
 
Mandatory if circuit_wire_max_distance  > 0.
 
=== circuit_connector_sprites ===
'''Type''': [[Types/table]] of [[Types/CircuitConnectorSprites]]
 
Mandatory if circuit_wire_max_distance  > 0.
 
=== fluid_wagon_connector_graphics ===
'''Type''': [[Types/table]] of [[Types/ConnectorGraphics]]
 
Needs <code>load_animations</code> and <code>unload_animations</code> keys, both with a [[Types/ConnectorGraphics]] 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.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/Pump&oldid=202964"