Template:EncounterTable/doc: Difference between revisions
Jump to navigation
Jump to search
(Created page with " Helper Template for formatting encounter tables. This automatically calculates chance provided weights. Each argument is one row, represented by <code>{{Template:EncounterT...") |
mNo edit summary |
||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Doc/start}} | |||
Helper Template for formatting encounter tables. This automatically calculates chance provided weights. | Helper Template for formatting encounter tables. This automatically calculates chance provided weights. | ||
It takes one named parameter: | |||
==Parameters== | ==Parameters== | ||
{|class = "wikitable" | |||
!Parameter | |||
!Description | |||
|- | |||
|roll | |||
|indicates how weight will be calculated. | |||
* <code>once</code> (default) will calculate chance by the total sum of weights as if rolling from the table only once. | |||
* <code>each</code> will calculate chance as if rolling for each item down the list (weight/100). | |||
|} | |||
==Row Parameters== | |||
Each unnamed argument is one row, represented by <code>{{[[Template:EncounterTable/Row|EncounterTable/Row]]}}</code>. It has four named arguments, but two are exclusive to each other. | |||
{|class = "wikitable" | {|class = "wikitable" | ||
!Parameter | !Parameter | ||
Line 11: | Line 23: | ||
|- | |- | ||
| table | | table | ||
|if the item is chosen from another table, use this instead | |if the item is chosen from another table, use this instead. Cannot be used if item is specified. | ||
|- | |- | ||
| quantity | | quantity | ||
Line 22: | Line 34: | ||
==Example== | ==Example== | ||
<pre> | <pre> | ||
{{EncounterTable | {{EncounterTable|roll=once | ||
|{{EncounterTable/Row|table=Junk | |{{EncounterTable/Row|table=Junk 0C|weight=95}} | ||
|{{EncounterTable/Row|table=Junk | |{{EncounterTable/Row|table=Junk 0R|weight=5}} | ||
|{{EncounterTable/Row|item=torch|quantity=2d3|weight=10}} | |||
|{{EncounterTable/Row|item=copper nugget|quantity=4d3|weight=10}} | |||
}} | |||
</pre> | |||
{{EncounterTable|roll=once | |||
|{{EncounterTable/Row|table=Junk 0C|weight=95}} | |||
|{{EncounterTable/Row|table=Junk 0R|weight=5}} | |||
|{{EncounterTable/Row|item=torch|quantity=2d3|weight=10}} | |||
|{{EncounterTable/Row|item=copper nugget|quantity=4d3|weight=10}} | |||
}} | |||
<pre> | |||
{{EncounterTable|roll=each | |||
|{{EncounterTable/Row|table=Junk 0C|weight=95}} | |||
|{{EncounterTable/Row|table=Junk 0R|weight=5}} | |||
|{{EncounterTable/Row|item=torch|quantity=2d3|weight=10}} | |||
|{{EncounterTable/Row|item=copper nugget|quantity=4d3|weight=10}} | |||
}} | }} | ||
</pre> | </pre> | ||
{{EncounterTable | {{EncounterTable|roll=each | ||
|{{EncounterTable/Row|table= | |{{EncounterTable/Row|table=Junk 0C|weight=95}} | ||
|{{EncounterTable/Row|table= | |{{EncounterTable/Row|table=Junk 0R|weight=5}} | ||
|{{EncounterTable/Row|item=torch|quantity=2d3|weight=10}} | |||
|{{EncounterTable/Row|item=copper nugget|quantity=4d3|weight=10}} | |||
}} | }} | ||
[[Category:Template documentation]] | {{doc/end}} | ||
<noinclude>[[Category:Template documentation]]</noinclude> |
Latest revision as of 01:57, 26 April 2020
Documentation
[purge]
Helper Template for formatting encounter tables. This automatically calculates chance provided weights. It takes one named parameter:
Parameters
Parameter | Description |
---|---|
roll | indicates how weight will be calculated.
|
Row Parameters
Each unnamed argument is one row, represented by {{EncounterTable/Row}}
. It has four named arguments, but two are exclusive to each other.
Parameter | Description |
---|---|
item | the item, also referred to as the "Blueprint". will be auto linked. Cannot be used if table is specified. |
table | if the item is chosen from another table, use this instead. Cannot be used if item is specified. |
quantity | How many of the item there are. This automatically calls Template:Dice tooltip, meaning that an average (with a min and max) will be displayed on hover if the quantity is a range (1-3) or a dice roll (2d3+1). |
weight | the weight that the item has to show up. In xml, this is referred to as "Chance". |
Example
{{EncounterTable|roll=once |{{EncounterTable/Row|table=Junk 0C|weight=95}} |{{EncounterTable/Row|table=Junk 0R|weight=5}} |{{EncounterTable/Row|item=torch|quantity=2d3|weight=10}} |{{EncounterTable/Row|item=copper nugget|quantity=4d3|weight=10}} }}
Item | Quantity | Weight | Chance |
---|---|---|---|
Item from Junk 0C | 11 | 95 | 79.17% |
Item from Junk 0R | 11 | 5 | 4.17% |
torch | 2d32-6 (Avg: 4) | 10 | 8.33% |
copper nugget | 4d34-12 (Avg: 8) | 10 | 8.33% |
{{EncounterTable|roll=each |{{EncounterTable/Row|table=Junk 0C|weight=95}} |{{EncounterTable/Row|table=Junk 0R|weight=5}} |{{EncounterTable/Row|item=torch|quantity=2d3|weight=10}} |{{EncounterTable/Row|item=copper nugget|quantity=4d3|weight=10}} }}
Item | Quantity | Weight | Chance |
---|---|---|---|
Item from Junk 0C | 11 | 95 | 95.00% |
Item from Junk 0R | 11 | 5 | 5.00% |
torch | 2d32-6 (Avg: 4) | 10 | 10.00% |
copper nugget | 4d34-12 (Avg: 8) | 10 | 10.00% |