Template:Block/doc: Difference between revisions
From Vintage Story Wiki
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
<languages /> | <languages /><translate> | ||
<translate> | |||
<!--T:1--> | <!--T:1--> | ||
Line 18: | Line 17: | ||
|Fertility= Fertility of the block for farming | |Fertility= Fertility of the block for farming | ||
|LightLevel= Light level that the block generates | |LightLevel= Light level that the block generates | ||
|Temp= Burning temperature | |Temp= Burning temperature as a fuel | ||
|Duration= Burning duration in seconds | |Duration= Burning duration in seconds | ||
|SmeltTemp= Smelting temperature | |SmeltTemp= Smelting temperature as a metal | ||
|RequiresContainer= Whether or not smelting requires a container | |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/) | |OutputLink=Link to the container's (e.g. a mold) wiki page in your prefered language (you do not need to write Special:MyLanguage/) | ||
Line 31: | Line 30: | ||
=== Parameters === <!--T:4--> | === Parameters === <!--T:4--> | ||
< | </translate> | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Parameters !! Description !! Type !! Required | ! <translate>Parameters</translate> !! <translate>Description</translate> !! <translate>Type</translate> !! <translate>Required</translate> | ||
|- | |- | ||
| parameter1 || Description of what parameter1 is || string/boolean/file/number/any || yes/no/suggested | | <translate>parameter1</translate> || <translate>Description of what parameter1 is</translate> || <translate>string/boolean/file/number/any</translate> || <translate>yes/no/suggested</translate> | ||
|- | |- | ||
| Name || Name of the block || string || yes | | ''Name'' || <translate>Name of the block</translate> || <translate>string</translate> || <translate>yes</translate> | ||
|- | |- | ||
| Image || Filename of an image, including "File:" prefix and ".png" suffix || file || yes | | ''Image'' || <translate>Filename of an image, including "File:" prefix and ".png" suffix</translate> || <translate>file</translate> || <translate>yes</translate> | ||
|- | |- | ||
| Material || The block's material type || string || suggested | | ''Material'' || <translate>The block's material type</translate> || <translate>string</translate> || <translate>suggested</translate> | ||
|- | |- | ||
| Stackable || Maximum stack size, defaults to 64 || number || suggested | | ''Stackable'' || <translate>Maximum stack size, defaults to 64</translate> || <translate>number</translate> || <translate>suggested</translate> | ||
|- | |- | ||
| Drops || What the block drops on breaking || wikitext || suggested | | ''Drops'' || <translate>What the block drops on breaking</translate> || <translate>wikitext</translate> || <translate>suggested</translate> | ||
|- | |- | ||
| Fertility || Fertility of the block for farming || percentage || no | | ''Fertility'' || <translate>Fertility of the block for farming</translate> || <translate>percentage</translate> || <translate>no</translate> | ||
|- | |- | ||
| LightLevel || Light level that the block generates || number || no | | ''LightLevel'' || <translate>Light level that the block generates</translate> || <translate>number</translate> || <translate>no</translate> | ||
|- | |- | ||
| SmeltTemp || Smelting temperature || number || yes for Item/Smeltable | | ''SmeltTemp'' || <translate>Smelting temperature</translate> || <translate>number</translate> || <translate>yes for Item/Smeltable</translate> | ||
|- | |- | ||
| RequiresContainer || Whether or not smelting requires a container || string || no | | ''RequiresContainer'' || <translate>Whether or not smelting requires a container</translate> || <translate>string</translate> || <translate>no</translate> | ||
|- | |- | ||
|OutputLink || Smelting output container page link || string || yes if RequiresContainer is present | | ''OutputLink'' || <translate>Smelting output container page link</translate> || <translate>string</translate> || <translate>yes if RequiresContainer is present</translate> | ||
|- | |- | ||
|OutputName || Smelting output container name || string || yes if RequiresContainer is present | | ''OutputName'' || <translate>Smelting output container name</translate> || <translate>string</translate> || <translate>yes if RequiresContainer is present</translate> | ||
|- | |- | ||
|OutputAmount || Amount of items obtained after emptying the container || number || yes if OutputName is present | | ''OutputAmount'' || <translate>Amount of items obtained after emptying the container</translate> || <translate>number</translate> || <translate>yes if OutputName is present</translate> | ||
|- | |- | ||
|FloatRight || Whether or not the box should float on the right side of the page<br>(so you don't have to use a <nowiki><div></div></nowiki> tag) || any || no | | ''FloatRight'' || <translate>Whether or not the box should float on the right side of the page<br>(so you don't have to use a <nowiki><div></div></nowiki> tag)</translate> || <translate>any</translate> || <translate>no</translate> | ||
|- | |- | ||
|NoBreak || Whether or not the item box should end in a line break || any || no | | ''NoBreak'' || <translate>Whether or not the item box should end in a line break</translate> || <translate>any</translate> || <translate>no</translate> | ||
|} | |} | ||
<translate> | |||
=== Examples === <!--T:6--> | === Examples === <!--T:6--> | ||
</translate> | </translate> | ||
{| class="wikitable" style="width: 75%" | {| class="wikitable" style="width: 75%" | ||
|- | |- | ||
! Code !! Result | ! <translate>Code</translate> !! <translate>Result</translate> | ||
|- | |- | ||
| <pre> | | <pre> | ||
Line 79: | Line 80: | ||
|Material=Soil | |Material=Soil | ||
|Stackable=64 | |Stackable=64 | ||
|Drops=Low fertility soil | |Drops=[[Special:MyLanguage/Soil|Low fertility soil]] | ||
|Fertility=25% | |Fertility=25% | ||
|FloatRight=yes | |FloatRight=yes | ||
Line 91: | Line 92: | ||
|Stackable=64 | |Stackable=64 | ||
|Fertility=25% | |Fertility=25% | ||
|Drops=Low fertility soil | |Drops=[[Special:MyLanguage/Soil|Low fertility soil]] | ||
|FloatRight=yes | |FloatRight=yes | ||
|NoBreak=yes | |NoBreak=yes | ||
Line 103: | Line 104: | ||
|Material=<translate>Soil</translate> | |Material=<translate>Soil</translate> | ||
|Stackable=64 | |Stackable=64 | ||
|Drops=<translate>4-5 Blue clay</translate> | |Drops=<translate>4-5 [[Special:MyLanguage/Clay|Blue clay]]</translate> | ||
|FloatRight=yes | |FloatRight=yes | ||
|NoBreak=yes | |NoBreak=yes | ||
Line 114: | Line 115: | ||
|Material=<translate><!--T:9--> Soil</translate> | |Material=<translate><!--T:9--> Soil</translate> | ||
|Stackable=64 | |Stackable=64 | ||
|Drops=<translate><!--T:10--> 4-5 Blue clay</translate> | |Drops=<translate><!--T:10--> 4-5 [[Special:MyLanguage/Clay|Blue clay]]</translate> | ||
|FloatRight=yes | |FloatRight=yes | ||
|NoBreak=yes | |NoBreak=yes |
Revision as of 09:13, 29 July 2023
This template creates an infobox that is designed for blocks in Vintage Story. It has the subcategories {{Item/Fuel}}
and {{Item/Smeltable}}
but it is currently unclear why it uses the Item prefix for smeltable blocks.
Usage
Unused parameters can be safely deleted.
{{Block |Name= Name of the block |Image= Full image name with File: prefix and file extension i.e. File:Imageexample.png |Material= The block's material type |Stackable= Maximum stack size, defaults to 64 |Drops= What the block drops on breaking |Fertility= Fertility of the block for farming |LightLevel= Light level that the block generates |Temp= Burning temperature as a fuel |Duration= Burning duration in seconds |SmeltTemp= Smelting temperature as a 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 |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 }}
Parameters
Parameters | Description | Type | Required |
---|---|---|---|
parameter1 | Description of what parameter1 is | string/boolean/file/number/any | yes/no/suggested |
Name | Name of the block | string | yes |
Image | Filename of an image, including "File:" prefix and ".png" suffix | file | yes |
Material | The block's material type | string | suggested |
Stackable | Maximum stack size, defaults to 64 | number | suggested |
Drops | What the block drops on breaking | wikitext | suggested |
Fertility | Fertility of the block for farming | percentage | no |
LightLevel | Light level that the block generates | number | no |
SmeltTemp | Smelting temperature | number | yes for Item/Smeltable |
RequiresContainer | Whether or not smelting requires a container | string | 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 |
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 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{Block |Name=Forest soil |Image=File:Forestfloor-0.png |Material=Soil |Stackable=64 |Drops=[[Special:MyLanguage/Soil|Low fertility soil]] |Fertility=25% |FloatRight=yes |NoBreak=yes }} |
| ||||||||||||||
</translate> {{Block |Name=<translate>Blue clay</translate> |Image=File:Rawclay blue.png |Material=<translate>Soil</translate> |Stackable=64 |Drops=<translate>4-5 [[Special:MyLanguage/Clay|Blue clay]]</translate> |FloatRight=yes |NoBreak=yes }} <translate>n.b. The translate tags will be properly parsed and "disappear" once a page is marked for translation. |
|