Template:Perks/doc: Difference between revisions

From Against the Storm Official Wiki
(Almost finished with the doc)
m (→‎Inline examples =: fixing typo in heading)
 
(10 intermediate revisions by the same user not shown)
Line 18: Line 18:
| id || A list of IDs of Perks, Cornerstones, and effects, separated by commas. Since IDs are unique, each matched ID adds exactly one Perk to the table. Will not throw an error if an ID is invalid.
| id || A list of IDs of Perks, Cornerstones, and effects, separated by commas. Since IDs are unique, each matched ID adds exactly one Perk to the table. Will not throw an error if an ID is invalid.
|-
|-
| name || Searches names for this string, and adds Perks with any part of their names matching that string to the table.
| name || A list of terms to search for in names. Adds all Perks with any part of their names matching those terms to the table.
|-
|-
| description || Searches descriptions for this string, and adds Perks with any part of their descriptions matching that string to the table.
| description || A list of terms to search for in descriptions. Adds all Perks with any part of their descriptions matching that string to the table.
|-
| search || A shortcut parameter for the previous two. <code>search=criteria</code> is the same as <code>name=criteria|description=criteria</code>. Using this parameter does not prevent you from or override searching by name or description too, but it kind of defeats the purpose.
|-
|-
| rarity || Filters any Perks found by the first search parameters by the specified rarity. Does not throw an error if you misspell the term; here are the correct options:
| rarity || Filters any Perks found by the first search parameters by the specified rarity. Does not throw an error if you misspell the term; here are the correct options:
Line 76: Line 78:
| list_type || bullet || When displaying as a list instead of a table, you can specify <code>list_type=number</code> to show the list as a numbered list instead.
| list_type || bullet || When displaying as a list instead of a table, you can specify <code>list_type=number</code> to show the list as a numbered list instead.
|}
|}
Work in progress


== Errors ==
== Errors ==
Line 95: Line 95:


=== Selecting Perks by their IDs ===
=== Selecting Perks by their IDs ===
IDs to select are normalized, so you do not need to worry about case. Spelling, spacing, and punctuation must all be correct, however.
<pre>{{Perks
|id=accidental barrels
}}</pre>
Is the same as the following:


<pre>{{Perks
<pre>{{Perks
Line 101: Line 109:


Yields:
Yields:
{{Perks|id=Accidental Barrels}}
{{Perks|id=accidental barrels}}




Line 112: Line 120:
Yields:
Yields:
{{Perks|id=Amber for Trader Visit, Trader Interval +25, Trading Packs}}
{{Perks|id=Amber for Trader Visit, Trader Interval +25, Trading Packs}}
=== Excluding Perks by their IDs ===
Likewise, you can exclude specific Perks by listing their IDs. This works with any of the other search criteria below, like name or description or rarity. Similar to selecting by IDs, case does not matter, but spelling, spacing, and punctuation all do matter.
<pre>{{Perks
|id=Accidental Barrels,
    Accidental Jerky,
    Accidental Wine,
    Accidental Crystalized dew,
    Accidental Pigment,
    Accidental Skewers,
    Accidental Oil,
    Accidental Bricks,
    Accidental Lizard
|exclude=accidental lizard
}}</pre>
Yields:
{{Perks|id=Accidental Barrels,Accidental Jerky,Accidental Wine,Accidental Crystalized dew,Accidental Pigment,Accidental Skewers,Accidental Oil,Accidental Bricks,Accidental Lizard|exclude=accidental lizard}}


=== Searching names and descriptions ===
=== Searching names and descriptions ===


The following example shows searching the same term in both name and description, but you could search different things in each field or use only one and not the other.
The following example shows searching the same term in both name and description, but you could search different things in each field or use only one and not the other. As a shorthand, when you want to search for the same thing in both name and description, you can use the '''search''' parameter instead.


<pre>{{Perks
<pre>{{Perks
|name=blightrot cyst
|name=blightrot cyst
|description=blightrot cyst
|description=blightrot cyst
}}</pre>
Note this is the same as this:
<pre>{{Perks
|search=blightrot cyst
}}</pre>
}}</pre>


Line 125: Line 159:
{{Perks|name=blightrot cyst|description=blightrot cyst}}
{{Perks|name=blightrot cyst|description=blightrot cyst}}


Similar to selecting IDs, You can also search for multiple terms in names and descriptions by separating additional terms with commas. This allows you to combine Perks into one table that otherwise seem unrelated, and may be easier than selecting all of their IDs.
The results are combined so the number of results increases, like with an '''or''' boolean operation, and this cannot be changed.
<pre>{{Perks
|name=mist,ashes
}}</pre>
Yields:
{{Perks|name=mist,ashes}}


=== Filtering by rarity or source ===
=== Filtering by rarity or source ===
Line 230: Line 275:
|name=Barrel
|name=Barrel
|show_id=show
|show_id=show
|skip_sources=skip
}}</pre>
}}</pre>


