Template:Item/doc: Difference between revisions
From Vintage Story Wiki
No edit summary |
No edit summary |
||
Line 127: | Line 127: | ||
| <pre> | | <pre> | ||
</translate> | </translate> | ||
{{ | {{Item | ||
|Name=<translate>Turnip</translate> | |Name=<translate>Turnip</translate> | ||
|Image=File:Grid turnip.png | |Image=File:Grid turnip.png | ||
Line 141: | Line 141: | ||
<translate></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]]. | <translate></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> | |Name=<translate><!--T:14--> Turnip</translate> | ||
|Image=File:Grid turnip.png | |Image=File:Grid turnip.png |
Revision as of 08:18, 27 July 2023
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 ".png" |Material=Material of the item |Stackable=Maximum stack size, defaults to 64 |Temp=Temperature at which the object burns as fuel |Duration=Burn duration in seconds |SmeltTemp=Smelting temp of the metal |RequiresContainer=Whether or not smelting requires a container |OutputLink=Link to the container's (e.g. a mold) wiki 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, defaults to 1 |FreshTime=Time in hours the item stays fresh (i.e. time before you see it as 0% spoiled) |TransitionTime=Time in hours 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 (e.g. Protein) |FloatRight=Whether or not the box should float on the right side of the page (so you don't have to use a <div></div> tag) |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 |
---|---|---|---|
parameter1 | Description of what parameter1 is | string/boolean/file/number/any | yes/no/suggested |
Name | Name of the item | string | yes |
Image | Filename of an image, including "File:" prefix and ".png" suffix | 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 of the metal | number | yes for Item/Smeltable |
RequiresContainer | Whether or not smelting requires a container | string (write anything for "yes" remove this line for "no") |
no |
OutputLink | Smelting output container page link | string | yes if RequiresContainer is present |
OutputName | Smelting output container name | string | yes if RequiresContainer is present |
OutputAmount | Amount of items obtained after emptying the container | number | yes if OutputName is present |
FreshTime | The amount of hours this item stays fresh / untransitioned | number | yes for Item/Transitionable |
TransitionTime | The amount of time it takes for the item to transition e.g. from 0% spoiled to 100% spoiled | number | yes for Item/Transitionable |
TransitionRatio | Conversion ratio of fresh stacksize to transitioned stack size e.g. 10 apples transition to 5 rots = 0.50 | float | no |
Satiety | Satiety points the item provides | number | yes for Item/Food |
Category | Satiety category of the item (e.g. Protein) | string | yes for Item/Food |
FloatRight | Whether or not the box should float on the right side of the page (so you don't have to use a <div></div> tag) |
any | no |
NoBreak | Whether or not the item box should end in a line break | any | no |
Examples
Code | Result | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{tnt|Item |Name=Copper Ingot |Image=File:Grid Copper Ingot.png |Material=Metal |Stackable=16 |SmeltTemp=1084 |RequiresContainer=Yes |OutputLink=Ingot_mold |OutputName=Ingot mold |OutputAmount=1 |FloatRight=yes |NoBreak=yes }} |
| ||||||||||||||||||||||
</translate> {{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> |FloatRight=yes |NoBreak=yes }} <translate>n.b. the translate tags "disappear" when put on a page that is properly marked for translation. |
|