Prototype/OffshorePump - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:57Z

Removed old prototype docs

← Older revision		Revision as of 14:32, 25 October 2024
Line 2:		Line 2:

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



	~~{{Prototype parent\|Prototype/EntityWithOwner}}~~
	~~An [[offshore pump]].~~

	~~{{Prototype TOC\|offshore-pump}}~~

	~~== 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}}~~
	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]]).

	~~{{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.~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:18Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:43, 21 September 2023
Line 1:		Line 1:
	'''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]		<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]

	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><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>

BilkaBot: Protected "Prototype/OffshorePump": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:53Z

Protected "Prototype/OffshorePump": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:52, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:52:52Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:52, 16 August 2023
Line 1:		Line 1:
			'''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]

			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].



	{{Prototype parent\|Prototype/EntityWithOwner}}		{{Prototype parent\|Prototype/EntityWithOwner}}
	An [[offshore pump]].		An [[offshore pump]].

Honktown: always_draw_fluid detail

2022-03-04T21:11:55Z

always_draw_fluid detail

← Older revision		Revision as of 21:11, 4 March 2022
Line 52:		Line 52:

	{{Prototype property\|always_draw_fluid\|[[Types/bool\|bool]]\|true\|optional=true}}		{{Prototype property\|always_draw_fluid\|[[Types/bool\|bool]]\|true\|optional=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]]).

	{{Prototype property\|check_bounding_box_collides_with_tiles\|[[Types/bool\|bool]]\|optional=true}}		{{Prototype property\|check_bounding_box_collides_with_tiles\|[[Types/bool\|bool]]\|optional=true}}

Bilka: 1.1.51: Prototype/EntityWithOwner added

2022-01-21T19:27:20Z

1.1.51: Prototype/EntityWithOwner added

← Older revision		Revision as of 19:27, 21 January 2022
Line 1:		Line 1:
	{{Prototype parent\|Prototype/~~EntityWithHealth~~}}		{{Prototype parent\|Prototype/EntityWithOwner}}
	An [[offshore pump]].		An [[offshore pump]].

Line 5:		Line 5:

	== Mandatory properties ==		== Mandatory properties ==
	This prototype inherits all the properties from [[Prototype/~~EntityWithHealth~~]].		This prototype inherits all the properties from [[Prototype/EntityWithOwner]].

	{{Prototype property\|fluid_box\|[[Types/FluidBox\|FluidBox]]}}		{{Prototype property\|fluid_box\|[[Types/FluidBox\|FluidBox]]}}

Bilka: 1.1.42: check_bounding_box_collides_with_tiles added

2021-11-24T12:35:13Z

1.1.42: check_bounding_box_collides_with_tiles added

← Older revision		Revision as of 12:35, 24 November 2021
Line 52:		Line 52:

	{{Prototype property\|always_draw_fluid\|[[Types/bool\|bool]]\|true\|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}}		{{Prototype property\|circuit_wire_max_distance\|[[Types/double\|double]]\|0\|optional=true}}

Bilka: fixed that remove_on_tile_collision was duplicated

2021-08-19T11:36:19Z

fixed that remove_on_tile_collision was duplicated

← Older revision		Revision as of 11:36, 19 August 2021
Line 59:		Line 59:

	{{Prototype property\|draw_circuit_wires\|[[Types/bool\|bool]]\|true\|optional=true}}		{{Prototype property\|draw_circuit_wires\|[[Types/bool\|bool]]\|true\|optional=true}}

	~~{{Prototype property\|remove_on_tile_collision\|[[Types/bool\|bool]]\|false\|optional=true}}~~

	{{Prototype property\|circuit_wire_connection_points\|[[Types/table\|table]] of [[Types/WireConnectionPoint\|WireConnectionPoint]]\|optional=true}}		{{Prototype property\|circuit_wire_connection_points\|[[Types/table\|table]] of [[Types/WireConnectionPoint\|WireConnectionPoint]]\|optional=true}}

Posila at 15:34, 3 March 2020

2020-03-03T15:34:42Z

