Template:Use/doc

From Fallen London Wiki

This template is for the in-line inclusion of qualities on pages where the quality is used for

  • locking or unlocking storylets/branches;
  • determining the level of some other quality by means of some formula;
  • procedurally varying the flavour text, depending on quality values.

In addition to formatting the quality to display with an image and a link, correct categories are also added to the page.

This template uses the same arguments as {{IL}} - please refer to that page for detailed documentation. In addition this template takes one more argument: Type:

  • {{Use|Shard of Glim}} - This adds the normal category for the quality. This is equivalent to {{Unlock|Shard of Glim}} (but may also be used in the "Locked with" field of some templates to avoid counter-intuitive dissonance.
  • {{Use|Shard of Glim|Type=Math}} - This should be used if the quality is uses inside a formula. It adds the normal category for the quality but also added the "<Quality Name> Formula Uses" category.
  • {{Use|Shard of Glim|Type=Text}} - This should be uses if the quality has no mechanical impact on the game but rather is used for varying the flavour text in Storylet/Branch/Results description (occasionally, even image files can vary). This does not add the quality to the normal quality category but instead adds the "<Quality Name> Text Uses" category.

This template is for the in-line inclusion of qualities on pages where the quality is used for: locking or unlocking storylets/branches; determining the level of some other quality by means of some formula; procedurally varying the flavour text, depending on quality values. In addition to formatting the quality to display with an image and a link, correct categories are also added to the page.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Item name1

The name of the quality being linked used.

Example
Shard of Glim
Pagerequired
Quantity2

If present, the quantity will be unlinked, in-between the image icon and the quality link.

Example
30 x
Lineoptional
Use typeType

How the quality is used. Should be either Text or Math.

Example
Text
Linesuggested
Image file nameImage

The filename of the image used to decorate the link.

Default
The image name is looked up in the mapping in Module:IL/images. If not present, displays question.png.
Example
Door.png
Fileoptional
Image sizeSize

The size of the displayed image.

Default
20px
Example
30px
Stringoptional
Image linkLink

If present, the image will link to the image file rather than the item.

Booleanoptional
Link appearanceAppearance

If present, will change the anchor text of the link.

Default
If this parameter is not present, then the anchor text will be the item name.
Example
''Sneaky''
Lineoptional
ShortShort

If present, will shorten the default anchor text by removing everything before the first colon. Overridden by the Appearance parameter.

Example
yes
Lineoptional