Template:Item/doc: Difference between revisions

From Vintage Story Wiki
No edit summary
No edit summary
Line 26: Line 26:
|OutputLink=Link to the container (e.g. a mold) page in your prefered language (you do not need to write Special:MyLanguage/)
|OutputLink=Link to the container (e.g. a mold) page in your prefered language (you do not need to write Special:MyLanguage/)
|OutputName=Container name to be displayed (or its translation)
|OutputName=Container name to be displayed (or its translation)
|OutputAmount=Number of items crafted in the mold
|OutputAmount=Number of items obtained after emptying the container


<!--T:7-->
<!--T:7-->
Line 75: Line 75:
|OutputName || Smelting output container name || string || no
|OutputName || Smelting output container name || string || no
|-
|-
|OutputAmount || Amount of items in the mold || number || yes if Output is present
|OutputAmount || Amount of items obtained after emptying the container || number || yes if Output is present
|-
|-
|FreshTime || The amount of hours this item stays fresh / untransitioned || number || yes for Item/Transitionable
|FreshTime || The amount of hours this item stays fresh / untransitioned || number || yes for Item/Transitionable

Revision as of 06:00, 17 July 2023

Other languages:

This template creates an infobox for items in the game. It has the subcategories {{Item/Food}}, {{Item/Fuel}}, {{Item/Smeltable}}, {{Item/Transitionable}} for specific types of item.

Usage

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.

{{Item
|Name= Name of the item
|Image=Full image name with File: prefix and file extension
|Material=Material of the item
|Stackable=Maximum stack size, defaults to 64

|Temp=Burning temperature
|Duration=Burn duration in seconds

|SmeltTemp=Smelting temp
|RequiresContainer=Whether or not smelting requires a container
|OutputLink=Link to the container (e.g. a mold) page in your prefered language (you do not need to write Special:MyLanguage/)
|OutputName=Container name to be displayed (or its translation)
|OutputAmount=Number of items obtained after emptying the container

|FreshTime=Time in seconds the item stays fresh (i.e. time before you see it as 0% spoiled)
|TransitionTime=Time in seconds the item takes to turn into something else (i.e. time between 0% spoiled to 100% spoiled)
|TransitionRatio=Conversion ratio of fresh stacksize to transitioned stack size (e.g. 10 onions turned into 5 rot: 0.5) 

|Satiety=Satiety points the item provides
|Category=Satiety category of the item

|NoBreak= Whether or not the item box should end in a line break
}}

When translation tagging, enclose strings in translation tags rather than the entire template - see the example below.

Parameters

Parameters Description Type Required
Name Name of the item string yes
Image Filename of an image file yes
Material Material of the item string no
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
OutputLink Smelting output container page link string no
OutputName Smelting output container name string no
OutputAmount Amount of items obtained after emptying the container number yes if Output is present
FreshTime The amount of hours this item stays fresh / untransitioned 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 Conversion ratio of fresh stacksize to transitioned stack size 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

Code Result
{{Item
|Name=Copper
|Image=File:Grid Copper Ingot.png
|Material=Metal
|Stackable=16
|SmeltTemp=1084
|SmeltDuration=
|RequiresContainer=Yes
|OutputLink=Ingot_mold
|OutputName=Ingot mold
|OutputAmount=1
|FloatLeft=yes
}}
Copper
Grid Copper Ingot.png
Material Metal
Stackable 16
Smeltable
Smelt Point 1084°C
Requires Container Yes
Output Ingot mold
Output Amount 1
Items

{{Item
|Name=<translate>Turnip</translate>
|Image=File:Grid turnip.png
|Stackable=64
|FreshTime=504
|TransitionTime=96
|TransitionRatio=0.5
|Satiety=100
|Category=<translate>Vegetable</translate>
|FloatLeft=yes
}}
n.b. the translate tags "disappear" when put on a page that is properly marked for translation.
Turnip
Grid turnip.png
Stackable 64
Food
Satiety 100
Category

Vegetable

Transitionable
Fresh Time 504
Transition Time 96
Transition Ratio 0.5
Items