Template:PerkSearch: Difference between revisions
(Updated with a note about the search term e) |
m (→= With unique ID: fixed title) |
||
Line 39: | Line 39: | ||
== Examples == | == Examples == | ||
=== With unique ID == | === With unique ID === | ||
To display one perk when you know it's unique ID, you can call the template directly, using an unnamed parameter, and it will be interpreted the same as if you wrote <code>id=</code> | To display one perk when you know it's unique ID, you can call the template directly, using an unnamed parameter, and it will be interpreted the same as if you wrote <code>id=</code> | ||
Line 96: | Line 96: | ||
Because of this search capability, a search term of ''e'' (as of version 0.63 with no expected changes for 1.0) will return every perk, because only the perk Storm Shield does ''not'' have an ''e'' in its description, but it does in its name. See [[Perks]] to see the result. | Because of this search capability, a search term of ''e'' (as of version 0.63 with no expected changes for 1.0) will return every perk, because only the perk Storm Shield does ''not'' have an ''e'' in its description, but it does in its name. See [[Perks]] to see the result. | ||
== Errors == | == Errors == |
Revision as of 04:32, 13 December 2023
Generates a table showing perks. Use this wherever you need to show one or more Perks or Cornerstones. Does not include Forest Mystery effects or penalties from Glade Events.
Overview
Create a concise, sortable table using game data to show perks. The table shows the name of the perk, its icon, with a colored border similar to the in-game border corresponding to rarity, spells out the rarity (so it can be sorted on), its in-game long description of its effect, and where to find it.
The name of the perk displayed links to its page on the wiki.
Parameters
The template has three modes: ID mode, name mode, and search mode. When using search mode, you can specify the search term and, if needed, filter on a particular source or rarity.
Parameter | string | Description |
---|---|---|
id | string | The unique identifier of a perk. If you specify the id, you get a table with exactly that one perk. |
name | string | The name of one or more perks. Perks with similar effects but that differ in their magnitude share names. (For example, "Nets" can be +1 or +2 to Meat.) If you specify the name, you get a table with one or several perks with that name. |
search | string | A case-insensitive simple string match. If you specify a search term, you get a table with one or many perks whose names or descriptions contain that text. |
source | string | See below for options. Filters the search results to only show perks from this source. Has no effect if you specify id or name. |
rarity | string | See below for options. Filters the search results to only show perks of this rarity. Has no effect if you specify id or name. |
display | "list" | If display=list is present at the end of the template call, it overrides the default use of a wikitable to display the recipe. Instead, it will produce a list of perks' names and small icons, each on their own line, without any additional information. Useful for populating larger tables or between paragraphs where displaying the entire recipe isn't relevant.
|
Examples
With unique ID
To display one perk when you know it's unique ID, you can call the template directly, using an unnamed parameter, and it will be interpreted the same as if you wrote id=
{{PerkSearch|Fedora Hat}}
Yields:
Perk | Rarity | Description | Source(s) |
---|---|---|---|
Old Fedora Hat | Legendary | "An old inscription on the bottom of the hat says: "Fortune and glory". Increases the chance of doubling event loot by 50% (this doesn't apply to perks and blueprints)." |
|
With a name
Several perks can have the same name, but will have different modifier values. You'll see several perks in the table.
{{PerkSearch|name=Bigger Barrels}}
Yields:
Perk | Rarity | Description | Source(s) | Price |
---|---|---|---|---|
Bigger Barrels | Uncommon | "+2 to <sprite name="[needs] ale"> Ale production. Gain an additional <sprite name="[needs] ale"> Ale every yield (from gathering, farming, fishing, or production)." |
| 15 |
Bigger Barrels | Rare | "+3 to <sprite name="[needs] ale"> Ale production. Gain an additional <sprite name="[needs] ale"> Ale every yield (from gathering, farming, fishing, or production)." |
| 24 |
Bigger Barrels | Epic | "+5 to <sprite name="[needs] ale"> Ale production. Gain an additional <sprite name="[needs] ale"> Ale every yield (from gathering, farming, fishing, or production)." |
| — |
With a search term
You can search all the text in the names and descriptions and get all of the perks that match. This is useful when finding perks "related" to something, like a resource or a building. You might get a long table back!
{{PerkSearch|search=Biscuits}}
Yields:
Perk | Rarity | Description | Source(s) | Price |
---|---|---|---|---|
Bigger Pans | Uncommon | "+2 to <sprite name="[food processed] biscuits"> Biscuits production. Gain an additional <sprite name="[food processed] biscuits"> Biscuits every yield (from gathering, farming, fishing, or production)." |
| — |
Biscuit Recipes | Rare | "<sprite name="[food processed] biscuits"> Biscuits (<sprite name=grade3>) can now be produced in the Kiln and Rain Mill." |
| 22 |
Bigger Pans | Rare | "+3 to <sprite name="[food processed] biscuits"> Biscuits production. Gain an additional <sprite name="[food processed] biscuits"> Biscuits every yield (from gathering, farming, fishing, or production)." |
| 24 |
Biscuit Delivery Line | Epic | "5 <sprite name="[food processed] biscuits"> Biscuits per minute." |
| — |
Biscuit Diet | Epic | "A farmer's favorite food. Farmers have a +75% chance of producing double yields when under the effect of <sprite name="[food processed] biscuits"> biscuits." |
| — |
Spices | Epic | "<sprite name="[food raw] herbs"> Herb and <sprite name="[food raw] roots"> Root production is increased by +1 for every 75 <sprite name="[food processed] biscuits"> Biscuits produced." |
| — |
You can also add filtering based on the source or the rarity. For example, if you only want Cornerstones that mention vegetables, you can do this:
{{PerkSearch|search=vegetables|source=Cornerstone}}
Perk | Rarity | Description | Source(s) | Price |
---|---|---|---|---|
Giant Vegetables | Epic | "+2 to <sprite name="[food raw] vegetables"> Vegetables production. Gain an additional <sprite name="[food raw] vegetables"> Vegetables every yield (from gathering, farming, fishing, or production)." |
| 26 |
Moss Broccoli Seeds | Epic | "<sprite name="[food raw] vegetables"> Vegetables (<sprite name=grade2>) can now be produced in the Greenhouse." |
| — |
Or if you want only Legendary perks that mention Amber, you can do this too:
{{PerkSearch|search=amber|rarity=Legendary}}
Yields:
Perk | Rarity | Description | Source(s) |
---|---|---|---|
Counterfeit Amber | Legendary | "Apparently, there is a technique for extracting crystals similar to Amber from rainwater. Gain 10 <sprite name="[valuable] amber"> Amber every time you use 50 units of water in Rain Engines, but traders will have 1 less perk or blueprint for sale." |
|
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." |
|
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." |
|
Stormwalker Tax | Legendary | "A joint venture with the Stormwalker Guild can be very profitable. You gain 15 <sprite name="[valuable] amber"> Amber every time you accept a newcomer group from the Citadel, but you’ll lose all stored Amber upon choosing this cornerstone." |
|
Prosperous Settlement | Legendary | "Gain +1 to Global Resolve every time you sell goods worth 50 <sprite name="[valuable] amber"> Amber, but scouts work 10% slower on Glade Events." |
|
Free Samples | Legendary | "Gain 1 <sprite name="[mat processed] parts"> Parts every time you sell goods worth 25 Amber." |
|
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. |
|
Lumber Tax | Legendary | "Gain 1 <sprite name="[valuable] amber"> Amber for every 50 <sprite name="[mat raw] wood"> Wood produced." |
|
Finally, you can combine source and rarity filtering.
{{PerkSearch|search=villager|source=Cornerstone|rarity=Epic}}
Yields:
Perk | Rarity | Description | Source(s) | Price |
---|---|---|---|---|
Blood Price Contract | Epic | "A shady, but lucrative deal. Gain 10 <sprite name="[valuable] amber"> Amber every time a villager dies or leaves." |
| 29 |
Peasant Supplies | Epic | "Receive 3 <sprite name="[packs] pack of provisions"> Pack of Provisions for every new villager." |
| — |
Well-Rested Workers | Epic | Just. The. Right. Amount. Villagers with the leisure need fulfilled have a +25% chance of doubling their yields. |
| — |
Lost in the Wilds | Epic | Gain one villager every time you discover a new glade. |
| — |
Cannibalism | Epic | "Gain 40 <sprite name="[food raw] meat"> Meat every time a villager dies or leaves." |
| — |
Local Taxes | Epic | "Villagers are willing to give you their very last piece of Amber just for a pint of decent ale. Gain 12 <sprite name="[valuable] amber"> Amber for every 50 <sprite name="[needs] ale"> Ale produced." |
| — |
Stormwalker Training | Epic | Your villagers learn how to travel the wilderness from the very best - the Royal Stormwalkers. All trade routes are faster by 40%. |
| — |
Crowded Caravan | Epic | Each newcomer group has 2 additional villagers. |
| — |
Because of this search capability, a search term of e (as of version 0.63 with no expected changes for 1.0) will return every perk, because only the perk Storm Shield does not have an e in its description, but it does in its name. See Perks to see the result.
Errors
If you provide an empty id, name, or search string, the template will return a simple error message.
Unknown parameter in Perk Search template.
If you provide an id or a name that doesn't exist, you'll be told that nothing was found.
No perk found with ID abcdef.
No perk found with name abcdef.
If you provide a search term that returns no results, or apply a filter that results in nothing left, you'll be told that nothing was found.
{{PerkSearch|search=Coats|source=Cornerstone}}
Yields:
No perk found with specified search criteria.