Prototype/StorageTank - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:33:04Z

Removed old prototype docs

← Older revision		Revision as of 14:33, 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}}~~
	~~A [[storage tank]].~~

	~~{{Prototype TOC\|storage-tank}}~~

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

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

	~~{{Prototype property\|window_bounding_box\|[[Types/BoundingBox\|BoundingBox]]}}~~
	The location of the window showing the contents. Note that for window_background the width and height are determined by the sprite and window_bounding_box only determines the drawing location. For fluid_background the width is determined by the sprite and the height and drawing location are determined by window_bounding_box.

	~~{{Prototype property\|pictures\|[[Types/table\|table]]}}~~
	~~Table with the following mandatory members:~~
	* picture - [[Types/Sprite4Way\|Sprite4Way]]
	* window_background - [[Types/Sprite\|Sprite]]
	* fluid_background - [[Types/Sprite\|Sprite]]
	* flow_sprite - [[Types/Sprite\|Sprite]]
	* gas_flow - [[Types/Animation\|Animation]]

	~~{{Prototype property\|flow_length_in_ticks\|[[Types/uint32\|uint32]]}}~~
	~~Must be positive.~~

	~~Used for determining the x position inside the flow_sprite when drawing the storage tank. Does not affect gameplay.~~

	The x position of the sprite will be <code>((game.tick % flow_length_in_ticks) ÷ flow_length_in_ticks) × (flow_sprite.width - 32)</code>. This means, that over flow_length_in_ticks ticks, the part of the flow_sprite that is drawn in-game is incrementally moved from most-left to most-right inside the actual sprite, that part always has a width of 32px. After flow_length_in_ticks, the part of the flow_sprite that is drawn will start from the left again.

	~~Diagram:~~
	~~<pre>~~
	~~Example state:~~
	~~[ { } ]~~
	~~[] <- flow_sprite~~
	~~{} <- the part that is drawn in-game, width is 32px~~

	~~This means:~~
	~~State at (tick % flow_length_in_ticks) == 0:~~
	~~[{ } ]~~
	~~State at (tick % flow_length_in_ticks) == (flow_length_in_ticks ÷ 2):~~
	~~[ { } ]~~
	~~State at (tick % flow_length_in_ticks) == (flow_length_in_ticks - 1):~~
	~~[ { }]~~
	~~</pre>~~

	~~== Optional properties ==~~

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

	~~{{Prototype property\|circuit_wire_max_distance\|[[Types/double\|double]]\|0\|optional=true}}~~

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

	~~{{Prototype property\|scale_info_icons\|[[Types/bool\|bool]]\|true\|optional=true}}~~
	~~If the icons of fluids shown in alt-mode should be scaled to the storage tank's size.~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:32Z

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

2023-08-16T17:53:18Z

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

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

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:53:17Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:53, 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/StorageTankPrototype.html https://lua-api.factorio.com/latest/prototypes/StorageTankPrototype.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}}
	A [[storage tank]].		A [[storage tank]].

Bilka: 1.1.51: Prototype/EntityWithOwner added

2022-01-21T19:27:42Z

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}}
	A [[storage tank]].		A [[storage tank]].

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

Twinsen: /* Mandatory properties */ Documented window_bounding_box partially

2019-08-26T14:44:16Z

Mandatory properties: Documented window_bounding_box partially

← Older revision		Revision as of 14:44, 26 August 2019
Line 10:		Line 10:

	{{Prototype property\|window_bounding_box\|[[Types/BoundingBox\|BoundingBox]]}}		{{Prototype property\|window_bounding_box\|[[Types/BoundingBox\|BoundingBox]]}}
			The location of the window showing the contents. Note that for window_background the width and height are determined by the sprite and window_bounding_box only determines the drawing location. For fluid_background the width is determined by the sprite and the height and drawing location are determined by window_bounding_box.

	{{Prototype property\|pictures\|[[Types/table\|table]]}}		{{Prototype property\|pictures\|[[Types/table\|table]]}}

Bilka: typo

2019-08-05T17:17:24Z

typo

← Older revision		Revision as of 17:17, 5 August 2019
Line 11:		Line 11:
	{{Prototype property\|window_bounding_box\|[[Types/BoundingBox\|BoundingBox]]}}		{{Prototype property\|window_bounding_box\|[[Types/BoundingBox\|BoundingBox]]}}

	{{Prototype property\|pictures\|[[Types/table\|table]]~~\|\|optional=true~~}}		{{Prototype property\|pictures\|[[Types/table\|table]]}}
	Table with the following mandatory members:		Table with the following mandatory members:
	* picture - [[Types/Sprite4Way\|Sprite4Way]]		* picture - [[Types/Sprite4Way\|Sprite4Way]]

Bilka: Converted to SMW format

2019-08-05T17:17:16Z

Converted to SMW format

