Template:Building link/doc: Difference between revisions

From Against the Storm Official Wiki
m (→‎Output overrides: simplifying descriptions; moving note out of table to bottom of section)
m (→‎Other examples: reordering examples within this section)
 
Line 74: Line 74:


{{Building link|Ranch|s}}
{{Building link|Ranch|s}}
<pre>{{Building link|Trappers' Camp|s|size=gigantic}}</pre>
Specifying an icon size that is not recognized does not return an error. Instead, the default medium-sized icon is used:
{{Building link|Trappers' Camp|s|size=gigantic}}




Line 94: Line 88:
* {{Building link|Smithy|s|size=none}}
* {{Building link|Smithy|s|size=none}}
* {{Building link|Tinctury|s|size=none}}
* {{Building link|Tinctury|s|size=none}}
<pre>{{Building link|Trappers' Camp|s|size=gigantic}}</pre>
Specifying an icon size that is not recognized does not return an error. Instead, the default medium-sized icon is used:
{{Building link|Trappers' Camp|s|size=gigantic}}


=== Errors ===
=== Errors ===

Latest revision as of 03:43, 15 October 2024

Overview

Creates a link to a building's page.

A shortcut template exists for this template, Template:bl. You can use {{bl}} instead of {{Building link}} with the same parameters.

Parameters

Building

The name of the building is the only required parameter. Use the name as it appears in-game, including apostrophes (for example, the Woodcutters' Camp—not Woodcutter's Camp). A missing or mispelled (or mis-punctuated) building name will result in an error.

If you do not wish to write the code name=, you may skip that, but you must specify the name of the building before any other parameters.

Parameter Type Description
name string The name of the building, as it appears in the game.

Output overrides

All of these parameters are optional and change how the link is formatted.

Parameter Type Description
size string The size of the icon to display. Choose one of the following:
  • none
  • small
  • medium
  • large
  • huge

The default for buildings is medium, which is larger than line heights in paragraphs but is large enough to be recognizable.

display string If you include display=notext only the icon will be rendered. There are currently no other options for this parameter.
unnamed parameter string Including this formats the link with the plural name of the building. You may use either s or es to append it to the end of the link in a highly readable way, like this: {{bl|Cookhouse|s}}.

Building links that are written into paragraphs should use either no icon or a small icon, neither of which is the default. The small icon for buildings is not recognizable (compared to species, resources, or specializations). Avoid it unless necessary, but it is available in case it is needed.

Note that adding "s" after the template call no longer includes the "s" in the link as it used to.

Examples

Basic usage

{{Building link|Ranch}}

Yields a suitably sized icon for recognition and use in tables:

Ranch Ranch


{{Building link|Trapper's Camp|size=none}}

Skips the icon, like in Trappers' Camp so it's easy to flow into paragraphs about villagers trapping and gathering things. The small version of building icons isn't very recognizable, as you can see in Trappers' Camp Trappers' Camp so no icon is strongly advised.


{{Building link|name=Ranch|large}}

Yields a larger icon for great recognition:

Ranch Ranch


{{Building link|Ranch|size=huge}}

Yields the largest icon, which is great for headlining tables about this building:

Ranch Ranch

Other examples

{{Building link|Ranch|s}}

Formats the link so the name appears plural, but still links to the correct page (hover to see tooltip, or click):

Ranch Ranches


{{Building link|Apothecary|s|size=none}}

Mentioning how important Apothecaries are to your villagers does format the building name correctly as plural. The pages for the names of buildings ending in -y when plural like the Breweries have already been created as redirect pages, so you may use them freely:


{{Building link|Trappers' Camp|s|size=gigantic}}

Specifying an icon size that is not recognized does not return an error. Instead, the default medium-sized icon is used:

Trappers' Camp Trappers' Camps

Errors

The following are error messages generated by calling the template incorrectly.

{{Building link}}

With no arguments: Lua error in Module:BuildingLink at line 56: No building found with name: . Please see the template documentation for how to use the parameters.

{{Building link|Library}}

Naming a building that doesn't exist in the game: Lua error in Module:BuildingLink at line 56: No building found with name: Library. Please see the template documentation for how to use the parameters.