Template:Stormforged Cornerstones/doc

From Against the Storm Official Wiki
< Template:Stormforged Cornerstones
Revision as of 22:03, 2 May 2024 by Aeredor (talk | contribs) (Added template list to the bottom)

Overview

Displays data about all Stormforged Cornerstones or a subset of them based on search parameters and exclusions. There are a few ways the data can be displayed. It is not possible to include regular (non-Stormforged) Cornerstones in the results.

Parameters

All parameters are optional. If no parameters are given, a table of all Stormforged Cornerstones will be displayed.

Selection and Exclusion

You may combine the first four parameters to return more Cornerstones. The result will be the union of your selections, without duplicates. Then use exclude to remove any Cornerstones that are unrelated to your purposes with their ids.

Remember that ids are not visible in the game, so you may need to look them up.

Parameter Description
id A list of IDs of Stormforged Cornerstones, separated by commas. Since IDs are unique, each matched ID adds exactly one Cornerstone to the table. Will not throw an error if an ID is invalid.
name Searches names for this string, and adds Cornerstones with any part of their names matching that string to the table.
description Searches descriptions for this string, and adds Cornerstones with any part of their descriptions matching that string to the table.
upgrades_from_id The regular Cornerstone with this id may be upgraded into a Stormforged Cornerstone, which will be selected to display in the table. If there is a match, adds one Stormforged Cornerstone (not the regular version) with that id to the table, since ids are unique.
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 Description
caption If you want to override the default caption for the table, you can specify it here.
skip_prices Use skip_prices=skip if you want a table with fewer columns that only lists the icons, names, and their descriptions--without their prices at the Forsaken Altar.
show_regular Use show_regular=show if you want to add a last column to the table that shows the regular version that each Cornerstone is upgraded from, if any.
display For use when including these Cornerstones inside other tables or within paragraphs, the display parameter condenses the output to just the links to the pages on each Cornerstone:
  • Use display=list to convert the table layout into a basic list. Only the standard links will show, and with small icons.
  • Use display=inline to convert the table into an inline list of links, without icons.
list_type When displaying as a list instead of a table, you can specify list_type=number to show the list as a numbered list instead of the default, list_type=bullet.

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, asked for a search term that was not present in any name or description, or excluded every item that was found. In this situation, the template will instead render a plain-text message that nothing was found. (This is the error output regardless of any display overrides.)

{{Stormforged Cornerstones
|id=There is no ID like this
}}

Yields: No matching Stormforged Cornerstones found.

Table Examples

Selecting Cornerstones by their IDs

{{Stormforged Cornerstones
|id=[Altar] Fedora Hat
}}

Yields:

1 Stormforged Cornerstones with ID '[Altar] Fedora Hat'
Name Description Price Price when upgrading
meta resources villagers meta resources villagers
Old Fedora Hat (Stormforged) Old Fedora Hat (Stormforged) "An old inscription on the bottom of the hat says: "Fortune and glory". Increases the chance of doubling event loot by 75% (this doesn't apply to perks and blueprints)." 48 2 48 0



{{Stormforged Cornerstones
|id=[Altar] Fedora Hat, [Altar] Alarm Bells
}}

Yields:

2 Stormforged Cornerstones with selected IDs
Name Description Price Price when upgrading
meta resources villagers meta resources villagers
Alarm Bells (Stormforged) Alarm Bells (Stormforged) The Brass Order's newest invention. All workers have a +10% higher chance of producing double yields for every 100 points of expected corruption per minute in the Ancient Hearth. 48 2 48 0
Old Fedora Hat (Stormforged) Old Fedora Hat (Stormforged) "An old inscription on the bottom of the hat says: "Fortune and glory". Increases the chance of doubling event loot by 75% (this doesn't apply to perks and blueprints)." 48 2 48 0


Selecting by upgrade

Note that the regular versions must be shown to see them in the table. Selecting by the upgrade does not automatically show the extra column in the table.

{{Stormforged Cornerstones
|upgrades_from_id=Fedora Hat
}}

Yields:

1 Stormforged Cornerstones upgraded from 'Fedora Hat'
Name Description Price Price when upgrading
meta resources villagers meta resources villagers
Old Fedora Hat (Stormforged) Old Fedora Hat (Stormforged) "An old inscription on the bottom of the hat says: "Fortune and glory". Increases the chance of doubling event loot by 75% (this doesn't apply to perks and blueprints)." 48 2 48 0


Searching names and descriptions

The following example shows searching the same term in both name and description, but you could use either.

{{Stormforged Cornerstones
|name=trade
|description=trade
}}

Yields:

