Template:Loss
Error, no item/quality was given.
This template is used for Effects that decreases qualities and items. It replaces the old system, and fully supports both item losses (formerly {{Item Loss}}), and pyramidal qualities (formerly {{Drop}}).
Usage: {{Loss|A|B|<params>}}
- The first parameter is the name of the item or quality.
- The second parameter is the amount gained. Standard formatting is "#" for discrete qualities, "# x" for items, and "-# CP" for pyramidal qualities.
Parameter list
- image, this parameter is used to set a custom image. Its value is the image name to be used, including the .png postfix but without the File: prefix. Please note that this should be the small version of the file (so ending in small.png). Also note that this will now only apply to the image at the front; changing the image of later {{IL}}'s is no longer supported.
- {{{1}}}, ie the first unnamed parameter defines the quality or item that is being decreased, with its value being the full pagename of this quality.
- {{{2}}}, ie the second unnamed parameter defines the amount by which the first unnamed parameter is decreased. Its value is the numerical decreased, including either the x or the CP postfix. Do not use this parameter if one of the following two parameters are used.
- Appearance, this parameter overwrites how the selected quality or item is displayed. Can be use to add italics or change the text entirely.
- occurrence, this parameter is used when the quality change starts with An occurrence. Its value is the new numerical value of the quality.
- to, this parameter is used when the quality change looks like x has dropped to y. Its value is the new numerical value of the quality.
- message, this parameter is used to define a custom message for the quality/item decreased. Note that this will not work if either
|occurrence
orto
are set. - now, this parameter is used to when the action sets a quality/item to a specific level, but doesn't use either
|occurrence
or~to
. Note that unlike those{{{2}}}
and{{{message}}}
do work with this one. - reset, this parameter is used when the quality change looks like x has been reset: a conclusion, or a new beginning?. Its value is either no (default) or yes.
- twist, this parameters is used when the quality change looks like A twist in your tale! You are no longer x. Its value is either no (default) or yes.
- gone, this parameters is used when the quality change looks like Your x Quality has gone. Its value is either no (default) or yes.
- hidden, this parameter is used to define whether the change is hidden or not. If the change is hidden set this to yes, otherwise don't include it.
- nocat, this parameter is used to disable categorisation. If set to yes it will not include Category:X Gain, otherwise don't include it. Note that the SMW Property:Gains will always be set.
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | 1 | The name of the quality/item being lost. | Page | required |
Quantity | 2 | The amount lost by this action, which should either be count of levels for Discrete qualities, or number of Change Points for Pyramidal. | String | required |
Custom appearance | Appearance | If the decreased quality should have custom formatting like italics, this property can be used to overwrite the displayed text. | String | optional |
Custom Message | message | If the quality decrease include a custom message set this parameter to that message | String | optional |
Occurrence! | occurrence | If the game text for the action result begins with "An occurrence!", then set this parameter to the new value of the quality. | String | optional |
Now | now | If the result of the action sets this quality to a specific level, instead of decreasing it, then set this parameter to the new level. Unlike Set to and Occurrence this one will work with Message | String | optional |
Set to | to | If the result of the action sets this quality to a specific level, instead of decreasing it, then set this parameter to the new level (including level description) unless "occurrence" is more appropriate. | String | optional |
Gone | Gone | If the game text for the action result ends with "Quality has gone!", then set this parameter to yes | Boolean | optional |
Resets Quality | Reset Progress Reset | If the game text for the action result ends with "has been reset: a conclusion, or a new beginning!", then set this parameter to yes | Boolean | optional |
Twist | twist | If the game text for the action result begins with "A twist in your tale", then set this parameter to the name of the quality/item being lost. Disables all other parameters | Page | optional |
Image filename | image | Changes the image link displayed before the text.
| File | optional |
No category | nocat | Setting this parameter to yes will disable categorisation. | Boolean | optional |
Hidden loss | hidden | If the action result is hidden ingame set this parameter to yes. | Boolean | optional |