← Older revision		Revision as of 17:17, 5 August 2019
Line 1:		Line 1:
	{{Prototype parent\|Prototype/EntityWithHealth}}		{{Prototype parent\|Prototype/EntityWithHealth}}
			A [[storage tank]].

	~~== Basics ==~~		{{Prototype TOC\|storage-tank}}
	Prototype ~~type: '''~~storage-tank~~'''~~

	~~A [[storage tank]]. Based on [[Prototype/EntityWithHealth]].~~

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

	~~===~~ fluid_box ~~===~~		{{Prototype property\|fluid_box\|[[Types/FluidBox\|FluidBox]]}}
	~~'''Type''':~~ [[Types/FluidBox]]

	~~===~~ window_bounding_box ~~===~~		{{Prototype property\|window_bounding_box\|[[Types/BoundingBox\|BoundingBox]]}}
	~~'''Type''':~~ [[Types/BoundingBox]]

	~~=== pictures ===~~
	~~'''Type''': [[Types/table]]~~

			{{Prototype property\|pictures\|[[Types/table\|table]]\|\|optional=true}}
	Table with the following mandatory members:		Table with the following mandatory members:
	* picture - [[Types/Sprite4Way]]		* picture - [[Types/Sprite4Way\|Sprite4Way]]
	* window_background - [[Types/Sprite]]		* window_background - [[Types/Sprite\|Sprite]]
	* fluid_background - [[Types/Sprite]]		* fluid_background - [[Types/Sprite\|Sprite]]
	* flow_sprite - [[Types/Sprite]]		* flow_sprite - [[Types/Sprite\|Sprite]]
	* gas_flow - [[Types/Animation]]		* gas_flow - [[Types/Animation\|Animation]]

	~~=== flow_length_in_ticks ===~~
	~~'''Type''': [[Types/uint32~~]]

			{{Prototype property\|flow_length_in_ticks\|[[Types/uint32\|uint32]]}}
	Must be positive.		Must be positive.

Line 52:		Line 44:
	== Optional properties ==		== Optional properties ==

	~~===~~ two_direction_only ~~===~~		{{Prototype property\|two_direction_only\|[[Types/bool\|bool]]\|false\|optional=true}}
	~~'''Type''':~~ [[Types/bool]]

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

	~~===~~ circuit_wire_max_distance ~~===~~		{{Prototype property\|circuit_wire_max_distance\|[[Types/double\|double]]\|0\|optional=true}}
	~~'''Type''':~~ [[Types/double]]

	~~'''Default''': 0~~		{{Prototype property\|draw_copper_wires\|[[Types/bool\|bool]]\|true\|optional=true}}

	~~=== draw_copper_wires ===~~		{{Prototype property\|draw_circuit_wires\|[[Types/bool\|bool]]\|true\|optional=true}}
	~~'''Type''':~~ [[Types/bool]]

	~~'''Default''':~~ true

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

	~~'''Default''':~~ true

	~~=== circuit_wire_connection_points ===~~
	~~'''Type''': [[Types/table]] of [[Types/WireConnectionPoint]]~~

			{{Prototype property\|circuit_wire_connection_points\|[[Types/table\|table]] of [[Types/WireConnectionPoint\|WireConnectionPoint]]\|optional=true}}
	Mandatory if circuit_wire_max_distance > 0.		Mandatory if circuit_wire_max_distance > 0.

	~~===~~ circuit_connector_sprites ~~===~~		{{Prototype property\|circuit_connector_sprites\|[[Types/table\|table]] of [[Types/CircuitConnectorSprites\|CircuitConnectorSprites]]\|optional=true}}
	~~'''Type''':~~ [[Types/table]] of [[Types/CircuitConnectorSprites]]

	Mandatory if circuit_wire_max_distance > 0.		Mandatory if circuit_wire_max_distance > 0.

	~~===~~ scale_info_icons ~~===~~		{{Prototype property\|scale_info_icons\|[[Types/bool\|bool]]\|true\|optional=true}}
	~~'''Type''':~~ [[Types/bool]]

	~~'''Default''':~~ true

	If the icons of fluids shown in alt-mode should be scaled to the storage tank's size.		If the icons of fluids shown in alt-mode should be scaled to the storage tank's size.

Bilka: Set prototype parent

2019-07-24T15:53:43Z

Set prototype parent

← Older revision		Revision as of 15:53, 24 July 2019
Line 1:		Line 1:
			{{Prototype parent\|Prototype/EntityWithHealth}}

	== Basics ==		== Basics ==
	Prototype type: '''storage-tank'''		Prototype type: '''storage-tank'''

Bilka: scale_info_icons - 0.17.35

2019-05-02T19:36:38Z

scale_info_icons - 0.17.35

← Older revision		Revision as of 19:36, 2 May 2019
Line 79:		Line 79:

	Mandatory if circuit_wire_max_distance > 0.		Mandatory if circuit_wire_max_distance > 0.

			=== scale_info_icons ===
			'''Type''': [[Types/bool]]

			'''Default''': true

			If the icons of fluids shown in alt-mode should be scaled to the storage tank's size.