Editing Template:Loss/doc

__NOTOC__

This template is used for Effects that decreases qualities and items. It replaces the old system, and fully supports both item losses (formerly {{tl|Item Loss}}), and pyramidal qualities (formerly {{tl|Drop}}). 

Usage: <code><nowiki>{{Loss|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 decreased, 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 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 <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 unlike those <code><nowiki>{{{2}}}</nowiki></code> and <code><nowiki>{{{message}}}</nowiki></code> 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 parameter 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 parameter 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.
*'''Menace location''', this parameter is used when the quality loss occurs in a Menace location connected to that Menace and categorizes it as appropriate. Its value, if used, is the name of the location.
<templatedata>
{
	"params": {
		"1": {
			"label": "Name",
			"description": "The name of the quality/item being lost.",
			"type": "wiki-page-name",
			"required": true
		},
		"2": {
			"label": "Quantity",
			"description": "The amount lost by this action, which should either be count of levels for Discrete qualities, or number of Change Points for Pyramidal.",
			"type": "string",
			"required": true
		},
		"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 lost. Disables all other parameters",
			"type": "string"
		},
		"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."
		},
		"gone": {
			"label": "Gone",
			"description": "If the game text for the action result ends with \"Quality has gone!\", then set this parameter to yes",
			"type": "boolean"
		},
		"progress reset": {
			"aliases": [
				"reset"
			],
			"label": "Resets Quality",
			"description": "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",
			"type": "boolean"
		},
		"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": "string"
		},
		"to": {
			"label": "Set to",
			"description": "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.",
			"type": "string"
		},
		"message": {
			"label": "Custom Message",
			"description": "If the quality decrease include a custom message set this parameter to that message",
			"type": "string"
		},
		"now": {
			"label": "Now",
			"description": "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",
			"type": "string"
		},
		"hidden": {
			"label": "Hidden loss",
			"description": "If the action result is hidden ingame set this parameter to yes.",
			"type": "boolean"
		},
		"Appearance": {
			"label": "Custom appearance",
			"description": "If the decreased quality should have custom formatting like italics, this property can be used to overwrite the displayed text.",
			"type": "string"
		},
        "Menace location": {
            "label": "Menace location",
            "description": "If the action takes place in.a Menace Location and makes progress towards escaping it, then set this parameter to the name of that Menace Location.",
            "example": "State of some confusion",
            "type": "string"
		}
	},
	"format": "inline",
	"paramOrder": [
		"1",
		"2",
		"Appearance",
		"message",
		"occurrence",
		"now",
		"to",
		"gone",
		"progress reset",
		"twist",
		"image",
		"hidden",
        "Menace location"
	]
}
</templatedata><noinclude>
[[Category:Template documentation]]
</noinclude>