Prototype/OffshorePump

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

Template:Prototype parent An offshore pump.

Mandatory properties

This prototype inherits all the properties from Prototype/EntityWithOwner.

Template:Prototype property How many units of fluid are produced per tick. Must be > 0.

Template:Prototype property The name of the fluid that is produced by the pump.

Optional properties

Template:Prototype property Mandatory if picture is not defined. Table with the following members:

• animation - Animation4Way - Mandatory. Rendered in "object" layer, with secondary draw order 0.
• base_render_layer - RenderLayer - Optional. Default: "ground-patch"
• underwater_layer_offset - int8 - Optional. Default: 1
• fluid_animation - Animation4Way - Optional. Rendered in "object" layer, with secondary draw order 20.
• glass_pictures - Sprite4Way - Optional. Rendered in "object" layer, with secondary draw order 40.
• base_pictures - Sprite4Way - Optional. Rendered in layer specified by base_render_layer, with secondary draw order 0.
• underwater_pictures - Sprite4Way - Optional. Drawn by tile renderer when water animation is enabled.

Template:Prototype property Deprecated, use graphics_set instead. Ignored if graphics_set is defined.

Template:Prototype property Animation runs at least this fast.

Template:Prototype property Tiles colliding with adjacent_tile_collision_box must collide with this collision mask (unless it's empty).

Template:Prototype property Tiles colliding with adjacent_tile_collision_box must NOT collide with this collision mask.

Template:Prototype property Tile at placement position must NOT collide with this collision mask.

Template:Prototype property If false, the offshore pump will not show fluid present (visually) before there is an output connected. The pump will also animate yet not show fluid when the fluid is 100% extracted (e.g. such as with a pump).

Template:Prototype property If not set (=default), the offshore pump does not collide with tiles if it has none of these collision masks: "water-tile", "ground-tile", "resource-layer", "player-layer", "item-layer", "doodad-layer". If it has at least one of the six collision masks, it does collide with tiles. If set, this specifies whether collision with tiles should (true) or should not (false) be performed on an offshore pump.

Template:Prototype property The maximum circuit wire distance for this entity.

Template:Prototype property Mandatory if circuit_wire_max_distance > 0.

Template:Prototype property Mandatory if circuit_wire_max_distance > 0.