Prototype/Pump: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Converted to SMW format)
Line 1: Line 1:
{{Prototype parent|Prototype/EntityWithHealth}}
{{Prototype parent|Prototype/EntityWithHealth}}
The Pump is used to transfer liquids or gas between tanks, and pipes.


== Basics ==
{{Prototype TOC|pump}}
Prototype type: '''pump'''
 
The Pump is used to transfer liquids or gas between tanks, and pipes.  Based on [[Prototype/EntityWithHealth]].


== Mandatory properties ==
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].


=== fluid_box ===
{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]}}
'''Type''': [[Types/FluidBox]]
 
The area of the entity where fluid inputs and outputs.
The area of the entity where fluid inputs and outputs.


=== energy_source ===
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
'''Type''': [[Types/EnergySource]]
 
The type of energy the pump uses.
The type of energy the pump uses.


=== energy_usage ===
{{Prototype property|energy_usage|[[Types/Energy|Energy]]}}
'''Type''': [[Types/Energy]]
 
The amount of energy the pump uses.
The amount of energy the pump uses.


=== pumping_speed ===
{{Prototype property|pumping_speed|[[Types/double|double]]}}
'''Type''': [[Types/double]]
 
The amount of fluid this pump transfers per tick.
The amount of fluid this pump transfers per tick.


=== animations ===
{{Prototype property|animations|[[Types/Animation4Way|Animation4Way]]}}
'''Type''': [[Types/Animation4Way]]
 
The animation for the pump.
The animation for the pump.


== Optional properties ==
== Optional properties ==


=== fluid_wagon_connector_speed ===
{{Prototype property|fluid_wagon_connector_speed|[[Types/double|double]]|1 / 64.0|optional=true}}
'''Type''': [[Types/double]]
 
'''Default''': 1 / 64.0


=== fluid_wagon_connector_alignment_tolerance ===
{{Prototype property|fluid_wagon_connector_alignment_tolerance|[[Types/double|double]]|2 / 32.0|optional=true}}
'''Type''': [[Types/double]]


'''Default''': 2 / 32.0
{{Prototype property|fluid_wagon_connector_frame_count|[[Types/uint8|uint8]]|1|optional=true}}


=== fluid_wagon_connector_frame_count ===
{{Prototype property|fluid_animation|[[Types/Animation4Way|Animation4Way]]|optional=true}}
'''Type''': [[Types/uint8]]


'''Default''': 1
{{Prototype property|glass_pictures|[[Types/Sprite4Way|Sprite4Way]]|optional=true}}


=== fluid_animation ===
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
'''Type''': [[Types/Animation4Way]]


=== glass_pictures ===
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}
'''Type''': [[Types/Sprite4Way]]


=== circuit_wire_max_distance ===
{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}
'''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]]


{{Prototype property|circuit_wire_connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Mandatory if circuit_wire_max_distance  > 0.
Mandatory if circuit_wire_max_distance  > 0.


=== circuit_connector_sprites ===
{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
'''Type''': [[Types/table]] of [[Types/CircuitConnectorSprites]]
 
Mandatory if circuit_wire_max_distance  > 0.
Mandatory if circuit_wire_max_distance  > 0.


=== fluid_wagon_connector_graphics ===
{{Prototype property|fluid_wagon_connector_graphics|[[Types/table|table]] of [[Types/ConnectorGraphics|ConnectorGraphics]]|optional=true}}
'''Type''': [[Types/table]] of [[Types/ConnectorGraphics]]
Needs <code>load_animations</code> and <code>unload_animations</code> keys, both with a [[Types/ConnectorGraphics|ConnectorGraphics]] as the value.
 
Needs <code>load_animations</code> and <code>unload_animations</code> keys, both with a [[Types/ConnectorGraphics]] as the value.

Revision as of 16:54, 5 August 2019

Template:Prototype parent The Pump is used to transfer liquids or gas between tanks, and pipes.

Template:Prototype TOC

Mandatory properties

This prototype inherits all the properties from Prototype/EntityWithHealth.

Template:Prototype property The area of the entity where fluid inputs and outputs.

Template:Prototype property The type of energy the pump uses.

Template:Prototype property The amount of energy the pump uses.

Template:Prototype property The amount of fluid this pump transfers per tick.

Template:Prototype property The animation for the pump.

Optional properties

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property Mandatory if circuit_wire_max_distance > 0.

Template:Prototype property Mandatory if circuit_wire_max_distance > 0.

Template:Prototype property Needs load_animations and unload_animations keys, both with a ConnectorGraphics as the value.