Editing Template:Action/doc

==Main data==
*'''Icon''' - The name of the image used to represent the action. Do not include the "File:" namespace prefix, but do include the ".png" file extension.
*'''From Card/Storylet title''' - Copy the name of the card or storylet which contain this action.
**'''Title Appearance''' will change how this link looks like.
**'''From field formatted''' - When set to any value, this means that the From field already contains formatting, so the template won't make it into a link. Useful for actions with multiple source cards/storylets.
*'''Action cost''' - Only enter an '''Action cost''' for values other than 1.
*'''Description''' - The Action's description. When entering please be very mindful of [[Trimming Guidelines]]!
*'''Description summary'''- We want to move this Wiki in a more user-generated direction (just like the best Wikis out there) so we would like users to summarize the Action's description in their own words.
*'''Game Instructions''' is for adding non-narrative game instructions. It doesn't count for the 250-rule.
*'''Unlocked with''' lists the necessary conditions for this action to be selectable in-game. If there are none, leave this blank.
*'''Locked with''' lists conditions that will cause this action to be locked. Use this only if it's more logical here than in '''Unlocked with'''.
*'''Button text''' - Optional, for recording the text of the button shown on the action in the game. Currently not displayed, only used to set a property.
==Challenge difficulty==
*'''BroadQuality''' and '''BroadDiff''' are used when the action tests a quality using the [[Broad difficulty]] system.
*'''NarrowQuality''', '''NarrowDiff''', and (optionally) '''NarrowMin''' and '''NarrowStep''' are used when the action tests a quality using the [[Narrow difficulty]] system.
*'''LuckChallenge''' is used for a Luck challenge. See {{t|LuckChallenge}} for possible values
*'''ModifiedQuality''' is used together with the next two to describe challenges modified by a quality.
*'''ModifiedAmount''' the amount the difficulty is modified
*'''ModifiedIncrease''' set this to <code>+</code> if the difficulity is increased instead of decreased (the default)
*'''Challenge information''' is for describing challenges that don't fit the usual Broad or Narrow types. If in doubt, tell the relevant quality level and success percentage. It helps greatly!
==Results==
*'''Redirects to''' - When the action redirects the player to a different card or storylet. Example: [[Discover the secrets of the Clay Men 0]]. Entering anything in this field will remove '''Success title''' and '''Success description'''. If you wish to keep those, use '''[[Template:Redirect]]''' instead.
**'''Redirect Appearance''' will affect what this link looks like.
*'''Success title''' is the title of the in-game text displayed when an action was successful.
*'''Success description''' is the in-game text displayed when an action was successful. Due to copyright restrictions we no longer allow more than 250 characters of this to be displayed. Considering using instead:
*'''Success summary''' allows a user to enter their own summary of the success text. This should be in the user's own words; it is '''not''' the place for in-game content.
*'''Success Instructions''' - Same as "Game Instructions", but for success text.

If there are any rewards, write them below this template.

Other related template are: [[Template:Failure]], [[Template:Rare Success]], [[Template:Success]].
<noinclude>[[Category:Template documentation]]</noinclude>
<templatedata>
{
	"params": {
		"From Card/Storylet title": {
			"aliases": [
				"From Card title",
				"From Storylet title"
			],
			"label": "From title",
			"description": "The name of the card or storylet which contain this action.",
			"example": "A past benefactor",
			"type": "wiki-page-name",
			"required": true
		},
		"From field formatted": {
			"label": "From field formatted",
			"description": "When set to any value, this means that the From field already contains formatting, so the template won't make it into a link. Useful for actions with multiple source cards/storylets.",
			"example": "yes",
			"type": "line"
		},
		"Title Appearance": {
			"label": "From Title Appearance",
			"description": "Changes how the \"From title\" link looks like.",
			"type": "line"
		},
		"Action cost": {
			"label": "Action cost",
			"description": "Only enter an Action Cost for values other than 1",
			"example": "0",
			"type": "number",
			"default": "1"
		},
		"Description": {
			"label": "Action description",
			"description": "The Action's description. When entering please be very mindful of Trimming Guidelines!",
			"type": "content",
			"required": true
		},
		"Description summary": {
			"label": "Description summary",
			"description": "Player-provided summary of the action description. Does not count towards the 250-character limit.",
			"type": "content",
			"suggested": true
		},
		"Game Instructions": {
			"label": "Game instructions",
			"description": "Non-narrative game instructions. Does not count towards the 250-character limit.",
			"type": "content"
		},
		"Unlocked with": {
			"label": "Unlock conditions",
			"description": "A comma-separated list of the necessary conditions for this action to be selectable in-game. In this field, you should use the Unlock template.",
			"example": "{{Unlock|Bowler Hat}}",
			"type": "content"
		},
		"Locked with": {
			"label": "Lock conditions",
			"description": "A comma-separated list of conditions that will cause this action to be locked. Use this only if it's more logical here than in Unlocked with. Use the IL template.",
			"type": "content"
		},
        "Button text": {
            "label": "Button text",
            "description": "Text of the button shown on the action in the game.",
            "type": "line"
        },
		"Wiki Note": {
			"label": "Wiki Note",
			"description": "Player-provided note providing more information or clarification.",
			"type": "content"
		},
		"BroadQuality": {
			"label": "Broad Challenge Quality",
			"description": "The quality tested by a Broad-type challenge. Should use the IL template.",
			"example": "{{IL|Watchful}}",
			"type": "line"
		},
		"BroadDiff": {
			"label": "Broad Challenge Difficulty",
			"description": "The difficulty of the broad-type challenge. ",
			"example": "75",
			"type": "number",
			"default": "If Broad Challenge Quality is set but Difficulty is not, displays as \"Unknown Difficulty level\" and tags with a maintenance category."
		},
		"NarrowQuality": {
			"label": "Narrow Challenge Quality",
			"description": "The quality tested by a Narrow-type challenge. Should use the IL template.",
			"example": "{{IL|Fascinating...}}",
			"type": "line"
		},
		"NarrowDiff": {
			"label": "Narrow Challenge Difficulty",
			"description": "The difficulty for a Narrow Challenge.",
			"example": "4",
			"type": "number",
			"default": "If Narrow Challenge Quality is set and no Difficulty is provided, then \"Unknown Challenge level\" displays and a maintenance category is set."
		},
		"NarrowMin": {
			"label": "Narrow Challenge Minimum",
			"description": "The floor value for a Narrow Challenge.",
			"type": "number",
			"default": "0"
		},
		"NarrowStep": {
			"label": "Narrow Challenge Step Value",
			"description": "The percentage change for each level above NarrowDiff for a Narrow Challenge.",
			"type": "number",
			"default": "10"
		},
		"LuckChallenge": {
			"label": "Luck Challenge",
			"description": "The chance of success for a luck-based challenge.",
			"example": "50",
			"type": "number"
		},
		"Challenge information": {
			"label": "Challenge Information",
			"description": "Any complications or nuance to the challenges, such as if the difficulty is affected by other qualities.",
			"type": "content"
		},
		"Redirects to": {
			"label": "Redirects to",
			"description": "When the action redirects the player to a different card or storylet. This field will suppress the Success fields; to have both, use the Redirect template after the Success information.",
			"type": "wiki-page-name"
		},
		"Redirect Appearance": {
			"label": "Redirect Appearance",
			"description": "Changes the appearance of the redirect link.",
			"type": "line"
		},
		"Success title": {
			"label": "Success title",
			"description": "The title of the in-game text displayed when you succeed an action, or complete one with no challenges.",
			"type": "line",
			"required": true
		},
		"Success description": {
			"label": "Success description",
			"description": "The in-game text displayed when an action was successful. When entering please be very mindful of Trimming Guidelines!",
			"type": "string",
			"required": true
		},
		"Success summary": {
			"label": "Success summary",
			"description": "A player-provided summary of the success description. Does not count to the 250-character limit.",
			"type": "content",
			"suggested": true
		},
		"Success Instructions": {
			"label": "Success Instructions",
			"description": "Same as \"Game Instructions\", but for success text.",
			"type": "content"
		},
		"ID": {
			"label": "ID",
			"description": "The numerical ID associated with the action.",
			"example": "42",
			"type": "number"
		},
		"Icon": {
			"label": "Icon",
			"description": "The filename of the image used in-game to represent the action. Don't include the namespace prefix, but do include the extension.",
			"example": "Placeholder2.png",
			"type": "wiki-file-name",
			"autovalue": "Sets a maintenance category if missing.",
			"suggested": true
		},
		"Spoiler Type": {
			"description": "Parameter to {{Spoiler}}",
			"example": "Major"
		},
		"ModifiedQuality": {
			"description": "Quality that modifies the difficulty of this action",
			"example": "Research Preparations",
			"type": "wiki-page-name"
		},
		"ModifiedAmount": {
			"description": "Amount by which the challenge is modified per point of other quality",
			"example": "1",
			"type": "number"
		},
		"ModifiedIncrease": {
			"description": "Manner by which the challenge is modified (+ for increased, - as default))",
			"example": "+",
			"default": "-"
		},
		"Section": {
			"description": " If specified, this will be the Result section name used (instead of \"Success\", \"Failure\", etc.). ",
			"type": "line"
		}
	},
	"paramOrder": [
		"Icon",
		"From Card/Storylet title",
		"From field formatted",
		"Title Appearance",
		"Action cost",
		"Description",
		"Description summary",
		"Game Instructions",
		"Wiki Note",
		"ID",
		"Unlocked with",
		"Locked with",
        "Button text",
		"BroadQuality",
		"BroadDiff",
		"NarrowQuality",
		"NarrowDiff",
		"NarrowMin",
		"NarrowStep",
		"LuckChallenge",
		"Challenge information",
		"Redirects to",
		"Redirect Appearance",
		"Success title",
		"Success description",
		"Success summary",
		"Success Instructions",
		"Spoiler Type",
		"ModifiedQuality",
		"ModifiedAmount",
		"ModifiedIncrease",
		"Section"
	],
	"format": "block",
	"description": "A template for organizing, linking, and applying categories to the actions a player can take inside of Cards or Storylets. This template combines information about the option, and the standard success result. Alternate outcomes should use the Success and Failure templates."
}
</templatedata>