Prototype/Fluid - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:50Z

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\|PrototypeBase}}~~
	~~A fluid.~~

	~~{{Prototype TOC\|fluid}}~~

	~~== Mandatory properties ==~~
	~~Inherits all properties from [[PrototypeBase]].~~

	~~{{Prototype property\|icons, icon, icon_size (IconSpecification)\|[[Types/IconSpecification\|IconSpecification]]}}~~

	~~{{Prototype property\|default_temperature\|[[Types/double\|double]]}}~~
	~~Also the minimum temperature of the fluid. Has to be lower than <code>max_temperature</code>.~~

	~~{{Prototype property\|base_color\|[[Types/Color\|Color]]}}~~
	~~Used by bars that show the fluid color, like the flamethrower turret fill bar in the tooltip, or the fill bar for the fluidwagon tooltip; and for the pipe windows and storage tank fill gauges.~~

	~~{{Prototype property\|flow_color\|[[Types/Color\|Color]]}}~~
	~~Used only for pipe windows or storage tank fill gauges.~~

	~~== Optional properties ==~~

	~~{{Prototype property\|max_temperature\|[[Types/double\|double]]\|value of <code>default_temperature</code>\|optional=true}}~~

	~~{{Prototype property\|heat_capacity\|[[Types/Energy\|Energy]]\|"1KJ"\|optional=true}}~~
	~~Joule needed to heat 1 Unit by 1 °C.~~

	~~{{Prototype property\|fuel_value\|[[Types/Energy\|Energy]]\|"0J"\|optional=true}}~~

	~~{{Prototype property\|emissions_multiplier\|[[Types/double\|double]]\|1.0\|optional=true}}~~
	~~Scales pollution generated when the fluid is consumed.~~

	~~{{Prototype property\|subgroup\|[[Types/string\|string]]\|"fluid"\|optional=true}}~~
	~~The value of this property may not be an empty string. It either has to be nil, or a non-empty string.~~

	~~{{Prototype property\|gas_temperature\|[[Types/double\|double]]\|max value of double\|optional=true}}~~
	~~Above this temperature the <code>gas_flow</code> animation is used to display the fluid inside storage tanks and pipes.~~

	~~{{Prototype property\|hidden\|[[Types/bool\|bool]]\|false\|optional=true}}~~
	~~Hides the fluid from the signal selection screen.~~

	~~== Custom properties ==~~
	The base mod reads the following property in data-updates.lua to determine if the fluid should be barreled. The property itself is not read by the C++ part of the game which means that it is discarded by the game when loading finishes.
	* auto_barrel - [[Types/bool\|bool]] - Optional, defaults to true. Whether the fluid should be included in the barrel recipes automatically generated in data-updates.lua in the base mod.

	~~== Example ==~~
	~~<syntaxhighlight lang="lua"> {~~
	~~type = "fluid",~~
	~~name = "water",~~
	~~default_temperature = 15,~~
	~~max_temperature = 100,~~
	~~heat_capacity = "0.2KJ",~~
	~~base_color = {r=0, g=0.34, b=0.6},~~
	~~flow_color = {r=0.7, g=0.7, b=0.7},~~
	~~icon = "__base__/graphics/icons/fluid/water.png",~~
	~~icon_size = 64,~~
	~~icon_mipmaps = 4,~~
	~~order = "a[fluid]-a[water]"~~
	~~}</syntaxhighlight>~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:04Z

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/FluidPrototype.html https://lua-api.factorio.com/latest/prototypes/FluidPrototype.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/FluidPrototype.html https://lua-api.factorio.com/latest/prototypes/FluidPrototype.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/Fluid": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:29Z

Protected "Prototype/Fluid": 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:29Z

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/FluidPrototype.html https://lua-api.factorio.com/latest/prototypes/FluidPrototype.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\|PrototypeBase}}		{{Prototype parent\|PrototypeBase}}
	A fluid.		A fluid.

Bilka: /* Example */ updated to 1.1.33

2021-05-12T14:18:28Z

Example: updated to 1.1.33

