Template:Perks/doc

From Against the Storm Official Wiki
< Template:Perks
Revision as of 04:24, 5 May 2024 by Aeredor (talk | contribs) (Created to provide some documentation for these templates)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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 Searches names for this string, and adds Perks with any part of their names matching that string to the table.
description Searches descriptions for this string, and adds Perks with any part of their descriptions matching that string to the table.
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, the table layout will

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.

Work in progress

1 Perk with ID 'Fedora Hat'
Name Rarity Description Sources Price
Old Fedora Hat 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). 0

Errors