Line 288: Line 332:
Yields:
Yields:
{{Perks|id=Accidental Barrels|name=barrel|display=list|show_id=show}}
{{Perks|id=Accidental Barrels|name=barrel|display=list|show_id=show}}
== Inline examples ==
<pre>{{Perks|id=Accidental Barrels|display=inline}}</pre>
Yields the following, shown in the middle of a paragraph to highlight its usefulness. When you lack any kind of vessel, look for {{Perks|id=Accidental Barrels|display=inline}} to get some for free every time you make Planks!
<pre>{{Perks|id=Accidental Barrels|display=inline|show_id}}</pre>
You can also show the ID of the Perk alongside the link, like {{Perks|id=Accidental Barrels|display=inline|show_id=show}}, if your readers need to see it too.
== View ==
The functionality of the '''Perks''' template is accomplished through the [[Wiki data model]]. This '''Template:Perks''' calls the controller module, which in turn interfaces with the data model module. It also interfaces with the view module for the table or calls a template to display the list version.
Only the last, List/item, is called from the controller. All others are still here in the off chance they may be useful to an author for manually creating tables of perks. However, it is strongly recommended to learn how to use [[Template:Perks]] instead. The table version of the view is accomplished with [[Module:PerksView]], which cannot be invoked directly, but is invoked by [[Module:PerksController]].
{|class=wikitable
|+ Related templates
! Template !! Purpose
|-
| [[Template:PerksCornerstonesTable]] || Primary, default table header template
|-
| [[Template:PerksCornerstonesTable/row]] || Default table row template
|-
| [[Template:PerksCornerstonesTable/end]] || Table markup closing
|-
| [[Template:PerksCornerstonesTable/SkipSources]] || Table header template, but without the sources columns
|-
|white-space="nowrap"| [[Template:PerksCornerstonesTable/row/SkipSources]] || Table row template, but without the sources columns
|-
| [[Template:PerksCornerstonesList/item]] || List version row template (there is no list header template)
|}
[[Category:Lua-based templates]]

Latest revision as of 03:42, 10 October 2024

Overview

Displays data about Perks, Cornerstones, and other effects based on search parameters and exclusions. There are a few ways the data can be displayed.

Parameters

All parameters are optional. If no parameters are given, a table of all 300+ Perks will be displayed, showing their icon and name linking to the Perk's page, descriptions, rarity, sources, and price when purchased from a trader.

Selection, Filtering, and Exclusion

You may combine the first three parameters to return more Perks. The result will be the union of your selections, without duplicates. Then use exclude to remove any Perks that are unrelated to your purposes with their IDs or filter by rarity or source.

Remember that IDs are not visible int he game, so you may need to look them up first.

Parameter Description
id A list of IDs of Perks, Cornerstones, and effects, separated by commas. Since IDs are unique, each matched ID adds exactly one Perk to the table. Will not throw an error if an ID is invalid.
name A list of terms to search for in names. Adds all Perks with any part of their names matching those terms to the table.
description A list of terms to search for in descriptions. Adds all Perks with any part of their descriptions matching that string to the table.
search description=criteria. Using this parameter does not prevent you from or override searching by name or description too, but it kind of defeats the purpose.
rarity Filters any Perks found by the first search parameters by the specified rarity. Does not throw an error if you misspell the term; here are the correct options:
  • Uncommon
  • Rare
  • Epic
  • Legendary
  • Mythic
source Filters any Perks found by the first search parameters by the specified source. Does not throw an error if you misspell the term; here are the correct options:
  • Altar (the Forsaken Altar)
  • Cornerstone
  • Order
  • Relic (from Glade Events)
  • Trader
exclude A list of IDs, separated by commas, that will be excluded from the display. Will not throw an error if an ID is invalid.

Output Overrides

These parameters allow you to customize the appearance of the results.

