Template:GenericStatusEffect: Difference between revisions

Latest revision as of 07:59, 25 June 2024

Template documentation

Note
Portions of the template sample may not be visible without values provided.

produces:

Stuns for 3 seconds per unit.

produces:

Causes stuttering for 10 seconds per unit when mixed with XXX.

{{GenericStatusEffect|key=Jitter|time=20|refreshes=false}} Template:Colored text

produces:

Causes jittering for 20 seconds per unit.

No description.

Template parameters
Parameter		Description	Type	Status
Effect name	`key`	no description Suggested values `Stun` `KnockedDown` `Stutter` `Jitter` Default Stun	String	suggested
Effect	`type`	Use "0" for negative (e.g. stuns for) and "1" for positive (e.g. reduces stun time). Default 0	Number	suggested
Duration (seconds)	`time`	no description Example 10	Number	required
Refreshes?	`refresh`	If enabled, that means that the effect does not stack. Suggested values `true` `false` Default true	String	suggested
Condition	`when`	no description Example shot by	String	suggested

@@ Line 1: / Line 1: @@
-{{#switch:{{{key|Stun}}}
+<includeonly>{{#switch:{{{key|Stun}}}
 |Stun={{#switch:{{{type|0}}}
 |0=Stuns for {{{time}}} seconds {{#ifeq:{{{refresh|true}}}|false|(stacks)}} per unit
@@ Line 20: / Line 20: @@
 |1=Reduces jittering time by {{{time}}} seconds {{#ifeq:{{{refresh|true}}}|false|(stacks)}} per unit
 }}
-}}{{#if:{{{when|}}}|&#x20;when {{{when}}}}}.
+}}{{#if:{{{when|}}}|&#x20;when {{{when}}}}}.</includeonly><noinclude>
+{{documentation}}
+[[Category:Recipe templates]]
+<templatedata>
+{
+	"params": {
+		"key": {
+			"label": "Effect name",
+			"type": "string",
+			"suggestedvalues": [
+				"Stun",
+				"KnockedDown",
+				"Stutter",
+				"Jitter"
+			],
+			"default": "Stun",
+			"suggested": true
+		},
+		"type": {
+			"label": "Effect",
+			"type": "number",
+			"description": "Use \"0\" for negative (e.g. stuns for) and \"1\" for positive (e.g. reduces stun time).",
+			"default": "0",
+			"suggested": true
+		},
+		"time": {
+			"label": "Duration (seconds)",
+			"example": "10",
+			"type": "number",
+			"required": true
+		},
+		"refresh": {
+			"label": "Refreshes?",
+			"description": "If enabled, that means that the effect does not stack.",
+			"type": "string",
+			"suggestedvalues": [
+				"true",
+				"false"
+			],
+			"default": "true",
+			"suggested": true
+		},
+		"when": {
+			"label": "Condition",
+			"example": "shot by",
+			"type": "string",
+			"suggested": true
+		}
+	}
+}
+</templatedata>
+</noinclude>