Template:Construction: Difference between revisions
m (Trying to diagnose the blank space) |
(Updated template to support pipes. updated doc) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<includeonly> | <includeonly>{{#invoke: Construction| renderTable | ||
| planks = {{{Planks| {{{1|}}} }}} | |||
| bricks = {{{Bricks| {{{2|}}} }}} | |||
{{# | | fabric = {{{Fabric| {{{3|}}} }}} | ||
{{ | | parts = {{{Parts| {{{4|}}} }}} | ||
{{ | | wood = {{{Wood|}}} | ||
| pipes = {{{Pipes|}}} | |||
}}</includeonly><noinclude> | |||
{{ | |||
== Overview == | == Overview == | ||
Line 18: | Line 14: | ||
== Parameters == | == Parameters == | ||
You may elect to name the parameters explicitly (<code>Planks=</code>) or use them in the order specified in the table | You may elect to name the parameters explicitly (<code>Planks=</code>) or use them in the order specified in the table. The exception is ''Wood'', which must be declared explicitly, but is placed at the beginning of the table. | ||
{| class="wikitable" | {| class="wikitable" | ||
! Parameter !! Type !! Description | ! Parameter !! Type !! Description | ||
|- | |- | ||
| Planks || | | Planks || number || The number of {{rl|Planks}} required. | ||
|- | |- | ||
| Bricks || | | Bricks || number || The number of {{rl|Bricks}} required. | ||
|- | |- | ||
| Fabric || | | Fabric || number || The number of {{rl|Fabric}} required. | ||
|- | |- | ||
| Parts || | | Parts || number || The number of {{rl|Parts}} required. | ||
|- | |||
| Wood || number || The number of {{rl|Wood}} required. This will appear at the top of the table. This must be named, like <code>Wood=</code> | |||
|- | |||
| Pipes || number || The number of {{rl|Pipes}} required. This must be named, like <code>Pipes=</code> | |||
|} | |} | ||
== Examples == | == Examples == | ||
This table shows all possible values. <code><nowiki>{{Construction|Planks=12|Bricks=8|Fabric=4|Parts=2}}</nowiki></code> yields: | This table shows all possible values. <code><nowiki>{{Construction|Planks=12|Bricks=8|Fabric=4|Parts=2|Wood=10|Pipes=4}}</nowiki></code> yields: | ||
{{Construction|Planks=12|Bricks=8|Fabric=4|Parts=2}} | {{Construction|Planks=12|Bricks=8|Fabric=4|Parts=2|Wood=10|Pipes=4}} | ||
Alternatively, you do not have to name the parameters. <code><nowiki>{{Construction|12|8|4|2}</nowiki></code> yields the same thing: | Alternatively, you do not have to name some of the parameters. <code><nowiki>{{Construction|12|8|4|2}</nowiki></code> yields the same thing: | ||
{{Construction|12|8|4|2}} | {{Construction|12|8|4|2|Wood=10|Pipes=4}} | ||
You can also mix naming and not-naming to make it easier to write when skipping over building materials. <code><nowiki>{{Construction|8|Parts=2}}</nowiki></code> yields: {{Construction|8|Parts=2}} | You can also mix naming and not-naming to make it easier to write when skipping over building materials. <code><nowiki>{{Construction|8|Parts=2}}</nowiki></code> yields: {{Construction|8|Parts=2}} | ||
Remember you need to declare the amount of Wood and Pipes explicitly. This is because <code><nowiki>{{Construction|Wood=10|Parts=3}}</nowiki></code> is much easier to read than <code><nowiki>{{Construction||||3|Wood=10}}</nowiki></code> and affords the ability to declare ''most'' construction requirements with Planks. Here's the result: | |||
{{Construction|Wood=10|Parts=3}} | |||
== Errors == | == Errors == | ||
Line 54: | Line 58: | ||
(It's there, but it's a blank table.) | (It's there, but it's a blank table.) | ||
The template also does not prevent you from mixing both named and unnamed parameters, but the result will be | The template also does not prevent you from mixing both named and unnamed parameters, but the result will be whichever is defined last. | ||
<pre>{{Construction||10|Bricks=12}}</pre> | <pre>{{Construction||10|Bricks=12}}</pre> | ||
Line 60: | Line 64: | ||
Yields: | Yields: | ||
{{Construction||10|Bricks=12}} | {{Construction||10|Bricks=12}} | ||
Finally, even though no buildings currently require it, this template does permit you to display both Wood and Planks. | |||
<pre>{{Construction|2|Wood=8}}</pre> | |||
Yields: | |||
{{Construction|2|Wood=8}} | |||
</noinclude> | </noinclude> |
Latest revision as of 02:34, 7 December 2023
Overview
A template to populate small, well-aligned tables of construction goods.
Parameters
You may elect to name the parameters explicitly (Planks=
) or use them in the order specified in the table. The exception is Wood, which must be declared explicitly, but is placed at the beginning of the table.
Parameter | Type | Description |
---|---|---|
Planks | number | The number of ![]() |
Bricks | number | The number of ![]() |
Fabric | number | The number of ![]() |
Parts | number | The number of ![]() |
Wood | number | The number of ![]() Wood=
|
Pipes | number | The number of ![]() Pipes=
|
Examples
This table shows all possible values. {{Construction|Planks=12|Bricks=8|Fabric=4|Parts=2|Wood=10|Pipes=4}}
yields:
10 | ![]() |
12 | ![]() |
8 | ![]() |
4 | ![]() |
4 | ![]() |
2 | ![]() |
Alternatively, you do not have to name some of the parameters. {{Construction|12|8|4|2}
yields the same thing:
10 | ![]() |
12 | ![]() |
8 | ![]() |
4 | ![]() |
4 | ![]() |
2 | ![]() |
You can also mix naming and not-naming to make it easier to write when skipping over building materials. {{Construction|8|Parts=2}}
yields:
8 | ![]() |
2 | ![]() |
Remember you need to declare the amount of Wood and Pipes explicitly. This is because {{Construction|Wood=10|Parts=3}}
is much easier to read than {{Construction||||3|Wood=10}}
and affords the ability to declare most construction requirements with Planks. Here's the result:
10 | ![]() |
3 | ![]() |
Errors
This template does not result in any errors. However, there is no use for a template called without parameters.
{{Construction}}
Yields:
(It's there, but it's a blank table.)
The template also does not prevent you from mixing both named and unnamed parameters, but the result will be whichever is defined last.
{{Construction||10|Bricks=12}}
Yields:
12 | ![]() |
Finally, even though no buildings currently require it, this template does permit you to display both Wood and Planks.
{{Construction|2|Wood=8}}
Yields:
8 | ![]() |
2 | ![]() |