Template:Stormforged Cornerstones/doc
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, showing their icon and name linking to the Cornerstone's page, descriptions, and prices.
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 | Default | Description |
---|---|---|
caption | "Stormforged Cornerstones" | If you want to override the default caption for the table, you can specify it here. |
skip_prices | not skipped | 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. This breaks from the naming convention of the other parameters because the template logic is different.
|
show_id | hidden | Use show_id=show if you want to show a first column in the table that shows the id of the Cornerstone. (In list or inline display, the id is shown in parentheses.)
|
show_description | shown | Use show_description=no if you want to hide the description column from the table. (In list or inline display, the descriptions are never shown.)
|
show_regular | hidden | Use show_regular=show if you want to show a last column in the table that shows the regular version that each Cornerstone is upgraded from, if any. (In list or inline display, the regular versions are never shown.)
|
display | a table | 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:
|
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, 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:
Name | Description | Price | Price when upgrading | ||
---|---|---|---|---|---|
meta resources | villagers | meta resources | villagers | ||
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:
Name | Description | Price | Price when upgrading | ||
---|---|---|---|---|---|
meta resources | villagers | meta resources | villagers | ||
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) | "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:
Name | Description | Price | Price when upgrading | ||
---|---|---|---|---|---|
meta resources | villagers | meta resources | villagers | ||
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:
Name | Description | Price | Price when upgrading | ||
---|---|---|---|---|---|
meta resources | villagers | meta resources | villagers | ||
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) | 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) | 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) | 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 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:
Name | Description |
---|---|
Export Contract (Stormforged) | Increases the production yield of packs of goods by +100%. Gain 2 additional active trade route slots. |
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) | 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) | 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 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 Cornerstone IDs
{{Stormforged Cornerstones |upgrades_from_id=Fedora Hat |show_id=show }}
Yields:
ID | Name | Description | Price | Price when upgrading | ||
---|---|---|---|---|---|---|
meta resources | villagers | meta resources | villagers | |||
'[Altar] Fedora Hat' | 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
|
Hiding descriptions
{{Stormforged Cornerstones |upgrades_from_id=Fedora Hat |show_description=no }}
Yields:
Name | Price | Price when upgrading | ||
---|---|---|---|---|
meta resources | villagers | meta resources | villagers | |
Old Fedora Hat (Stormforged) | 48 | 2 | 48 | 0
|
Showing regular versions
{{Stormforged Cornerstones |upgrades_from_id=Fedora Hat |show_regular=show }}
Yields:
Name | Description | Price | Price when upgrading | Upgrades from | ||
---|---|---|---|---|---|---|
meta resources | villagers | meta resources | villagers | |||
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 |
{{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:
- Export Contract (Stormforged)
- Stormwalker Training (Stormforged)
- Tightened Belt (Stormforged)
- Trade Logs (Stormforged)
- Trade Negotiations (Stormforged)
Numbered
{{Stormforged Cornerstones |name=trade |description=trade |display=list |list_type=number }}
Yields:
- Export Contract (Stormforged)
- Stormwalker Training (Stormforged)
- Tightened Belt (Stormforged)
- Trade Logs (Stormforged)
- Trade Negotiations (Stormforged)
List with IDs
{{Stormforged Cornerstones |name=trade |description=trade |display=list |show_id=show }}
Yields:
- Export Contract (Stormforged) ('[Altar] PacksForResolveRep')
- Stormwalker Training (Stormforged) ('[Altar] Route Less Travel Time')
- Tightened Belt (Stormforged) ('[Altar] Trade Routes Bonus Fuel')
- Trade Logs (Stormforged) ('[Altar] Trading Packs')
- Trade Negotiations (Stormforged) ('[Altar] More Amber from Routes')
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|show_id=show}}
Yields the ability to write a reminder that you can upgrade Alarm Bells to Alarm Bells (Stormforged) ('[Altar] Alarm Bells'), 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:
Template | Purpose |
---|---|
Template:StormforgedCornerstonesTable | Primary, default table header template |
Template:StormforgedCornerstonesTable/row | Default table row template |
Template:StormforgedCornerstonesTable/end | Table markup closing |
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) |