Parameter Default Description
caption "Perks and Cornerstones" Captions are calculated automatically based on your search and filtering criteria. However, if you want to override the default caption for the table, you can specify it here.
show_id hidden Use show_id=show if you want to show a first column in the table that shows the ID of the Perk. (In list or inline display, the ID is shown in parentheses after the Perk's name.)
show_rarity shown Use show_rarity=no if you want to hide the rarity column from the table. (In list or inline display, the rarity is never shown.)
show_description shown Use show_description=no if you want to hide the description column from the table. (In list or inline display, the description is never shown.)
skip_sources not skipped Use skip_sources=skip if you want a table that skips the section of five columns indicating the sources of the Perk. This breaks from the naming convention of the other parameters because the template logic is different.

If you want to hide individual columns to make comparisons easier, see below, but take note of two things: (1) in list or inline display, sources are never shown and (2) if you hide all of the source columns individually, without skipping the sources section, the table headings will become misaligned.

show_source_altar shown Use show_source_altar=no to hide the Forsaken Altar source column.
show_source_cornerstone shown Use show_source_cornerstone=no to hide the Cornerstone source column.
show_source_order shown Use show_source_order=no to hide the Order source column.
show_source_relic shown Use show_source_relic=no to hide the Glade Event Relic source column.
show_source_trader shown Use show_source_trader=no to hide the Trader source column.
show_price shown Use show_price=no to hide the price column from the table. (In list or inline display, the price is never shown.)
display a table For use when including these Perks inside other tables or within paragraphs, the display parameter condenses the output to just the links to the pages on each Perk:
  • Use display=list to convert the table layout into a basic bulleted list with simple links and no icons.
  • Use display=inline to convert the table into an inline list of links, separated by commas, also with no icons.
list_type bullet When displaying as a list instead of a table, you can specify list_type=number to show the list as a numbered list instead.

Errors

No results from search

If you specify parameters intending to select or search for terms, sometimes there is no result. This can be because you misspelled an id, rarity name, or source name or asked for a search term that was no present in any name or description—or ultimately excluded every item that was found. In this situation, the template, will instead render a plain-text message that nothing was found. (This error display is used for all display modes, table, list, or inline.) 

{{Perks
|id=IDs are easy to misspell
}}

Yields: No matching Perks found.

Table Examples

Selecting Perks by their IDs

IDs to select are normalized, so you do not need to worry about case. Spelling, spacing, and punctuation must all be correct, however. 

{{Perks
|id=accidental barrels
}}

Is the same as the following: 

{{Perks
|id=Accidental Barrels
}}

Yields:

1 Perk with ID 'accidental barrels'
Name Rarity Description Sources Price
Alt Cor Ord Rel Tra
Over-Diligent Woodworkers Over-Diligent Woodworkers Legendary Some woodworkers just can't stop working. Gain 3 Barrels Barrels for every 10 Planks Planks produced. x Cor x x x 0


You can select multiple Perks this way, by separating multiple IDs by commas. 

{{Perks
|id=Amber for Trader Visit, Trader Interval +25, Trading Packs
}}

Yields:

3 Perks with selected IDs
Name Rarity Description Sources Price
Alt Cor Ord Rel Tra
Bed and Breakfast Bed and Breakfast Epic This time, it's the guild who’s going to pay you, not the other way around. Gain 10 Amber Amber every time a trader arrives. x Cor x x x 0
Trade Contract Trade Contract Rare Traders will arrive 25% quicker. x x Ord Rel Tra 18
Trade Logs Trade Logs Epic Detailed notes on different traders and their wares. Gain 1 additional active trade route slot. Traders will arrive 25% quicker. x Cor Ord x Tra 28


Excluding Perks by their IDs

Likewise, you can exclude specific Perks by listing their IDs. This works with any of the other search criteria below, like name or description or rarity. Similar to selecting by IDs, case does not matter, but spelling, spacing, and punctuation all do matter. 

{{Perks
|id=Accidental Barrels,
    Accidental Jerky,
    Accidental Wine,
    Accidental Crystalized dew,
    Accidental Pigment,
    Accidental Skewers,
    Accidental Oil,
    Accidental Bricks,
    Accidental Lizard
|exclude=accidental lizard
}}

Yields:

8 Perks with selected IDs
Name Rarity Description Sources Price
Alt Cor Ord Rel Tra
Accumulated Dew Accumulated Dew Rare Gain 2 Crystalized Dew Crystalized Dew for every 10 Berries Berries produced. x x x Rel Tra 23
Dual Brewing Tools Dual Brewing Tools Rare A set of specialized alchemical tools. Gain 3 Wine Wine for every 15 Ale Ale produced. x x x Rel Tra 22
Dye Extractor Dye Extractor Epic Gain 5 Dye Dye for every 10 Insects Insects produced. x Cor Ord x x 0
Over-Diligent Woodworkers Over-Diligent Woodworkers Legendary Some woodworkers just can't stop working. Gain 3 Barrels Barrels for every 10 Planks Planks produced. x Cor x x x 0
Repurposed Clay Repurposed Clay Rare Nothing goes to waste. Gain 2 Bricks Bricks for every 10 Pottery Pottery produced. x x Ord x Tra 20
Sahilda's Secret Cookbook Sahilda's Secret Cookbook Epic Top 10 tips on how to cook more efficiently - by Sahilda. Gain 10 Jerky Jerky for every 10 Pie Pie produced. x Cor x Rel Tra 26
Small Press Small Press Epic A useful mill upgrade. Gain 3 Oil Oil for every 10 Flour Flour produced. x Cor x Rel x 0
Zhorg's Secret Ingredient Zhorg's Secret Ingredient Epic A mysterious ingredient discovered by the famous chef and businessman Zhorg. Gain 10 Skewers Skewers for every 10 Pickled Goods Pickled Goods produced. x Cor Ord x x 0

Searching names and descriptions

The following example shows searching the same term in both name and description, but you could search different things in each field or use only one and not the other. As a shorthand, when you want to search for the same thing in both name and description, you can use the search parameter instead. 

{{Perks
|name=blightrot cyst
|description=blightrot cyst
}}

Note this is the same as this: 

{{Perks
|search=blightrot cyst
}}

Yields:

5 Perks named 'blightrot cyst' and mentioning 'blightrot cyst'
Name Rarity Description Sources Price
Alt Cor Ord Rel Tra
Baptism of Fire Baptism of Fire Legendary Every 3 burnt Blightrot Cysts lowers Hostility by 10. While the Hearth is corrupted, you’re unable to sacrifice resources. x Cor x x x 0
Blight Filter Blight Filter Legendary A crystalline filter designed to mitigate the negative environmental impact of infused rainwater. Blightrot Cysts appear 50% slower when using rain engines, but Reputation from Resolve is generated 90% slower for the next 2 Reputation Points. x Cor x x x 0
Blightrot Pruner Blightrot Pruner Legendary Blightrot spores aren't technically eggs, but they taste the same. You gain 5 Eggs Eggs when a Blightrot Cyst appears in your settlement. x Cor x x x 0
Burnt to a Crisp Burnt to a Crisp Legendary Gain 20 Coal Coal for every 3 burned Blightrot Cysts. x Cor x Rel x 0
Overexploitation Overexploitation Legendary Global gathering speed is increased by 30%, and newly discovered resource nodes have more charges (+10 charges to small deposits, +25 charges to large deposits). Every 40 node charges used, a Blightrot Cyst will spawn. x Cor x x x 0


Similar to selecting IDs, You can also search for multiple terms in names and descriptions by separating additional terms with commas. This allows you to combine Perks into one table that otherwise seem unrelated, and may be easier than selecting all of their IDs.

The results are combined so the number of results increases, like with an or boolean operation, and this cannot be changed. 

{{Perks
|name=mist,ashes
}}

Yields:

2 Perks with specific names
Name Rarity Description Sources Price
Alt Cor Ord Rel Tra
From the Ashes From the Ashes Epic An odd talisman made from the talons of a phoenix. Gain 2 Wildfire Essence Wildfire Essence for every 2 completed Dangerous or Forbidden Glade Events. (except cloned events spawned by fishmen caves and blood flowers) x Cor x x x 0
Mist Piercers Mist Piercers Legendary You are allowed to use the legendary Mist Piercers. With such a rare gift at your disposal, the Queen's expectations are high. The content of glades will be revealed, but each discovered glade increases the Queen’s Impatience by 0.5. x Cor x x x 0

Filtering by rarity or source

Rarity and source are filters, not selectors. If you do not select any Perks by id, name, or description, then the entire list of Perks is returned. If you then specify a rarity or source, the results are then filtered to your selections. For example, if the term you searched for in the description returns 20 Perks, but you only filter to source=trader, then only a few of those Perks that match the description will be displayed, the ones that can be purchased from traders. 

{{Perks
|description=amber
|source=trader
}}

Yields:

2 Perks from Traders and mentioning 'amber'
Name Rarity Description Sources Price
Alt Cor Ord Rel Tra
Blood Price Contract Blood Price Contract Epic A shady, but lucrative deal. Gain 10 Amber Amber every time a villager dies or leaves. x Cor x x Tra 29
Lucky Charm Lucky Charm Rare A strange talisman made from an extremely rare gemstone - blue Amber. Grants 1 additional cornerstone reroll charge. x x x x Tra 20


You can also filter by rarity instead of source. For example, if the term you searched for in the description returns 20 Perks, but you only filter to rarity=Legendary, then only 6 Legendary Perks that match the description will be displayed, the ones with that rarity. 

{{Perks
|description=amber
|rarity=legendary
}}

Yields:

8 Legendary Perks and mentioning 'amber'
Name Rarity Description Sources Price
Alt Cor Ord Rel Tra
Counterfeit Amber Counterfeit Amber Legendary Apparently, there is a technique for extracting crystals similar to Amber from rainwater. Gain 10 Amber Amber every time you use 50 units of water in Rain Engines, but traders will have 1 less perk or blueprint for sale. x Cor x x x 0
Free Samples Free Samples Legendary Gain 1 Parts Parts every time you sell goods worth 25 Amber. x Cor x x x 0
Lumber Tax Lumber Tax Legendary Gain 1 Amber Amber for every 50 Wood Wood produced. x Cor x x x 0
Prosperous Settlement Prosperous Settlement Legendary Gain +1 to Global Resolve every time you sell goods worth 50 Amber Amber, but scouts work 10% slower on Glade Events. x Cor x x x 0
Protected Trade Protected Trade Legendary The forest recedes, as heavily guarded trade caravans pour into the settlement. Hostility is reduced by 15 points every time you sell goods worth 30 Amber, but Complex Food needs grant 1 less Resolve Point. x Cor x x x 0
Queen's Gift Queen's Gift Legendary A mysterious amber orb with a magical flame trapped within. Increases the Ancient Hearth's resistance by 150 for every woodcutter in your settlement. x Cor x x x 0
Stormwalker Tax Stormwalker Tax Legendary A joint venture with the Stormwalker Guild can be very profitable. You gain 15 Amber Amber every time you accept a newcomer group from the Citadel, but you’ll lose all stored Amber upon choosing this cornerstone. x Cor x x x 0
Trade Hub Trade Hub Legendary The settlement is known for being a major trade hub in the region. Gain 1 Reputation Point every time you sell goods worth 60 Amber, but fulfilling Orders awards 50% less Reputation. x Cor x x x 0


In these examples, you can see that filtering by both rarity and source may result in nothing that meets all of your criteria. 

{{Perks
|description=amber
|rarity=legendary
|source=trader
}}

Yields: No matching Perks found.

Hiding rarity

{{Perks
|id=Accidental Barrels
|name=Barrel
|show_rarity=no
}}

Yields:

6 Perks with ID 'Accidental Barrels' and named 'Barrel'
Name Description Sources Price
Alt Cor Ord Rel Tra
Barrel Delivery Line Barrel Delivery Line 5 Barrels Barrels per minute. x x Ord x x 0
Barrel Schematics Barrel Schematics Barrels Barrels (★★) can now be produced in the Lumber Mill and Smithy. x x x Rel x 0
Bigger Barrels Bigger Barrels +2 to Ale Ale production. Gain an additional Ale Ale every yield (from gathering, farming, fishing, or production). x x Ord Rel Tra 15
Bigger Barrels Bigger Barrels +3 to Ale Ale production. Gain an additional Ale Ale every yield (from gathering, farming, fishing, or production). x x x x Tra 24
Bigger Barrels Bigger Barrels +5 to Ale Ale production. Gain an additional Ale Ale every yield (from gathering, farming, fishing, or production). x x Ord x x 0
Over-Diligent Woodworkers Over-Diligent Woodworkers Some woodworkers just can't stop working. Gain 3 Barrels Barrels for every 10 Planks Planks produced. x Cor x x x 0

Hiding descriptions

{{Perks
|id=Accidental Barrels
|name=Barrel
|show_description=no
}}

Yields:

6 Perks with ID 'Accidental Barrels' and named 'Barrel'
Name Rarity Sources Price
Alt Cor Ord Rel Tra
Barrel Delivery Line Barrel Delivery Line Epic x x Ord x x 0
Barrel Schematics Barrel Schematics Rare x x x Rel x 0
Bigger Barrels Bigger Barrels Uncommon x x Ord Rel Tra 15
Bigger Barrels Bigger Barrels Rare x x x x Tra 24
Bigger Barrels Bigger Barrels Epic x x Ord x x 0
Over-Diligent Woodworkers Over-Diligent Woodworkers Legendary x Cor x x x 0

Skipping source columns

Compare the following table with the one above. If the sources are not as relevant to your purposes, but the descriptions are (and they usually are), then you may want to skip the entire section of the table on sources with skip_sources=skip. 

{{Perks
|id=Accidental Barrels
|name=Barrel
|skip_sources=skip
}}

Yields:

6 Perks with ID 'Accidental Barrels' and named 'Barrel'
Name Rarity Description Price
Barrel Delivery Line Barrel Delivery Line Epic 5 Barrels Barrels per minute. 0
Barrel Schematics Barrel Schematics Rare Barrels Barrels (★★) can now be produced in the Lumber Mill and Smithy. 0
Bigger Barrels Bigger Barrels Uncommon +2 to Ale Ale production. Gain an additional Ale Ale every yield (from gathering, farming, fishing, or production). 15
Bigger Barrels Bigger Barrels Rare +3 to Ale Ale production. Gain an additional Ale Ale every yield (from gathering, farming, fishing, or production). 24
Bigger Barrels Bigger Barrels Epic +5 to Ale Ale production. Gain an additional Ale Ale every yield (from gathering, farming, fishing, or production). 0
Over-Diligent Woodworkers Over-Diligent Woodworkers Legendary Some woodworkers just can't stop working. Gain 3 Barrels Barrels for every 10 Planks Planks produced. 0


You can also skip individual columns. For example, none of the following "Delivery Line" Perks are available from the Forsaken Altar or from traders, so we can safely hide those columns without hiding valuable information from the reader. 

{{Perks
|name=delivery line
|show_source_altar=no
|show_source_trader=no
}}

Yields:

26 Perks named 'delivery line'
Name Rarity Description Sources Price
Cor Ord Rel
Ale Delivery Line Ale Delivery Line Epic 5 Ale Ale per minute. x Ord Rel 0
Barrel Delivery Line Barrel Delivery Line Epic 5 Barrels Barrels per minute. x Ord x 0
Biscuit Delivery Line Biscuit Delivery Line Epic 5 Biscuits Biscuits per minute. x Ord x 0
Clay Delivery Line Clay Delivery Line Epic 3 Clay Clay per minute. Cor x x 0
Clay Delivery Line Clay Delivery Line Epic 5 Clay Clay per minute. x Ord x 0
Coal Delivery Line Coal Delivery Line Epic 5 Coal Coal per minute. x Ord x 0
Coat Delivery Line Coat Delivery Line Epic 5 Coats Coats per minute. x Ord x 0
Fiber Delivery Line Fiber Delivery Line Epic 3 Plant Fiber Plant Fiber per minute. Cor x x 0
Fish Delivery Line Fish Delivery Line Epic 5 Fish Fish per minute. x Ord x 0
Grain Delivery Line Grain Delivery Line Epic 3 Grain Grain per minute. Cor x x 0
Grain Delivery Line Grain Delivery Line Epic 5 Grain Grain per minute. x Ord x 0
Herb Delivery Line Herb Delivery Line Epic 5 Herbs Herbs per minute. x Ord x 0
Incense Delivery Line Incense Delivery Line Epic 5 Incense Incense per minute. x Ord x 0
Insect Delivery Line Insect Delivery Line Epic 5 Insects Insects per minute. x Ord x 0
Meat Delivery Line Meat Delivery Line Epic 5 Meat Meat per minute. x Ord x 0
Metal Delivery Line Metal Delivery Line Epic 4 Copper Bars Copper Bars per minute. x Ord x 0
Mushroom Delivery Line Mushroom Delivery Line Epic 5 Mushrooms Mushrooms per minute. x Ord x 0
Oil Delivery Line Oil Delivery Line Epic 5 Oil Oil per minute. x Ord Rel 0
Pickled Goods Delivery Line Pickled Goods Delivery Line Epic 5 Pickled Goods Pickled Goods per minute. x Ord x 0
Pottery Delivery Line Pottery Delivery Line Epic 5 Pottery Pottery per minute. x Ord x 0
Reed Delivery Line Reed Delivery Line Epic 5 Reed Reed per minute. x Ord x 0
Root Delivery Line Root Delivery Line Epic 3 Roots Roots per minute. Cor x x 0
Root Delivery Line Root Delivery Line Epic 5 Roots Roots per minute. x Ord x 0
Stone Delivery Line Stone Delivery Line Epic 5 Stone Stone per minute. x Ord x 0
Tea Delivery Line Tea Delivery Line Epic 5 Tea Tea per minute. x Ord x 0
Training Gear Delivery Line Training Gear Delivery Line Epic 5 Training Gear Training Gear per minute. x Ord x 0

Hiding prices

When hiding the trader source column, it's probably also a good idea to hide prices, but this is not enforced. 

{{Perks
|name=delivery line
|show_source_altar=no
|show_source_trader=no
|show_price=no
}}

Yields:

26 Perks named 'delivery line'
Name Rarity Description Sources
Cor Ord Rel
Ale Delivery Line Ale Delivery Line Epic 5 Ale Ale per minute. x Ord Rel
Barrel Delivery Line Barrel Delivery Line Epic 5 Barrels Barrels per minute. x Ord x
Biscuit Delivery Line Biscuit Delivery Line Epic 5 Biscuits Biscuits per minute. x Ord x
Clay Delivery Line Clay Delivery Line Epic 3 Clay Clay per minute. Cor x x
Clay Delivery Line Clay Delivery Line Epic 5 Clay Clay per minute. x Ord x
Coal Delivery Line Coal Delivery Line Epic 5 Coal Coal per minute. x Ord x
Coat Delivery Line Coat Delivery Line Epic 5 Coats Coats per minute. x Ord x
Fiber Delivery Line Fiber Delivery Line Epic 3 Plant Fiber Plant Fiber per minute. Cor x x
Fish Delivery Line Fish Delivery Line Epic 5 Fish Fish per minute. x Ord x
Grain Delivery Line Grain Delivery Line Epic 3 Grain Grain per minute. Cor x x
Grain Delivery Line Grain Delivery Line Epic 5 Grain Grain per minute. x Ord x
Herb Delivery Line Herb Delivery Line Epic 5 Herbs Herbs per minute. x Ord x
Incense Delivery Line Incense Delivery Line Epic 5 Incense Incense per minute. x Ord x
Insect Delivery Line Insect Delivery Line Epic 5 Insects Insects per minute. x Ord x
Meat Delivery Line Meat Delivery Line Epic 5 Meat Meat per minute. x Ord x
Metal Delivery Line Metal Delivery Line Epic 4 Copper Bars Copper Bars per minute. x Ord x
Mushroom Delivery Line Mushroom Delivery Line Epic 5 Mushrooms Mushrooms per minute. x Ord x
Oil Delivery Line Oil Delivery Line Epic 5 Oil Oil per minute. x Ord Rel
Pickled Goods Delivery Line Pickled Goods Delivery Line Epic 5 Pickled Goods Pickled Goods per minute. x Ord x
Pottery Delivery Line Pottery Delivery Line Epic 5 Pottery Pottery per minute. x Ord x
Reed Delivery Line Reed Delivery Line Epic 5 Reed Reed per minute. x Ord x
Root Delivery Line Root Delivery Line Epic 3 Roots Roots per minute. Cor x x
Root Delivery Line Root Delivery Line Epic 5 Roots Roots per minute. x Ord x
Stone Delivery Line Stone Delivery Line Epic 5 Stone Stone per minute. x Ord x
Tea Delivery Line Tea Delivery Line Epic 5 Tea Tea per minute. x Ord x
Training Gear Delivery Line Training Gear Delivery Line Epic 5 Training Gear Training Gear per minute. x Ord x

Showing Perk ID

When you need to show the ID, remember that the table can get very wide. If showing IDs, consider carefully whether you need to show all of the other columns. 

{{Perks
|id=Accidental Barrels
|name=Barrel
|show_id=show
}}

Yields:

6 Perks with ID 'Accidental Barrels' and named 'Barrel'
ID Name Rarity Description Sources Price
Alt Cor Ord Rel Tra
Barrels 5pm Barrel Delivery Line Barrel Delivery Line Epic 5 Barrels Barrels per minute. x x Ord x x 0
Barrel Recipes Barrel Schematics Barrel Schematics Rare Barrels Barrels (★★) can now be produced in the Lumber Mill and Smithy. x x x Rel x 0
Ale +2 Bigger Barrels Bigger Barrels Uncommon +2 to Ale Ale production. Gain an additional Ale Ale every yield (from gathering, farming, fishing, or production). x x Ord Rel Tra 15
Ale +3 Bigger Barrels Bigger Barrels Rare +3 to Ale Ale production. Gain an additional Ale Ale every yield (from gathering, farming, fishing, or production). x x x x Tra 24
Ale +5 Bigger Barrels Bigger Barrels Epic +5 to Ale Ale production. Gain an additional Ale Ale every yield (from gathering, farming, fishing, or production). x x Ord x x 0
Accidental Barrels Over-Diligent Woodworkers Over-Diligent Woodworkers Legendary Some woodworkers just can't stop working. Gain 3 Barrels Barrels for every 10 Planks Planks produced. x Cor x x x 0

Custom caption

{{Perks
|caption=Every Uncommon Perk in the game
|rarity=uncommon
|show_rarity=no
|show_source_altar=no
|show_source_cornerstone=no
}}

Yields:

Every Uncommon Perk in the game
Name Description Sources Price
Ord Rel Tra
Advanced Coopering Advanced Coopering +2 to Barrels Barrels production. Gain an additional Barrels Barrels every yield (from gathering, farming, fishing, or production). Ord Rel Tra 16
Advanced Filters Advanced Filters +2 to Wine Wine production. Gain an additional Wine Wine every yield (from gathering, farming, fishing, or production). Ord Rel x 0
Advanced Leatherworking Advanced Leatherworking +2 to Waterskins Waterskins production. Gain an additional Waterskins Waterskins every yield (from gathering, farming, fishing, or production). Ord Rel x 0
Advanced Press Advanced Press +2 to Scrolls Scrolls production. Gain an additional Scrolls Scrolls every yield (from gathering, farming, fishing, or production). Ord x Tra 22
Advanced Smelting Advanced Smelting +2 to Copper Bars Copper Bars production. Gain an additional Copper Bars Copper Bars every yield (from gathering, farming, fishing, or production). Ord Rel Tra 17
Ancient Sewing Technique Ancient Sewing Technique +2 to Coats Coats production. Gain an additional Coats Coats every yield (from gathering, farming, fishing, or production). Ord Rel Tra 18
Ancient Stabilizer Ancient Stabilizer The Ancient Hearth's resistance to corruption is increased by 100. Ord x x 0
Beneficial Agreement Beneficial Agreement Traders will arrive 15% quicker. Ord Rel Tra 14
Big Phials Big Phials +2 to Dye Dye production. Gain an additional Dye Dye every yield (from gathering, farming, fishing, or production). x Rel Tra 16
Bigger Barrels Bigger Barrels +2 to Ale Ale production. Gain an additional Ale Ale every yield (from gathering, farming, fishing, or production). Ord Rel Tra 15
Bigger Grill Bigger Grill +2 to Skewers Skewers production. Gain an additional Skewers Skewers every yield (from gathering, farming, fishing, or production). x Rel x 0
Bigger Ovens Bigger Ovens +2 to Pie Pie production. Gain an additional Pie Pie every yield (from gathering, farming, fishing, or production). Ord x x 0
Bigger Pans Bigger Pans +2 to Biscuits Biscuits production. Gain an additional Biscuits Biscuits every yield (from gathering, farming, fishing, or production). Ord x x 0
Builder's Pack Builder's Pack Any Builder can carry 5 additional items. Ord Rel x 0
Enhanced Blueprints Enhanced Blueprints Builders construct buildings 50% faster. x x Tra 12
Farmer's Pack Farmer's Pack Any Farmer can carry 5 additional items. Ord x Tra 16
Fertilizer Fertilizer Planting crops is 30% faster. x Rel x 0
Heavy Millstone Heavy Millstone +2 to Flour Flour production. Gain an additional Flour Flour every yield (from gathering, farming, fishing, or production). Ord Rel Tra 16
Heavy Press Heavy Press +1 to Oil Oil production. Gain an additional Oil Oil every yield (from gathering, farming, fishing, or production). Ord x Tra 14
Heavy Press Heavy Press +2 to Oil Oil production. Gain an additional Oil Oil every yield (from gathering, farming, fishing, or production). Ord Rel x 0
Industrialized Farming Industrialized Farming +1 to Pack of Crops Pack of Crops production. Gain an additional Pack of Crops Pack of Crops every yield (from gathering, farming, fishing, or production). Ord x x 0
Light Timber Light Timber Any Woodcutter can carry 5 additional items. x Rel x 0
Lucky Talisman Lucky Talisman A necklace made out of tiny bones. Scouts work 10% faster on Glade Events. x x Tra 14
Obsidian Sickles Obsidian Sickles Harvesting crops is 25% faster. Ord Rel Tra 12
Orderly Storage Orderly Storage All buildings have their storage capacity increased by 10. x x Tra 12
Pickle Jars Pickle Jars +2 to Pickled Goods Pickled Goods production. Gain an additional Pickled Goods Pickled Goods every yield (from gathering, farming, fishing, or production). Ord x x 0
Puffed Grain Puffed Grain +2 to Porridge Porridge production. Gain an additional Porridge Porridge every yield (from gathering, farming, fishing, or production). Ord x Tra 18
Puffed Grain Puffed Grain +3 to Porridge Porridge production. Gain an additional Porridge Porridge every yield (from gathering, farming, fishing, or production). Ord x x 0
Rain-Powered Pottery Wheel Rain-Powered Pottery Wheel +2 to Pottery Pottery production. Gain an additional Pottery Pottery every yield (from gathering, farming, fishing, or production). Ord Rel Tra 14.4
Rainwater Condenser Rainwater Condenser +1 to Storm Water Storm Water production. Gain an additional Storm Water Storm Water every yield (from gathering, farming, fishing, or production). Ord x x 0
Reinforced Axes Reinforced Axes Woodcutting is a lot easier. Woodcutters' Camp production is 15% quicker. Ord Rel Tra 12
Reinforced Brick Mold Reinforced Brick Mold +1 to Bricks Bricks production. Gain an additional Bricks Bricks every yield (from gathering, farming, fishing, or production). Ord Rel x 0
Reinforced Needles Reinforced Needles +1 to Fabric Fabric production. Gain an additional Fabric Fabric every yield (from gathering, farming, fishing, or production). Ord Rel x 0
Reinforced Saw Blades Reinforced Saw Blades +1 to Planks Planks production. Gain an additional Planks Planks every yield (from gathering, farming, fishing, or production). Ord Rel x 0
Salted Jerky Salted Jerky +2 to Jerky Jerky production. Gain an additional Jerky Jerky every yield (from gathering, farming, fishing, or production). Ord Rel x 0
Scout's Pack Scout's Pack Workers assigned to Glade Events can carry 5 more items. Ord Rel Tra 16
Scout's Toolbox Scout's Toolbox Scouts can open chests 40% faster. x x Tra 14
Seed Pouch Seed Pouch Planting crops is 25% faster. Ord x Tra 12
Seized Inheritance Seized Inheritance The property of the deceased is seized for the benefit of the whole settlement. Gain 20 random goods every time a villager dies. Ord x x 0
Shoe Mold Shoe Mold +2 to Boots Boots production. Gain an additional Boots Boots every yield (from gathering, farming, fishing, or production). Ord x Tra 14.4
Shovels Shovels Useful tools for creating drainage ditches. Villagers move 10% faster on roads. Ord Rel Tra 12
Stamping Die Stamping Die +1 to Pipes Pipes production. Gain an additional Pipes Pipes every yield (from gathering, farming, fishing, or production). Ord x x 0
Steel Grater Steel Grater +2 to Paste Paste production. Gain an additional Paste Paste every yield (from gathering, farming, fishing, or production). Ord x Tra 14
Tea Infuser Tea Infuser +2 to Tea Tea production. Gain an additional Tea Tea every yield (from gathering, farming, fishing, or production). Ord Rel Tra 18
Vessel of Incense Vessel of Incense +2 to Incense Incense production. Gain an additional Incense Incense every yield (from gathering, farming, fishing, or production). Ord Rel Tra 12
Woodworking Tools Woodworking Tools +2 to Training Gear Training Gear production. Gain an additional Training Gear Training Gear every yield (from gathering, farming, fishing, or production). Ord Rel x 0

List Examples

Bulleted

This example reproduces the table above, when searching by id and name, in a list format. 

{{Perks
|id=Accidental Barrels
|name=barrel
|display=list
}}

Yields:

Numbered

{{Perks
|id=Accidental Barrels
|name=barrel
|display=list
|list_type=number
}}

Yields:

  1. Barrel Delivery Line
  2. Barrel Schematics
  3. Bigger Barrels
  4. Bigger Barrels
  5. Bigger Barrels
  6. Over-Diligent Woodworkers

List with IDs

{{Perks
|id=Accidental Barrels
|name=barrel
|display=list
|show_id=show
}}

Yields:

Inline examples

{{Perks|id=Accidental Barrels|display=inline}}

Yields the following, shown in the middle of a paragraph to highlight its usefulness. When you lack any kind of vessel, look for Over-Diligent Woodworkers to get some for free every time you make Planks! 

{{Perks|id=Accidental Barrels|display=inline|show_id}}

You can also show the ID of the Perk alongside the link, like Over-Diligent Woodworkers ('Accidental Barrels'), if your readers need to see it too.

View

The functionality of the Perks template is accomplished through the Wiki data model. This Template:Perks calls the controller module, which in turn interfaces with the data model module. It also interfaces with the view module for the table or calls a template to display the list version.

Only the last, List/item, is called from the controller. All others are still here in the off chance they may be useful to an author for manually creating tables of perks. However, it is strongly recommended to learn how to use Template:Perks instead. The table version of the view is accomplished with Module:PerksView, which cannot be invoked directly, but is invoked by Module:PerksController.

Related templates
Template Purpose
Template:PerksCornerstonesTable Primary, default table header template
Template:PerksCornerstonesTable/row Default table row template
Template:PerksCornerstonesTable/end Table markup closing
Template:PerksCornerstonesTable/SkipSources Table header template, but without the sources columns
Template:PerksCornerstonesTable/row/SkipSources Table row template, but without the sources columns
Template:PerksCornerstonesList/item List version row template (there is no list header template)
Retrieved from "https://hoodedhorse.com/wiki/Against_the_Storm/index.php?title=Template:Perks/doc&oldid=8634"