5 Stormforged Cornerstones named 'trade' and mentioning 'trade'
Name Description Price Price when upgrading
meta resources villagers meta resources villagers
Export Contract (Stormforged) Export Contract (Stormforged) Increases the production yield of packs of goods by +100%. Gain 2 additional active trade route slots. 40 2 40 0
Stormwalker Training (Stormforged) Stormwalker Training (Stormforged) Your villagers learn how to travel the wilderness from the very best - the Royal Stormwalkers. Trade route caravans travel faster by 40%. Traders will arrive 33% quicker. 40 2 40 0
Tightened Belt (Stormforged) Tightened Belt (Stormforged) Travel cost on trade routes is reduced by 3. Doesn't apply to routes already in progress. This effect scales along with the quantity of goods exported. 40 2 40 0
Trade Logs (Stormforged) Trade Logs (Stormforged) Detailed notes on different traders and their wares. Gain 2 additional active trade route slots. Traders will arrive +33% quicker and have +1 more cornerstones on sale. 40 2 40 0
Trade Negotiations (Stormforged) Trade Negotiations (Stormforged) "Trade routes are worth 3 more <sprite name="[valuable] amber"> Amber. Doesn't apply to routes already in progress. This effect scales along with the quantity of goods exported." 40 2 40 0


Skipping Price Columns

Compare the following table with the one above.

{{Stormforged Cornerstones
|name=trade
|description=trade
|skip_prices=skip
}}

Yields:

5 Stormforged Cornerstones named 'trade' and mentioning 'trade'
Name Description
Export Contract (Stormforged) Export Contract (Stormforged) Increases the production yield of packs of goods by +100%. Gain 2 additional active trade route slots.
Stormwalker Training (Stormforged) Stormwalker Training (Stormforged) Your villagers learn how to travel the wilderness from the very best - the Royal Stormwalkers. Trade route caravans travel faster by 40%. Traders will arrive 33% quicker.
Tightened Belt (Stormforged) Tightened Belt (Stormforged) Travel cost on trade routes is reduced by 3. Doesn't apply to routes already in progress. This effect scales along with the quantity of goods exported.
Trade Logs (Stormforged) Trade Logs (Stormforged) Detailed notes on different traders and their wares. Gain 2 additional active trade route slots. Traders will arrive +33% quicker and have +1 more cornerstones on sale.
Trade Negotiations (Stormforged) Trade Negotiations (Stormforged) "Trade routes are worth 3 more <sprite name="[valuable] amber"> Amber. Doesn't apply to routes already in progress. This effect scales along with the quantity of goods exported."


Showing regular versions

Compare the following table with the one above.

{{Stormforged Cornerstones
|upgrades_from_id=Fedora Hat
|show_regular=show
}}

Yields:

1 Stormforged Cornerstones upgraded from 'Fedora Hat'
Name Description Price Price when upgrading Upgrades from
meta resources villagers meta resources villagers
Old Fedora Hat (Stormforged) Old Fedora Hat (Stormforged) "An old inscription on the bottom of the hat says: "Fortune and glory". Increases the chance of doubling event loot by 75% (this doesn't apply to perks and blueprints)." 48 2 48 0 Old Fedora Hat Old Fedora Hat

Custom caption

{{Stormforged Cornerstones
|caption=Every Stormforged Cornerstone in the game
}}

Yields: Lua error in Module:StormforgedController at line 87: attempt to concatenate global 'ERROR_PREFIX_NAME_NOT_FOUND' (a nil value).

List Examples

Bulleted

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

{{Stormforged Cornerstones
|name=trade
|description=trade
|display=list
}}

Yields:

Numbered

{{Stormforged Cornerstones
|name=trade
|description=trade
|display=list
|list_type=number
}}

Yields:

  1. Export Contract (Stormforged)
  2. Stormwalker Training (Stormforged)
  3. Tightened Belt (Stormforged)
  4. Trade Logs (Stormforged)
  5. Trade Negotiations (Stormforged)

Inline Examples

{{Stormforged Cornerstones|name=trade|description=trade|display=inline}}

Yields the following, shown in the middle of a paragraph to highlight its usefulness. When you have a settlement profiting significantly from trading, consider investing in Export Contract (Stormforged), Stormwalker Training (Stormforged), Tightened Belt (Stormforged), Trade Logs (Stormforged), Trade Negotiations (Stormforged) Stormforged Cornerstones. If you can spare the cost, they can save your settlement!

{{Stormforged Cornerstones|upgrades_from_id=Alarm Bells|display=inline}}

Yields the ability to write a reminder that you can upgrade Alarm Bells to Alarm Bells (Stormforged), while only having to look up one ID!

View templates

This functionality is accomplished through the Wiki_data_model. This Template:Stormforged Cornerstones calls the controller module, which in turn interfaces with the data model modules. The view is handled entirely by these additional templates:

Related templates
Template Purpose
Template:StormforgedCornerstonesTable Primary, default table header template
Template:StormforgedCornerstonesTable/row Default table row template
Template:StormforgedCornerstonesTable/SkipPrices Table header template, but without the prices columns
Template:StormforgedCornerstonesTable/row/SkipPrices Table row template, but without the prices columns
Template:StormforgedCornerstonesList/item List version row template (there is no list header template)