Prototype/OffshorePump: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(1.1.51: Prototype/EntityWithOwner added)
(Removed old prototype docs)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Prototype parent|Prototype/EntityWithOwner}}
<div class="stub"><p>'''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 https://lua-api.factorio.com/latest/prototypes/OffshorePumpPrototype.html]
An [[offshore pump]].


{{Prototype TOC|offshore-pump}}
</p><p>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 [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithOwner]].
 
{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]}}
 
{{Prototype property|pumping_speed|[[Types/float|float]]}}
How many units of fluid are produced per tick. Must be > 0.
 
{{Prototype property|fluid|[[Types/string|string]]}}
The name of the fluid that is produced by the pump.
 
== Optional properties ==
 
{{Prototype property|graphics_set|[[Types/table|table]]|optional=true}}
Mandatory if <code>picture</code> is not defined. Table with the following members:
 
* animation - [[Types/Animation4Way|Animation4Way]] - Mandatory. Rendered in "object" layer, with secondary draw order 0.
* base_render_layer - [[Types/RenderLayer|RenderLayer]] - Optional. Default: "ground-patch"
* underwater_layer_offset - [[Types/int8|int8]] - Optional. Default: 1
* fluid_animation - [[Types/Animation4Way|Animation4Way]] - Optional. Rendered in "object" layer, with secondary draw order 20.
* glass_pictures - [[Types/Sprite4Way|Sprite4Way]] - Optional. Rendered in "object" layer, with secondary draw order 40.
* base_pictures - [[Types/Sprite4Way|Sprite4Way]] - Optional. Rendered in layer specified by base_render_layer, with secondary draw order 0.
* underwater_pictures - [[Types/Sprite4Way|Sprite4Way]] - Optional. Drawn by tile renderer when water animation is enabled.
 
{{Prototype property|picture|[[Types/Sprite4Way|Sprite4Way]]|optional=true}}
Deprecated, use <code>graphics_set</code> instead. Ignored if <code>graphics_set</code> is defined.
 
{{Prototype property|min_perceived_performance|[[Types/float|float]]|0.25|optional=true}}
Animation runs at least this fast.
 
{{Prototype property|fluid_box_tile_collision_test|[[Types/CollisionMask|CollisionMask]]|"ground-tile"|optional=true}}
 
{{Prototype property|adjacent_tile_collision_test|[[Types/CollisionMask|CollisionMask]]|"water-tile"|optional=true}}
Tiles colliding with adjacent_tile_collision_box must collide with this collision mask (unless it's empty).
 
{{Prototype property|adjacent_tile_collision_mask|[[Types/CollisionMask|CollisionMask]]|none|optional=true}}
Tiles colliding with adjacent_tile_collision_box must NOT collide with this collision mask.
 
{{Prototype property|center_collision_mask|[[Types/CollisionMask|CollisionMask]]|none|optional=true}}
Tile at placement position must NOT collide with this collision mask.
 
{{Prototype property|adjacent_tile_collision_box|[[Types/BoundingBox|BoundingBox]]|<nowiki>{{-0.05, -0.8}, {0.05, -0.7}}</nowiki>|optional=true}}
 
{{Prototype property|placeable_position_visualization|[[Types/Sprite|Sprite]]|optional=true}}
 
{{Prototype property|remove_on_tile_collision|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|always_draw_fluid|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|check_bounding_box_collides_with_tiles|[[Types/bool|bool]]|optional=true}}
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.
 
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
The maximum circuit wire distance for this entity.
 
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|circuit_wire_connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Mandatory if circuit_wire_max_distance > 0.
 
{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
Mandatory if circuit_wire_max_distance > 0.

Latest revision as of 14:32, 25 October 2024

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.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/OffshorePump&oldid=202952"