Types/FluidBox - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:23Z

Removed old prototype docs

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:28Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:42, 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/types/FluidBox.html https://lua-api.factorio.com/latest/types/FluidBox.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/types/FluidBox.html https://lua-api.factorio.com/latest/types/FluidBox.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 "Types/FluidBox": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:51:36Z

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

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

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:51:36Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:51, 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/types/FluidBox.html https://lua-api.factorio.com/latest/types/FluidBox.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].



	== Basics ==		== Basics ==
	[[File:Fluidboxes.png\|thumb\|550px\|Visual representation of base_area, base_level and height. When all the fluidboxes are connected, the water leaves fluidbox A and flows into the other 3 boxes through fluidbox B until the water level is equal in all boxes. For more info about fluids, see [[Fluid system#See also]].]]		[[File:Fluidboxes.png\|thumb\|550px\|Visual representation of base_area, base_level and height. When all the fluidboxes are connected, the water leaves fluidbox A and flows into the other 3 boxes through fluidbox B until the water level is equal in all boxes. For more info about fluids, see [[Fluid system#See also]].]]

Braxbro: Mentioning the unmentioned overlapping connection point check

2023-05-14T14:36:47Z

Mentioning the unmentioned overlapping connection point check

← Older revision		Revision as of 14:36, 14 May 2023
Line 17:		Line 17:
	Fluid may flow in or out depending on the `type` field of each connection.		Fluid may flow in or out depending on the `type` field of each connection.
	Connection points may depend on the direction the entity is facing.		Connection points may depend on the direction the entity is facing.

			These connection points cannot share positions with one another or the connection points of another fluid box belonging to the same entity.

	== Optional properties ==		== Optional properties ==

Bilka: /* base_level */ formatting

2023-01-16T10:54:50Z

base_level: formatting

← Older revision		Revision as of 10:54, 16 January 2023
Line 32:		Line 32:
	'''Default''': 0		'''Default''': 0

	Base level is the elevation of the invisible fluid box.		Base level is the elevation of the invisible fluid box. 0 is ground level.
	0 is ground level.

	~~-1 puts the '''top''' of the fluid box at the '''bottom''' of a pipe connection, so, fluid "falls" in to it, and can't get out~~.

	1 puts the '''bottom~~'''~~ of the fluid box at the ~~'''~~top~~'''~~ of a pipe connection, so fluid "falls" out of it, but fluids already outside cannot get into it.		-1 puts the top of the fluid box at the bottom of a pipe connection (base_level 0, height 1), so fluid "falls" in to it, and can't get out.

			1 puts the bottom of the fluid box at the top of a pipe connection, so fluid "falls" out of it, but fluids already outside cannot get into it.

	In other words:		In other words:

	1 = output only (and will attempt to empty as fast as possible).		* 1 = output only (and will attempt to empty as fast as possible).
			* -1 = input only (and will attempt to fill as fast as possible).
	-1 = input only (and will attempt to fill as fast as possible).		* 0 means fluids can freely flow in and out (and like a pipe, will balance to the level of the pipe next to it).

	0 means fluids can freely flow in and out (and like a pipe, will balance to the level of the pipe next to it).


	Having a -1 or 1 improperly set on an output or input, respectively, will cause issues like output fluid not leaving the building, or input fluid not entering, regardless of fluid levels in the pipe or fluid box.		Having a -1 or 1 improperly set on an output or input, respectively, will cause issues like output fluid not leaving the building, or input fluid not entering, regardless of fluid levels in the pipe or fluid box.

Deadlock989: Undo revision 190604 by Deadlock989 (talk)

2022-12-28T11:36:03Z

Undo revision 190604 by Deadlock989 (talk)

← Older revision		Revision as of 11:36, 28 December 2022
Line 72:		Line 72:
	'''Default''': false		'''Default''': false

	Hides the blue input/output arrows and icons at each connection point~~. Defaults to true for storage-tank entities~~.		Hides the blue input/output arrows and icons at each connection point.

	=== pipe_covers ===		=== pipe_covers ===

Deadlock989: /* hide_connection_info */

2022-12-28T11:27:13Z

hide_connection_info

← Older revision		Revision as of 11:27, 28 December 2022
Line 72:		Line 72:
	'''Default''': false		'''Default''': false

	Hides the blue input/output arrows and icons at each connection point.		Hides the blue input/output arrows and icons at each connection point. Defaults to true for storage-tank entities.

	=== pipe_covers ===		=== pipe_covers ===

Honktown: /* base_level */ small word change to reduce ambiguity (height of self vs where it's positioned)

2022-12-26T12:04:57Z

base_level: small word change to reduce ambiguity (height of self vs where it's positioned)

← Older revision		Revision as of 12:04, 26 December 2022
Line 32:		Line 32:
	'''Default''': 0		'''Default''': 0

	Base level is the ~~height~~ of the invisible fluid box.		Base level is the elevation of the invisible fluid box.
	0 is ground level.		0 is ground level.

SzaraKryik: /* base_level */ Slight rewording

2022-12-10T13:24:14Z

base_level: Slight rewording

← Older revision		Revision as of 13:24, 10 December 2022
Line 37:		Line 37:
	-1 puts the '''top''' of the fluid box at the '''bottom''' of a pipe connection, so, fluid "falls" in to it, and can't get out.		-1 puts the '''top''' of the fluid box at the '''bottom''' of a pipe connection, so, fluid "falls" in to it, and can't get out.

	1 puts the '''bottom''' of the fluid box at the '''top''' of a pipe connection, so ~~fluids~~ "~~fall~~" out of it, but ~~other~~ fluids cannot get into it.		1 puts the '''bottom''' of the fluid box at the '''top''' of a pipe connection, so fluid "falls" out of it, but fluids already outside cannot get into it.

	In other words:		In other words: