From Official Factorio Wiki
Jump to navigation Jump to search

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here:

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.

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

An offshore pump.

Prototype/OffshorePump — offshore-pump
adjacent_tile_collision_box::BoundingBox (optional)
adjacent_tile_collision_mask::CollisionMask (optional)
adjacent_tile_collision_test::CollisionMask (optional)
always_draw_fluid::bool (optional)
center_collision_mask::CollisionMask (optional)
check_bounding_box_collides_with_tiles::bool (optional)
circuit_connector_sprites::table of CircuitConnectorSprites (optional)
circuit_wire_connection_points::table of WireConnectionPoint (optional)
circuit_wire_max_distance::double (optional)
draw_circuit_wires::bool (optional)
draw_copper_wires::bool (optional)
fluid_box_tile_collision_test::CollisionMask (optional)
graphics_set::table (optional)
min_perceived_performance::float (optional)
picture::Sprite4Way (optional)
placeable_position_visualization::Sprite (optional)
remove_on_tile_collision::bool (optional)
Inherited from Prototype/EntityWithOwner
allow_run_time_change_of_is_military_target::bool (optional)
is_military_target::bool (optional)
Inherited from Prototype/EntityWithHealth
alert_when_damaged::bool (optional)
attack_reaction::AttackReaction (optional)
corpse::string or table of strings (optional)
create_ghost_on_death::bool (optional)
damaged_trigger_effect::TriggerEffect (optional)
dying_explosion::ExplosionDefinition or table of ExplosionDefinition (optional)
dying_trigger_effect::TriggerEffect (optional)
healing_per_tick::float (optional)
hide_resistances::bool (optional)
integration_patch::Sprite4Way (optional)
integration_patch_render_layer::RenderLayer (optional)
loot::Loot (optional)
max_health::float (optional)
random_corpse_variation::bool (optional)
repair_sound::Sound (optional)
repair_speed_modifier::float (optional)
resistances::Resistances (optional)
Inherited from Prototype/Entity
icons, icon, icon_size (IconSpecification)::IconSpecification
additional_pastable_entities::table of string (optional)
alert_icon_scale::float (optional)
alert_icon_shift::vector (optional)
allow_copy_paste::bool (optional)
autoplace::AutoplaceSpecification (optional)
build_base_evolution_requirement::double (optional)
build_grid_size::uint8 (optional)
build_sound::Sound (optional)
close_sound::Sound (optional)
collision_box::BoundingBox (optional)
collision_mask::CollisionMask (optional)
created_effect::Trigger (optional)
created_smoke::CreateTrivialSmokeEffectItem (optional)
drawing_box::BoundingBox (optional)
emissions_per_second::double (optional)
enemy_map_color::Color (optional)
fast_replaceable_group::string (optional)
flags::EntityPrototypeFlags (optional)
friendly_map_color::Color (optional)
hit_visualization_box::BoundingBox (optional)
map_color::Color (optional)
map_generator_bounding_box::BoundingBox (optional)
minable::MinableProperties (optional)
mined_sound::Sound (optional)
mining_sound::Sound (optional)
next_upgrade::string (optional)
open_sound::Sound (optional)
placeable_by::ItemToPlace or table of ItemToPlace (optional)
protected_from_tile_building::bool (optional)
radius_visualisation_specification::RadiusVisualisationSpecification (optional)
remains_when_mined::string or table of string (optional)
remove_decoratives::string (optional)
rotated_sound::Sound (optional)
selectable_in_game::bool (optional)
selection_box::BoundingBox (optional)
selection_priority::uint8 (optional)
shooting_cursor_size::double (optional)
sticker_box::BoundingBox (optional)
subgroup::string (optional)
tile_height::uint32 (optional)
tile_width::uint32 (optional)
trigger_target_mask::TriggerTargetMask (optional)
vehicle_impact_sound::Sound (optional)
water_reflection::WaterReflectionDefinition (optional)
working_sound::WorkingSound (optional)
Inherited from PrototypeBase
localised_description::LocalisedString (optional)
localised_name::LocalisedString (optional)
order::Order (optional)

Mandatory properties

This prototype inherits all the properties from Prototype/EntityWithOwner.


Type: FluidBox


Type: float
How many units of fluid are produced per tick. Must be > 0.


Type: string
The name of the fluid that is produced by the pump.

Optional properties


Type: table
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.


Type: Sprite4Way
Deprecated, use graphics_set instead. Ignored if graphics_set is defined.


Type: float
Default: 0.25
Animation runs at least this fast.


Type: CollisionMask
Default: "ground-tile"


Type: CollisionMask
Default: "water-tile"
Tiles colliding with adjacent_tile_collision_box must collide with this collision mask (unless it's empty).


Type: CollisionMask
Default: none
Tiles colliding with adjacent_tile_collision_box must NOT collide with this collision mask.


Type: CollisionMask
Default: none
Tile at placement position must NOT collide with this collision mask.


Type: BoundingBox
Default: {{-0.05, -0.8}, {0.05, -0.7}}


Type: Sprite


Type: bool
Default: false


Type: bool
Default: true
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).


Type: bool
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.


Type: double
Default: 0
The maximum circuit wire distance for this entity.


Type: bool
Default: true


Type: bool
Default: true


Type: table of WireConnectionPoint
Mandatory if circuit_wire_max_distance > 0.


Type: table of CircuitConnectorSprites
Mandatory if circuit_wire_max_distance > 0.