Prototype/Pump

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/EntityWithHealth » Prototype/EntityWithOwner » Prototype/Pump

Basics

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_alignment_tolerance

Type: Types/double

Default: 2 / 32.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 load_animations and unload_animations keys, both with a Types/ConnectorGraphics as the value.