Template:Use
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Item name | 1 | The name of the quality being linked used.
| Page | required |
Quantity | 2 | If present, the quantity will be unlinked, in-between the image icon and the quality link.
| Line | optional |
Use type | Type | How the quality is used. Should be either Text or Math.
| Line | suggested |
Image file name | Image | The filename of the image used to decorate the link.
| File | optional |
Image size | Size | The size of the displayed image.
| String | optional |
Image link | Link | If present, the image will link to the image file rather than the item. | Boolean | optional |
Link appearance | Appearance | If present, will change the anchor text of the link.
| Line | optional |
Short | Short | If present, will shorten the default anchor text by removing everything before the first colon. Overridden by the Appearance parameter.
| Line | optional |