Template:Block/doc

From Industrial-Craft-Wiki
Jump to: navigation, search
Template-info.png Documentation
Block
Picture na.png
Properties
Type  ?
Tool  ?
Armor rating {{{armorrating}}}
Damage {{{damage}}}
Durability {{{durability}}}
Mining level {{{mininglevel}}}
Stackable Yes (64)
Flammable No
Danger {{{danger}}}
Protection {{{protection}}}
Storage {{{storageslots}}}
Liquid Storage {{{lstorage}}} mB
Upgrades
{{{upgrades}}}
Previous tier {{{prevtier}}}
Next tier {{{nexttier}}}
Energy Consumption
Max EU Input {{{maxeu}}}
EU Use {{{eu_use}}} EU/t
EU Per Operation {{{eu_op}}}
EU Storage {{{storage}}} EU
EU Production {{{eu_produce}}} EU/t
Max EU Output {{{maxout}}}
Max Heat Input {{{maxhu}}} HU/t
Heat Use {{{hu_use}}} HU/t
Heat Production {{{hu_produce}}} HU/t
Max Kinetic Input {{{maxku}}} KU/t
Kinetic Use {{{ku_use}}} KU/t
Kinetic Production {{{ku_produce}}} KU/t
Technical Details
Operation Length {{{optime}}} Seconds
UU Cost {{{uu_cost}}}
First appearance {{{firstappearance}}}
Last appearance {{{lastappearance}}}
ID IC2:{{{id}}}
Flow Speed {{{fluidspeed}}} m/s
Player Speed {{{movespeed}}}

This template provides a uniform design for block pages.

<onlyinclude>{{ {{{1|Block}}}
|title=
|image=
|image2=
|image3=
|invimage=
|invimage2=
|invimage3=
|invimage4=
|type=
|dirt=
|maxeu=
|storage=
|eu_use=
|eu_use2=
|tool=
|stackable=
|data=
|fluidspeed=
|movespeed=
}}</onlyinclude>

Please note the unusual markup at the beginning and end; copy it verbatim if you are creating a new block page. Also note that if the item has multiple data values, use |multipledata= instead of |data=. See below:

New parameters are marked in bold.

Parameter Function Default value
title Only needed to change the title from the page name {{BASEPAGENAME}}
image Image of the block (should be approx. 150x150px) {{BASEPAGENAME}}_ig.png if it exists, otherwise No block image.png (linking to the page where to opload the missing image)
image2 Second image for two-state blocks (also approx. 150x150px) None
image3 Third image for three-state blocks (also approx. 150x150px) None
invimage Image for object in inventory. Can use None to force no invimage. Uses styling and images from Template:Grid/Available images Grid {{BASEPAGENAME}}.png if it exists, otherwise None
invimage2 Second image for two-state objects in inventory. Uses styling and images from Template:Grid/Available images None
invimage3 Third image for three-state objects in inventory. Uses styling and images from Template:Grid/Available images None
invimage4 Fourth image for four-state objects in inventory. Uses styling and images from Template:Grid/Available images None
type Type (solid block, solid, block, or fluid)  ?
dirt Requires sunlight/dirt? None
maxeu Maximum operating EU before this block explodes. None
storage How much EU this block can store. None
eu_use EU use per tick. None
eu_use2 Additional detail line None
tool Minimum tool to use  ?
stackable Stackable N/A
data Single decimal data value None
multipledata Multiple decimal data values, use {{dv}} None
fluidspeed Speed of fluid movement None
movespeed Speed of walking through None

Transcluding block pages

The unusual header <onlyinclude>{{ {{{1|Block}}} and footer are there so that block pages can be transcluded (used like templates) into other pages. Specifically, this allows the use of {{Safe get}} to get specific data fields out of the infobox header in the block page. Here's some examples:

Code Result
{{Safe get|Macerator|tntres}} ERROR: Macerator does not properly transclude Template:Block
{{Safe get|Macerator|tool}} ERROR: Macerator does not properly transclude Template:Block
[[File:{{Safe get|Macerator|image}}]] [[File:ERROR: Macerator does not properly transclude Template:Block]]
{{Safe get|Macerator|non-existing field}} ERROR: Macerator does not properly transclude Template:Block
{{Safe get|Main Page|tntres}} ERROR: Main Page does not properly transclude Template:Block

Although transcluding non-template pages is somewhat unusual, doing it this way allows all the data properties for a block to be defined in the infobox header, next to each other, and right where most people will think to look for them. At the same time, it allows us to make tables of values for things like Blast Resistance and Hardness that auto-update whenever the main values are changed.

See {{Blast Resistance Table}} for a simple example of how to use this functionality to automatically build tables.

See also

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.