Template:Item Gain

From Fallen London Wiki

Error, no item/quality was given.

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>}}

  • 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 increased, 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. Its value is the numerical increase, including either the x or the CP postfix. Do not use this template if one of the following two parameters are used.
  • occurence, this parameter is used when the quality change starts with An occurence. Its value is the new numerical value of the quality. Note that some of the templates allowed the use of |occurence=yes with the |now parameter having the numerical value, but that this behavior is now deprecated.
  • to, this parameter is used when the quality change looks like x has increased 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 increase. Note that this will not work if either occurence or to are set.
  • now, this parameter is used to when the action sets a quality/item to a specific level, but doesn't use either occurence or now. Note that unlike those {{{2}}} and {{{message}}} do work with this one.
  • 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.
  • Cap, if a action can only raise a quality/item to a specified amount set this parameter to that value.
Note: global caps (such as 15 on notability, are automatically included by the template.

No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Name1

The name of the quality/item being gained.

Pagerequired
Quantity2

The amount gained by this action, which should either be count of levels for Discrete qualities, or number of Change Points for Pyramidal.

Example
5 x, or +2 CP
Linesuggested
Image filenameimage

Changes the image link displayed before the text.

Default
The default image for a quality is stored in Property:Has icon.
Fileoptional
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.

Lineoptional
Set toto

If the result of the action sets this quality to a specific level, instead of increasing it, then set this parameter to the new level (including level description) unless "occurrence" is more appropriate.

Lineoptional
Custom Messagemessage

If the quality increase include a custom message set this parameter to that message

Stringoptional
Nownow

If the result of the action sets this quality to a specific level, instead of increasing it, then set this parameter to the new level. Unlike Set to and Occurrence this one will work with Message

Unknownoptional
Increase Capcap

If there is a limit on how much the action can increase the quality set this to that value.

Numberoptional
Hidden Gainhidden

If the action result is hidden ingame set this parameter to yes.

Booleanoptional
No categorynocat

Setting this parameter to yes will disable categorisation.

Booleanoptional

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