Prototype/Pump: Difference between revisions
m (→Properties: removed double property) |
(0.16) |
||
| Line 1: | Line 1: | ||
==Basics== | == Basics == | ||
The Pump is used to transfer liquids or gas between tanks, and pipes. | The Pump is used to transfer liquids or gas between tanks, and pipes. Based on [[Prototype/EntityWithHealth]]. | ||
== | |||
===energy_source=== | == 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]] | '''Type''': [[Types/EnergySource]] | ||
The type of energy the pump uses. | The type of energy the pump uses. Must be an electric energy source. | ||
===energy_usage=== | === energy_usage === | ||
'''Type''': [[Types/ | '''Type''': [[Types/Energy]] | ||
The amount of energy the pump uses. | The amount of energy the pump uses. | ||
===pumping_speed=== | === pumping_speed === | ||
'''Type''': [[Types/ | '''Type''': [[Types/double]] | ||
The amount of fluid | The amount of fluid this pump transfers per tick. | ||
===animations=== | === animations === | ||
'''Type''': [[Types/ | '''Type''': [[Types/Animation4Way]] | ||
The animation for the pump. | The animation for the pump. | ||
=== | == Optional properties == | ||
'''Type''': [[Types/ | |||
=== 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 | |||
=== 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. | |||
Revision as of 18:03, 21 May 2018
Basics
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. Must be an electric energy source.
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
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 load_animations and unload_animations keys, both with a Types/ConnectorGraphics as the value.