← Older revision		Revision as of 14:18, 12 May 2021
Line 53:		Line 53:
	flow_color = {r=0.7, g=0.7, b=0.7},		flow_color = {r=0.7, g=0.7, b=0.7},
	icon = "__base__/graphics/icons/fluid/water.png",		icon = "__base__/graphics/icons/fluid/water.png",
	icon_size = 32,		icon_size = 64,
	order = "a[fluid]-a[water]",		icon_mipmaps = 4,
	~~pressure_to_speed_ratio = 0.4,~~		order = "a[fluid]-a[water]"
	~~flow_to_energy_ratio = 0.59~~
	}</syntaxhighlight>		}</syntaxhighlight>

Bilka: 1.1

2020-12-02T19:37:22Z

1.1

← Older revision		Revision as of 19:37, 2 December 2020
Line 11:		Line 11:
	{{Prototype property\|default_temperature\|[[Types/double\|double]]}}		{{Prototype property\|default_temperature\|[[Types/double\|double]]}}
	Also the minimum temperature of the fluid. Has to be lower than <code>max_temperature</code>.		Also the minimum temperature of the fluid. Has to be lower than <code>max_temperature</code>.

	~~{{Prototype property\|max_temperature\|[[Types/double\|double]]}}~~

	{{Prototype property\|base_color\|[[Types/Color\|Color]]}}		{{Prototype property\|base_color\|[[Types/Color\|Color]]}}
Line 21:		Line 19:

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

			{{Prototype property\|max_temperature\|[[Types/double\|double]]\|value of <code>default_temperature</code>\|optional=true}}

	{{Prototype property\|heat_capacity\|[[Types/Energy\|Energy]]\|"1KJ"\|optional=true}}		{{Prototype property\|heat_capacity\|[[Types/Energy\|Energy]]\|"1KJ"\|optional=true}}

Bilka: /* Mandatory properties */ default_temperature description

2020-03-03T17:09:15Z

Mandatory properties: default_temperature description

← Older revision		Revision as of 17:09, 3 March 2020
Line 10:		Line 10:

	{{Prototype property\|default_temperature\|[[Types/double\|double]]}}		{{Prototype property\|default_temperature\|[[Types/double\|double]]}}
	Also the minimum temperature of the fluid.		Also the minimum temperature of the fluid. Has to be lower than <code>max_temperature</code>.

	{{Prototype property\|max_temperature\|[[Types/double\|double]]}}		{{Prototype property\|max_temperature\|[[Types/double\|double]]}}

Bilka: gas temperature description

2019-09-01T08:43:49Z

gas temperature description

← Older revision		Revision as of 08:43, 1 September 2019
Line 33:		Line 33:
	The value of this property may not be an empty string. It either has to be nil, or a non-empty string.		The value of this property may not be an empty string. It either has to be nil, or a non-empty string.

	{{Prototype property\|gas_temperature\|[[Types/double\|double]]\|max value of double ~~(1.7976931348623158e+308)~~\|optional=true}}		{{Prototype property\|gas_temperature\|[[Types/double\|double]]\|max value of double\|optional=true}}
			Above this temperature the <code>gas_flow</code> animation is used to display the fluid inside storage tanks and pipes.

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

Bilka: Converted to SMW format

2019-08-06T18:21:28Z

Converted to SMW format

