Official Factorio Wiki - User contributions [en]

Types/ProductPrototype

2019-10-29T14:48:15Z

Twinsen: /* Optional properties */

Class used for [[Prototype/Recipe]] prodcuts, it loads as [[Types/ItemProductPrototype]] or [[Types/FluidProductPrototype]], depending on the [[#type]].
== Optional properties ==
=== type ===
'''Type''': [[Types/string]]

'''Default''': "item"

Either "item" or "fluid". If this is <code>item</code>, the definition is loaded as a [[Types/ItemProductPrototype]], if this is <code>fluid</code>, the definition is loaded as a [[Types/FluidProductPrototype]].

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

'''Default''': true

When hovering over a recipe in the crafting menu the recipe tooltip will be shown. An additional item tooltip will be shown for every product, as a separate tooltip, if the item tooltip has a description and/or properties to show and if show_details_in_recipe_tooltip is true.

Types/IngredientPrototype

2019-10-29T14:47:43Z

Twinsen: /* Optional properties */

Types/IngredientPrototype

2019-10-29T14:42:37Z

Twinsen: /* Optional properties */

Class used for [[Prototype/Recipe]] ingredients, it loads as [[Types/ItemIngredientPrototype]] or [[Types/FluidIngredientPrototype]], depending on the [[#type]].
== Optional properties ==
=== type ===
'''Type''': [[Types/string]]

'''Default''': "item"

Either "item" or "fluid". If this is <code>item</code>, the definition is loaded as a [[Types/ItemIngredientPrototype]], if this is <code>fluid</code>, the definition is loaded as a [[Types/FluidIngredientPrototype]].

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

'''Default''': true

When hovering over a recipe in the crafting menu the recipe tooltip will be shown. An additional item tooltip will be shown for every product, as a separate tooltip, if the item tooltip has a description and/or properties to show and if show_details_in_recipe_tooltip is true.

== Example ==

<syntaxhighlight lang="lua">
{type="item", name="steel-plate", amount=8}

{type="fluid", name="water", amount=50}</syntaxhighlight>

Prototype/StorageTank

2019-08-26T14:44:16Z

Twinsen: /* Mandatory properties */ Documented window_bounding_box partially

{{Prototype parent|Prototype/EntityWithHealth}}
A [[storage tank]].

{{Prototype TOC|storage-tank}}

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

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