View source for Template:Item/doc

<languages />
<translate>
<!--T:1-->
This template creates an infobox for items in the game. It has the subcategories {{tl|Item/Food}}, {{tl|Item/Fuel}}, {{tl|Item/Smeltable}}, {{tl|Item/Transitionable}} for specific types of item.

== Usage == <!--T:2-->

<!--T:3-->
The item infobox template should be placed at the top of the article, '''above''' the starting introductory text but below any translation tags where possible. Not every item infobox requires all the parameters - delete them as appropriate. 

<!--T:4-->
<pre style="width: 75%">
{{Item
|Name= Name of the item
|Image=Full image name with File: prefix and file extension
|Stackable=Maximum stack size, defaults to 64

<!--T:5-->
|Temp=Burning temperature
|Duration=Burn duration in seconds

<!--T:6-->
|SmeltTemp=Smelting temp
|RequiresContainer=Whether or not smelting requires a container
|Output=Mold name
|OutputAmount=Number of items crafted in the mold

<!--T:7-->
|FreshTime=Time in seconds the item stays fresh
|TransitionTime=Time in seconds the item takes to turn into something else (e.g. rotten food)
|TransitionRatio=(Unsure)

<!--T:8-->
|Satiety=Satiety points the item provides
|Category=Satiety category of the item

<!--T:9-->
|NoBreak= Whether or not the item box should end in a line break
}}</pre>

<!--T:10-->
When translation tagging, enclose strings in translation tags rather than the entire template - see the example below.

=== Parameters === <!--T:11-->

<!--T:12-->
{| class="wikitable"
|-
! Parameters !! Description !! Type !! Required
|-
| Name || Name of the item || string || yes
|-
| Image || Filename of an image || file || yes
|-
| Stackable || Maximum stack size, default 64 || number || suggested
|-
| Temp || Burning temperature || number || no
|-
| Duration || Burn duration in seconds || number || no
|-
| SmeltTemp || Smelting temperature || number || yes for Item/Smeltable
|-
|SmeltDuration || Smelt duration in seconds || number || yes for Item/Smeltable
|-
|SmeltRatio || (Unsure) || float || unsure
|-
|RequiresContainer || Whether or not smelting requires a container || boolean (y/n) || no
|-
|Output || Smelting output || string || no
|-
|OutputAmount || Amount of items in the mold || number || yes if Output is present
|-
|FreshTime || Time in seconds the item stays fresh || number || yes for Item/Transitionable
|-
|TransitionTime || Time in seconds the item takes to turn into something else (e.g. rotten food) || number || yes for Item/Transitionable
|-
|TransitionRatio || (Unsure) || float || no
|-
|Satiety || Satiety points the item provides || number || yes for Item/Food
|-
|Category || Satiety category of the item || string || yes for Item/Food
|-
|NoBreak || Whether or not the item box should end in a line break || any || no
|}

=== Examples === <!--T:13-->
</translate>
{| class="wikitable" style="width: 75%"
|-
! Code !! Result
|-
| <pre>
{{Item
|Name=Copper
|Image=File:Grid Copper Ingot.png
|Stackable=16
|SmeltTemp=1084
|SmeltDuration=
|RequiresContainer=Yes
|Output=Ingot mold
|FloatLeft=yes
}}
</pre> 
|| {{Item
|Name=Copper
|Image=File:Grid Copper Ingot.png
|Stackable=16
|SmeltTemp=1084
|SmeltDuration=
|RequiresContainer=Yes
|Output=Ingot mold
|FloatLeft=yes
}}
|-
| <pre>
{{Item
|Name=&lt;translate>Turnip&lt;/translate>
|Image=File:Grid turnip.png
|Stackable=64
|FreshTime=504
|TransitionTime=96
|TransitionRatio=0.5
|Satiety=100
|Category=&lt;translate>Vegetable&lt;/translate>
|FloatLeft=yes
}}</pre> n.b. the translate tags "disappear" when put on a page that is properly [[Vintage_Story_Wiki:How_to_translate_the_wiki|marked for translation]].
||
{{Item
|Name=<translate><!--T:14--> Turnip</translate>
|Image=File:Grid turnip.png
|Stackable=64
|FreshTime=504
|TransitionTime=96
|TransitionRatio=0.5
|Satiety=100
|Category=<translate><!--T:15--> Vegetable</translate>
|FloatLeft=yes
}}
|}


<!-- Template categories/interwikis here -->
<includeonly>
[[Category:Infoboxes]]
[[Category:Template documentation]]
</includeonly>