← Older revision		Revision as of 18:21, 6 August 2019
Line 1:		Line 1:
	{{Prototype parent\|PrototypeBase}}		{{Prototype parent\|PrototypeBase}}
			A fluid.

	~~== Basics ==~~		{{Prototype TOC\|fluid}}
	Prototype ~~type: '''~~fluid~~'''~~

	~~A fluid.~~

	== Mandatory properties ==		== Mandatory properties ==
	Inherits all properties from [[PrototypeBase]].		Inherits all properties from [[PrototypeBase]].

	~~===~~ icons, icon, icon_size (IconSpecification) ~~===~~		{{Prototype property\|icons, icon, icon_size (IconSpecification)\|[[Types/IconSpecification\|IconSpecification]]}}
	~~'''Type''':~~ [[Types/IconSpecification]]

	~~=== default_temperature ===~~
	~~'''Type''': [[Types/double]]~~

			{{Prototype property\|default_temperature\|[[Types/double\|double]]}}
	Also the minimum temperature of the fluid.		Also the minimum temperature of the fluid.

	~~===~~ max_temperature ~~===~~		{{Prototype property\|max_temperature\|[[Types/double\|double]]}}
	~~'''Type''':~~ [[Types/double]]

	~~=== base_color ===~~
	~~'''Type''': [[Types/Color]]~~

			{{Prototype property\|base_color\|[[Types/Color\|Color]]}}
	Used by bars that show the fluid color, like the flamethrower turret fill bar in the tooltip, or the fill bar for the fluidwagon tooltip; and for the pipe windows and storage tank fill gauges.		Used by bars that show the fluid color, like the flamethrower turret fill bar in the tooltip, or the fill bar for the fluidwagon tooltip; and for the pipe windows and storage tank fill gauges.

	~~===~~ flow_color ~~===~~		{{Prototype property\|flow_color\|[[Types/Color\|Color]]}}
	~~'''Type''':~~ [[Types/Color]]

	Used only for pipe windows or storage tank fill gauges.		Used only for pipe windows or storage tank fill gauges.

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

	~~===~~ heat_capacity ~~===~~		{{Prototype property\|heat_capacity\|[[Types/Energy\|Energy]]\|"1KJ"\|optional=true}}
	~~'''Type''':~~ [[Types/Energy]]

	~~'''Default''':~~ "1KJ"

	Joule needed to heat 1 Unit by 1 °C.		Joule needed to heat 1 Unit by 1 °C.

	~~===~~ fuel_value ~~===~~		{{Prototype property\|fuel_value\|[[Types/Energy\|Energy]]\|"0J"\|optional=true}}
	~~'''Type''':~~ [[Types/Energy]]

	~~'''Default''':~~ "0J"

	~~=== emissions_multiplier~~ ===
	~~'''Type''': [[Types/double]]~~

	~~'''Default''': 1.0~~

			{{Prototype property\|emissions_multiplier\|[[Types/double\|double]]\|1.0\|optional=true}}
	Scales pollution generated when the fluid is consumed.		Scales pollution generated when the fluid is consumed.

	~~===~~ subgroup ~~===~~		{{Prototype property\|subgroup\|[[Types/string\|string]]\|"fluid"\|optional=true}}
	~~'''Type''':~~ [[Types/string]]

	~~'''Default''':~~ "fluid"

	The value of this property may not be an empty string. It either has to be nil, or a non-empty string.		The value of this property may not be an empty string. It either has to be nil, or a non-empty string.

	~~===~~ gas_temperature ~~===~~		{{Prototype property\|gas_temperature\|[[Types/double\|double]]\|max value of double (1.7976931348623158e+308)\|optional=true}}
	~~'''Type''':~~ [[Types/double]]

	~~'''Default''':~~ max value of double (1.7976931348623158e+308)

	~~=== hidden~~ ===
	~~'''Type''': [[Types/bool]]~~

	~~'''Default''': false~~

			{{Prototype property\|hidden\|[[Types/bool\|bool]]\|false\|optional=true}}
	Hides the fluid from the signal selection screen.		Hides the fluid from the signal selection screen.

	==~~= auto_barrel =~~==		== Custom properties ==
	~~'''Type''':~~ [[Types/bool]]		The base mod reads the following property in data-updates.lua to determine if the fluid should be barreled. The property itself is not read by the C++ part of the game which means that it is discarded by the game when loading finishes.
			* auto_barrel - [[Types/bool\|bool]] - Optional, defaults to true. Whether the fluid should be included in the barrel recipes automatically generated in data-updates.lua in the base mod.
	Whether the fluid should be included in the barrel recipes automatically generated in data-updates.lua in the base mod~~. Not actually a property of the prototype, so it is discarded by the game when loading finishes~~.

	== Example ==		== Example ==

Bilka: Set prototype parent

2019-07-24T14:48:47Z

Set prototype parent

← Older revision		Revision as of 14:48, 24 July 2019
Line 1:		Line 1:
			{{Prototype parent\|PrototypeBase}}

	== Basics ==		== Basics ==
	Prototype type: '''fluid'''		Prototype type: '''fluid'''