← Older revision		Revision as of 15:34, 3 March 2020
Line 37:		Line 37:

	{{Prototype property\|adjacent_tile_collision_test\|[[Types/CollisionMask\|CollisionMask]]\|"water-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 ~~its~~ empty).		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}}		{{Prototype property\|adjacent_tile_collision_mask\|[[Types/CollisionMask\|CollisionMask]]\|none\|optional=true}}

Posila at 15:34, 3 March 2020

2020-03-03T15:34:04Z

← Older revision		Revision as of 14:32, 25 October 2024
Line 2:		Line 2:

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



	~~{{Prototype parent\|Prototype/EntityWithOwner}}~~
	~~An [[offshore pump]].~~

	~~{{Prototype TOC\|offshore-pump}}~~

	~~== 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}}~~
	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]]).

	~~{{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.~~

← Older revision		Revision as of 11:36, 19 August 2021
Line 59:		Line 59:

	{{Prototype property\|draw_circuit_wires\|[[Types/bool\|bool]]\|true\|optional=true}}		{{Prototype property\|draw_circuit_wires\|[[Types/bool\|bool]]\|true\|optional=true}}

	~~{{Prototype property\|remove_on_tile_collision\|[[Types/bool\|bool]]\|false\|optional=true}}~~

	{{Prototype property\|circuit_wire_connection_points\|[[Types/table\|table]] of [[Types/WireConnectionPoint\|WireConnectionPoint]]\|optional=true}}		{{Prototype property\|circuit_wire_connection_points\|[[Types/table\|table]] of [[Types/WireConnectionPoint\|WireConnectionPoint]]\|optional=true}}

← Older revision		Revision as of 15:34, 3 March 2020
Line 20:		Line 20:
	Mandatory if <code>picture</code> is not defined. Table with the following members:		Mandatory if <code>picture</code> is not defined. Table with the following members:

	* animation - [[Types/Animation4Way\|Animation4Way]] - Mandatory.		* animation - [[Types/Animation4Way\|Animation4Way]] - Mandatory. Rendered in "object" layer, with secondary draw order 0.
	* base_render_layer - [[Types/RenderLayer\|RenderLayer]] - Optional. Default: "ground-patch"		* base_render_layer - [[Types/RenderLayer\|RenderLayer]] - Optional. Default: "ground-patch"
	* underwater_layer_offset - [[Types/int8\|int8]] - Optional. Default: 1		* underwater_layer_offset - [[Types/int8\|int8]] - Optional. Default: 1
	* fluid_animation - [[Types/Animation4Way\|Animation4Way]] - Optional.		* fluid_animation - [[Types/Animation4Way\|Animation4Way]] - Optional. Rendered in "object" layer, with secondary draw order 20.
	* glass_pictures - [[Types/Sprite4Way\|Sprite4Way]] - Optional.		* glass_pictures - [[Types/Sprite4Way\|Sprite4Way]] - Optional. Rendered in "object" layer, with secondary draw order 40.
	* base_pictures - [[Types/Sprite4Way\|Sprite4Way]] - Optional.		* 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.		* underwater_pictures - [[Types/Sprite4Way\|Sprite4Way]] - Optional. Drawn by tile renderer when water animation is enabled.

	{{Prototype property\|picture\|[[Types/Sprite4Way\|Sprite4Way]]\|optional=true}}		{{Prototype property\|picture\|[[Types/Sprite4Way\|Sprite4Way]]\|optional=true}}
	Deprecated, use <code>graphics_set</code> instead. ~~Mandatory~~ if <code>graphics_set</code> is ~~not~~ defined.		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}}		{{Prototype property\|min_perceived_performance\|[[Types/float\|float]]\|0.25\|optional=true}}
Line 37:		Line 37:

	{{Prototype property\|adjacent_tile_collision_test\|[[Types/CollisionMask\|CollisionMask]]\|"water-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 its empty).

	{{Prototype property\|adjacent_tile_collision_mask\|[[Types/CollisionMask\|CollisionMask]]\|none\|optional=true}}		{{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}}		{{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, -0.75}</nowiki>\|optional=true}}		{{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\|placeable_position_visualization\|[[Types/Sprite\|Sprite]]\|optional=true}}