Template:Harvestable: Difference between revisions

From Caves of Qud Wiki
Jump to navigation Jump to search
(Fix blank space appearing in front of sentence when {{{sing}}} is not provided)
(improve {{{locs}}} variable and improve example)
Line 1: Line 1:
<includeonly>{{#if:{{{sing|​}}}|{{{sing|}}} &#32;|}}{{name}} is a [[harvestry|harvestable]] {{{kingdom|plant}}} that can be found within the {{favilink|{{{loc|salt marsh}}}}}{{{locs|}}}. When harvested, a ripe {{name}} will yield a single {{favilink|{{{yield|vinewafer}}}}}. Upon creation, each {{name}} has a 1:{{{chance|5}}} chance of spawning ripe and does not ripen over time. A ripe {{name}} can be identified by their {{{ripe|green leaves}}}, while an unripe {{name}} has {{{unripe|black leaves}}}.</includeonly><noinclude>
<includeonly>{{#if:{{{sing|​}}}|{{{sing|}}} &#32;|}}{{name}} is a [[harvestry|harvestable]] {{{kingdom|plant}}} that can be found within the {{favilink|{{{loc|salt marsh}}}}}{{#if:{{{locs|}}}|&#32;or {{{locs|}}}|}}. When harvested, a ripe {{name}} will yield a single {{favilink|{{{yield|vinewafer}}}}}. Upon creation, each {{name}} has a 1:{{{chance|5}}} chance of spawning ripe and does not ripen over time. A ripe {{name}} can be identified by their {{{ripe|green leaves}}}, while an unripe {{name}} has {{{unripe|black leaves}}}.</includeonly><noinclude>


Creates a paragraph describing a harvestable plant or other harvestable object.
Creates a paragraph describing a harvestable plant or other harvestable object.
Line 17: Line 17:
|-
|-
| <code>locs</code>
| <code>locs</code>
| Additional secondary locations where the harvestable is found. This will be treated as a simple string.
| Additional secondary locations where the harvestable is found. This will be treated as a simple string that continues the location sentence after a connecting "or"
|-
|-
| <code>yield</code>
| <code>yield</code>
Line 33: Line 33:


== Example ==
== Example ==
{{Harvestable|sing=A}}
<pre>
<nowiki>{{Harvestable|sing=A|loc=Bethesda Susa|locs=underground}}</nowiki>
</pre>
{{Harvestable|sing=A|loc=Bethesda Susa|locs=underground}}


[[Category:Templates]]
[[Category:Templates]]
</noinclude>
</noinclude>

Revision as of 14:57, 9 June 2022


Creates a paragraph describing a harvestable plant or other harvestable object.

Parameter Description
sing The article to appear in front of the harvestable's name at the beginning of the sentence
kingdom The noun used to describe the category of harvestable. "plant" by default.
loc The primary location where the harvestable is found. This will be converted into a favilink.
locs Additional secondary locations where the harvestable is found. This will be treated as a simple string that continues the location sentence after a connecting "or"
yield The single object yielded when the harvestable is harvested.
chance A number which will be converted into the string "has a 1:<NUMBER> chance of spawning ripe and does not ripen over time."
ripe a description of the harvestable when ripe, such as "green leaves". Will be converted into the phrase "can be identified by their <RIPE_PHRASE>"
unripe a description of the harvestable when unripe, such as "black leaves". Will be converted into the phrase "while an unripe <NAME> has <UNRIPE_PHRASE>"

Example

{{Harvestable|sing=A|loc=Bethesda Susa|locs=underground}}

A Harvestable is a harvestable plant that can be found within the Bethesda Susa or underground. When harvested, a ripe Harvestable will yield a single vinewafer. Upon creation, each Harvestable has a 1:5 chance of spawning ripe and does not ripen over time. A ripe Harvestable can be identified by their green leaves, while an unripe Harvestable has black leaves.