Editing Template:Gain/doc

__NOTOC__

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

Usage: <code><nowiki>{{Gain|A|B|<params>}}</nowiki></code>

*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 {{tl|IL}}'s is no longer supported. Set this to "none" to not display an image.
*'''<nowiki>{{{1}}}</nowiki>''', ie the first unnamed parameter defines the quality or item that is being increased, with its value being the full pagename of this quality.
*'''<nowiki>{{{2}}}</nowiki>''', 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 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. Note that some of the templates allowed the use of <code>|occurrence=yes</code> with the <code>|now</code> 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 <code>|occurrence</code> or <code>to</code> are set.
*'''now''', this parameter is used to when the action sets a quality/item to a specific level, but doesn't use either <code>|occurrence</code> or <code>to</code>. Note that <code><nowiki>{{{2}}}</nowiki></code> and <code><nowiki>{{{message}}}</nowiki></code> do work with this one, and for pyramidal qualities <code><nowiki>{{{message}}}</nowiki></code> is required.
**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 <code><nowiki>{{Gain|A|B}}</nowiki></code> format.
*'''twist''', this parameter is used when the quality change looks like A twist in your tale! You are now x. 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.
*'''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. 
<templatedata>
{
	"params": {
		"1": {
			"label": "Name",
			"description": "The name of the quality/item being gained.",
			"type": "wiki-page-name",
			"required": true
		},
		"2": {
			"label": "Quantity",
			"description": "The amount gained by this action, which should either be count of levels for items and Discrete qualities, or number of Change Points for Pyramidal. Pyramidal qualities require the ' CP' or ' x' postfix.",
			"example": "5 x, or +2 CP",
			"type": "line",
			"suggested": true
		},
		"image": {
			"label": "Image filename",
			"description": "Changes the image link displayed before the text. Set this to \"none\" to not display an image.",
			"type": "wiki-file-name",
			"default": "The default image for a quality is stored in Property:Has icon."
		},
		"occurrence": {
			"label": "Occurrence!",
			"description": "If the game text for the action result begins with \"An occurrence!\", then set this parameter to the new value of the quality.",
			"type": "line"
		},
		"message": {
			"label": "Custom Message",
			"description": "If the quality increase include a custom message set this parameter to that message",
			"type": "string"
		},
		"to": {
			"label": "Set to",
			"description": "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.",
			"type": "line"
		},
		"now": {
			"label": "Now",
			"description": "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 2 and Message, and it is required when using Now for a pyramidal quality. Note that this parameter is not used for the \"You now have <number> x <item>\" message from gaining items for the first time."
		},
		"twist": {
			"label": "Twist",
			"description": "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 gained. Disables all other parameters",
			"type": "string"
		},
		"hidden": {
			"label": "Hidden Gain",
			"description": "If the action result is hidden ingame set this parameter to yes.",
			"type": "boolean"
		},
		"cap": {
			"label": "Increase Cap",
			"description": "If there is a limit on how much the action can increase the quality set this to that value.",
			"type": "number"
		},
		"Appearance": {
			"label": "Custom appearance",
			"description": "If the increased quality should have custom formatting like italics, this property can be used to overwrite the displayed text.",
			"type": "string"
		}
	},
	"paramOrder": [
		"1",
		"2",
		"image",
		"Appearance",
		"occurrence",
		"to",
		"message",
		"now",
		"twist",
		"cap",
		"hidden"
	],
	"format": "inline"
}
</templatedata>
<noinclude>[[Category:Template documentation]]</noinclude>