Template:Harvestable: Difference between revisions

1,251 bytes added ,  14:50, 9 June 2022
add documentation
No edit summary
(add documentation)
Line 1: Line 1:
{{{sing|​}}} {{name|subjective}} is a [[harvestry|harvestable]] {{{kingdom|plant}}} that can be found within the {{favilink|{{{loc|salt marsh}}}}}{{{locs|}}}. When harvested, a ripe {{name|subjective}} will yield a single {{favilink|{{{yield|vinewafer}}}}}. Upon creation, each {{name|subjective}} has a 1:{{{chance|5}}} chance of spawning ripe and does not ripen over time. A ripe {{name|subjective}} can be identified by their {{{ripe|green leaves}}}, while an unripe {{name|subjective}} has {{{unripe|black leaves}}}.
<includeonly>{{{sing|​}}} {{name|subjective}} is a [[harvestry|harvestable]] {{{kingdom|plant}}} that can be found within the {{favilink|{{{loc|salt marsh}}}}}{{{locs|}}}. When harvested, a ripe {{name|subjective}} will yield a single {{favilink|{{{yield|vinewafer}}}}}. Upon creation, each {{name|subjective}} has a 1:{{{chance|5}}} chance of spawning ripe and does not ripen over time. A ripe {{name|subjective}} can be identified by their {{{ripe|green leaves}}}, while an unripe {{name|subjective}} has {{{unripe|black leaves}}}.</includeonly><noinclude>
 
Creates a paragraph describing a harvestable plant or other harvestable object.
 
{| class="wikitable
! Parameter
! Description
|-
| <code>sing</code>
| The article to appear in front of the harvestable's name at the beginning of the sentence
|-
| <code>kingdom</code>
| The noun used to describe the category of harvestable. "plant" by default.
|-
| <code>loc</code>
| The primary location where the harvestable is found. This will be converted into a favilink.
|-
| <code>locs</code>
| Additional secondary locations where the harvestable is found. This will be treated as a simple string.
|-
| <code>yield</code>
| The single object yielded when the harvestable is harvested.
|-
| <code>chance</code>
| A number which will be converted into the string "has a 1:<NUMBER> chance of spawning ripe and does not ripen over time."
|-
| <code>ripe</code>
| a description of the harvestable when ripe, such as "green leaves". Will be converted into the phrase "can be identified by their <RIPE_PHRASE>"
|-
| <code>unripe</code>
| a description of the harvestable when unripe, such as "black leaves". Will be converted into the phrase "while an unripe <NAME> has <UNRIPE_PHRASE>"
|}
[[Category:Templates]]
</noinclude>