Template:Loss

Template documentation (for the above template, sometimes hidden or invisible)

This template is used for Effects that decrease 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>}} or {{Gain|A|now=B|<params>}}

• The first parameter is the name of the item or quality.
• The second parameter is the amount lost, either a relative or fixed-result loss.

The standard formatting for amounts is depends on the type of the item/quality and the type of loss. These cover all but the rarest use cases.

• "# x" for items
• "#" or "# x" for relative losses to discrete qualities
• "# CP" for relative losses to pyramidal qualities
• "#", "# - [level text]", or rarely "[level text]" for fixed-result losses to both types of quality

Parameter list

• {{{1}}}, the first unnamed parameter, is the full page name of the quality or item gained. This is always required for the template to work.

The amount parameters describe the amount and type of loss. One of these two should be provided in almost every situation. They are not compatible with each other.

• {{{2}}}, the second unnamed parameter, describes a relative loss to the item or quality. It expects a numerical value in the standard formatting described above.
  • In other words, it's used when the amount lost is the same regardless of the player's amount beforehand: "10 x" of an item indicates it will both bring someone with "11 x" to "1 x", and someone with "50 x" to "40 x".
• now describes a fixed-result loss to the item or quality. It expects a value, usually numerical, in the standard formatting described above.
  • In other words, it's used when the resulting amount is the same regardless of the player's amount beforehand: "now=10 x" will leave someone with "10 x" whether they previously had "11 x" or "50 x".

The message parameters display custom messages that the game sometimes uses in place of the default loss text. They are optional but not compatible with each other.

• message this parameter displays a custom message for the quality/item loss. These are usually specific to the item or quality, and sometimes even to the individual option.
  • Messages automatically display in italics. If the actual game text is not italicized and the message is not supported by special message, use {{UnI}} to format the message correctly.
• special message, or the shorthand sm, uses keywords to display special messages commonly used by the game. Keywords differ in behavior. For the full list of special messages, see the following section.

The other parameters give finer control over how the template displays and behaves.

• hidden, when set to "yes", indicates that the loss is not shown to the player.
• image sets a custom image to display instead of the item or quality's default. Its value is the image name to be used, including the ".png" postfix but without a "File:" prefix. Set this to "none" to not display an image.
• Appearance overwrites the link text for the quality or item. Can be use to add italics, use a shorthand, or change the text entirely.
• suppress properties, when set to yes, prevents the template from adding the loss categories or properties to the page. This should be used on non-gamedata pages (guides, template documentation, user pages, etc) to display the Loss formatting without the wiki's systems treating it as an actual game effect.

Special message keywords

The special message (or sm) keywords display special loss messages, from the commonplace to the situational or extremely rare.

• occurrence is used alongside now.
  •  An occurrence! Your 'Watchful' Quality is now ( Watchful / 2)!
• to is used alongside now for special cases where the mechanical effect is technically a relative loss, but the player always begins and thus ends at a known level. While in most cases we still display this as a relative loss, sometimes we want to display the end level's associated text. This is also rarely used for early stories where a pyramidal tracking quality is decreased to a specific level by the exact number of CP.
  •  Nightmares has dropped to 6 - Deranged!
• gone is used when setting an item or quality to 0.
  •  Your 'A Beneficence' Quality has gone!
• twist is used by certain qualities instead of the typical gone message.
  •  A twist in your tale! You are no longer A Courier for the Dead.
• reset is used by certain qualities instead of the typical gone message.
  •  'Archaeologist's Progress' has been reset: a conclusion, or a new beginning?

World Quality keywords

Some special message keywords are specifically used by World Qualities. These by nature only support {{{2}}}.

• wqnow is seemingly the default message used by World Qualities.
  •  The Lorn-Fluke's Fury is now (new value). (Lowers The Lorn-Fluke's Fury by 1)

Templatedata

Used when the player loses a quality or item.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name	1	The name of the quality/item being lost.	Page	required
Amount	2	A relative amount lost from this action, i.e. the loss is subtracted from the player's previous level. This should be the number of levels for items and Discrete qualities, or number of Change Points with ' CP' suffix for Pyramidal qualities. A counterpart to Now. Example 5 x, or +2 CP	Line	suggested
Now	now	A fixed result from this action, i.e. the final amount does not depend upon the player's previous level. A counterpart to Amount.	Line	suggested
Custom Message	message	If the loss uses custom message text, set this parameter to that message. Compatible with Quantity and Now.	String	suggested
Special Message	special message sm	If the loss uses certain special loss messages, set this parameter to the corresponding special message keyword. The most common such keyword is 'occurrence'. For the full list of supported special messages and keywords, see the template documentation.	Line	suggested
Hidden Loss	hidden	If this part of the action result is hidden in-game from the player, set this parameter to yes.	Line	optional
Image filename	image	Changes the image link displayed before the text, including the '.png' postfix. Set this to "none" to not display an image. Default The default image for a quality is stored in Property:Has icon.	File	optional
Custom appearance	Appearance	This property can be used to overwrite the item or quality's link text, such as to add custom formatting.	Line	optional
Suppress properties	suppress properties	When "yes", displays the template's visual output without adding the corresponding categories and properties to the page.	Line	optional

Visit Template:Loss/doc to edit this text! (How does this work?)