Template:Gain

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

This template is used for Effects that increase qualities and items. It replaces the old system, and fully supports both item gains (formerly {{Item Gain}}), and pyramidal qualities (formerly {{Increase}}).

Usage: {{Gain|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 gained, either a relative or fixed-result gain.

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

• "# x" for items
• "#" or "# x" for relative gains to discrete qualities
• "# CP" for relative gains to pyramidal qualities
• "#", "# - [level text]", or rarely "[level text]" for fixed-result gains 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 gain. 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 gain 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 gained is the same regardless of the player's amount beforehand: "10 x" of an item indicates it will both bring someone with "1 x" to "11 x", and someone with "5 x" to "15 x".
• now describes a fixed-result gain 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 "1 x" or "5 x".
  • This parameter is not used for "You now have <number> x <item>" messages used when a player previously had none of the item gained, which should be represented by the basic {{Gain|A|B}} format.

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

• message displays a custom message for the quality/item increase. 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 following parameters track additional information about the gain.

• Cap indicates that this action can only raise the quality/item up to the specified level.
  • Note that items/qualities with global caps (i.e. 15 for Notability or 200+ Watchful Gains for Watchful) are automatically displayed as such by the template. This should only be used when the action's cap is different from the global cap.
• hidden, when set to "yes", indicates that the gain is not shown to the player.

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

• 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 Gain categories or properties to the page. This should be used on non-gamedata pages (guides, template documentation, user pages, etc) to display the Gain formatting without the wiki's systems treating it as an actual game effect.

Special message keywords

The special message keywords display special gain messages, from the commonplace to the situational or extremely rare.

• occurrence is used alongside now.
  •  An occurrence! Your 'Watchful' Quality is now 50! (if below level 200 + Watchful Gains)
• to is used alongside now for special cases where the mechanical effect is technically a relative gain, but the player always begins and thus ends at a known level. While in most cases we still display this as a relative gain, 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 increased to its next level by the exact number of CP.
  •  Ascending the Reliables List of Mr Pages has increased to 2 - Mr Pages is missing a book. Witnesses report that it was stolen by two Clay Men!
• accomplishment is used primarily by Accomplishment qualities, even when the quality is already present. If no number is given, it's assumed the quality is now level 1. Some qualities that use this message can be increased further and for these the number should be explicitly stated.
•  You have a new Accomplishment... Honoured with a Statue -! (Raises Honoured with a Statue - by 1)
• twist is used by certain qualities when given while its current level is 0, i.e. the player doesn't have it yet. This should only be used for actions that always display this message, either because they can't be played with the quality already present or because the gain hits a cap after the first time. If no number is given, it's assumed the quality is now 1, though for qualities that can be increased further this should preferably be explicitly stated.
  •  A twist in your tale! You are now Duelling with the Black Ribbon.
• venture, like twist, is used by certain qualities when gained for the first time. It should be used identically to twist.
  •  Begun a new venture! Villainy: Area-Diving. (Sets Villainy: Area-Diving to 1)

World Quality keywords

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

• wqnow is seemingly the default message used by World Qualities.
  •  Whitsun: Eggs Hatched is now (new value). (Raises Whitsun: Eggs Hatched by 1) (hidden)
• wqcontributed is used by some World Qualities that track community effort.
  •  You have contributed to Assisting the Masters. (Raises Assisting the Masters by 777)

No description.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name	1	The name of the quality/item being gained.	Page	required
Amount	2	A relative amount gained from this action, i.e. the gain is added to 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 gained from this action, i.e. the result does not depend upon the player's previous level. Note that this parameter is not used for the "You now have <number> x <item>" message from gaining items for the first time. A counterpart to Amount.	Line	suggested
Custom Message	message	If the gain uses custom message text, set this parameter to that message. Compatible with Quantity and Now.	String	suggested
Special Message	special message sm	If the gain uses certain special gain 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
Increase Cap	cap	If there is a limit on how much the action can increase the item/quality, set this to that value. Leave this empty for global caps, such as the hard limits on the main Attributes.	Number	optional
Hidden Gain	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:Gain/doc to edit this text! (How does this work?)