Editing Template:ActivitySummary/doc

{{ActivitySummary
|Activity=Brawling with Dockers
|Starting Actions=1
|Length=Variable
|Progress Actions=1
|Ending Actions=1
|Progress Details=Raise {{IL|Brawling with Dockers}}. Caps at 100/120/140/150 depending on desired payout.
|Output Items=*{{IL|Crate of Incorruptible Biscuits}}
*{{IL|Puzzling Map}}
*{{IL|Femur of a Jurassic Beast}}
*{{IL|Baptised Rattus Faber Corpse}}
|Boost Items=*''{{IL|Honed Ushanka}}''
*''{{IL|Vigilant Chitin-Fur Boots}}''
*''{{IL|Moray Heels}}''
*''{{IL|A Hunter's Instinct for Nightmares}}''
*''{{IL|Special Dispensation}}''
|Raw EPA = 3.33
|Raw SPA = 6.66
|Locked=Yes
|Conversion=Yes
|Starting Items=*{{IL|Bone Fragments}}
*{{IL|Lump of Lamplighter Beeswax}}
|Input Items=*{{IL|Bone Fragments}}
*{{IL|Lump of Lamplighter Beeswax}}
}}

Produces a table summarizing the actions required (and any additional costs) to complete a particular activity. 

*'''Fixed''' - Activities that require a set number of actions to complete it, whether or not you succeed in your actions.
*'''Semi-Fixed''' - Activities that have a max number of actions, whether or not you succeed in them, but can be terminated early for a smaller reward.
*'''Limited''' - Activities that end when a progress quality reaches a certain value. Generally this equates to a certain number of successes.
*'''Variable''' - Activities that are open ended and end when a player cashes out, though there may still be a cap.



<templatedata>
{
	"params": {
		"Activity": {
			"label": "Activity name",
			"description": "The name of the activity being described.",
			"example": "Brawling with the Dockers",
			"type": "wiki-page-name",
			"required": true
		},
		"Length": {
			"label": "Actvity Length",
			"description": "Describes the type of activity. Accepts Fixed, Semi-Fixed, Limited, and Variable.",
			"example": "Variable",
			"type": "string",
			"required": true
		},
		"Locked": {
			"label": "Activity Locked?",
			"description": "Does this activity lock you into it once you begin?",
			"example": "False",
			"type": "boolean",
			"default": "false"
		},
		"Conversion": {
			"label": "Conversion Activity?",
			"description": "Does this activity largely rely on consuming resources for each action? True/False",
			"example": "False",
			"type": "boolean",
			"default": "false"
		},
		"Starting Actions": {
			"label": "Starting Actions",
			"description": "The number of actions to begin the activity.",
			"example": "1",
			"type": "number",
			"required": true
		},
		"Progress Actions": {
			"label": "Progress Actions",
			"description": "The number of actions dedicated towards progressing the activity. For Variable, this is the minimum number to cash out. If there are multiple options for the activity, use the format 2/5/9",
			"example": "1",
			"type": "string",
			"required": true
		},
		"Ending Actions": {
			"label": "Ending Actions",
			"description": "The number of actions to finish the activity.",
			"example": "1",
			"type": "number",
			"required": true
		},
		"Progress Details": {
			"label": "Progress Details",
			"description": "Description about how the activity progresses. Include any important notes here.",
			"type": "line",
			"required": true
		},
		"Starting Items": {
			"label": "Starting Items",
			"description": "Items Consumed to begin the carousel. Each bullet point is a different option. Italicized items are not consumed. If multiple items are needed in a particular option, use {{TableList}}.",
			"example": "*{{IL|Whirring Contraption}}",
			"type": "content"
		},
		"Input Items": {
			"label": "Input Items",
			"description": "Items consumed for regular Progress. Italicized items are not consumed. Only list the items, not the quantity on any option.",
			"example": "*{{IL|Whirring Contraption}}",
			"type": "content"
		},
		"Boost Items": {
			"label": "Boost Items",
			"description": "Items that can be consumed for faster Progress. Italicized items are not consumed. Only list the items, not the quantity on any option.",
			"example": "*{{IL|Whirring Contraption}}",
			"type": "content"
		},
		"Output Items": {
			"label": "Output Items",
			"description": "Items received from the activity. Only list the items, not the quantity on any option.",
			"example": "*{{IL|Whirring Contraption}}",
			"type": "content",
			"required": true
		},
		"Raw EPA": {
			"label": "Raw EPA",
			"description": "The optimal average EPA of the activity, according to calculations. Net value of the activity (value of inputs is subtracted from value of outputs). Single action conversions, such as with the Rat Market are included.",
			"example": "6.66",
			"type": "number",
			"required": true
		},
		"Raw SPA": {
			"label": "Raw SPA",
			"description": "The optimal average SPA of the activity, according to calculations. Net value of the activity (value of inputs is subtracted from value of outputs). Inputs are subtracted from Outputs. Later conversions, such as with the Rat Market are not included. Assumes optimum play. Single action conversions, such as selling diamonds are included.",
			"example": "3.33",
			"type": "number"
		},
        "Raw StPA": {
			"label": "Raw StPA",
			"description": "The optimal average StPA of the activity, according to calculations. Net value of the activity (value of inputs is subtracted from value of outputs).",
			"example": "50",
			"type": "number"
		},
        "Special": {
			"label": "Special",
			"description": "Non-quantifiable rewards, or other notes.",
			"example": "Only one of these activities is repeatable. The calculations are based on it",
			"type": "content"
		}
	},
	"description": "Produces a table summarizing the actions required (and any additional costs) to complete a particular activity.",
	"format": "block",
	"paramOrder": [
		"Activity",
		"Length",
		"Locked",
		"Conversion",
		"Starting Actions",
		"Progress Actions",
		"Ending Actions",
		"Progress Details",
        "Starting Items",
        "Input Items",
        "Boost Items",
        "Output Items",
        "Raw EPA",
        "Raw SPA",
        "Raw StPA",
        "Special"
	]
}
</templatedata>

<noinclude>[[Category:Template documentation]]</noinclude>