Template:AdjustReagent: Difference between revisions

Latest revision as of 17:04, 24 June 2024

Template documentation

{{AdjustReagent|amount=4|prob=0.1|reagent=Histamine|when=more than 1u lexorin present}} →

10% chance to add 4 histamine when more than 1u lexorin present.

{{AdjustReagent|amount=-1|prob=0.5|reagent=GrapeSoda|when=slipping on a floor}} →

50% chance to remove 1 grape soda when slipping on a floor.

Describes a chance of adding or removing certain reagent when a condition satisfies.

Template parameters[Edit template data]
Parameter		Description	Type	Status
Amount of change	`amount`	Usually a whole number Default 0 Example 4	Number	suggested
Probability of a change occurring	`prob`	A number from 0 to 1. Example 0.4	Number	required
Reagent ID	`reagent`	A reagent ID. See the list here: https://wiki.spacestation14.io/wiki/User:Moony/chem_prototypes.json	String	required
Condition	`when`	no description Example more than 1u lexorin present	String	required

@@ Line 1: / Line 1: @@
-{{Chance to|{{#ifexpr:{{{amount|0}}}<0
+<includeonly>{{Chance to|{{#ifexpr:{{{amount|0}}}<0
 |{{#ifeq:{{{prob}}}|1|Removes|remove}} {{#expr:abs {{{amount|0}}}}} {{#invoke:Chemistry Lookup|readscalar|{{{reagent}}}|name}}
 |{{#ifeq:{{{prob}}}|1|Adds|add}} {{#expr:abs {{{amount|0}}}}} {{#invoke:Chemistry Lookup|readscalar|{{{reagent}}}|name}}
-}}{{#if:{{{when|}}}|&#x20;when {{{when}}}}}.|prob={{{prob}}}}}
+}}{{#if:{{{when|}}}|&#x20;when {{{when}}}}}.|prob={{{prob}}}}}</includeonly><noinclude>
+{{documentation}}
+[[Category:Recipe templates]]
+<templatedata>
+{
+	"params": {
+		"amount": {
+			"label": "Amount of change",
+			"description": "Usually a whole number",
+			"example": "4",
+			"type": "number",
+			"default": "0",
+			"suggested": true
+		},
+		"prob": {
+			"label": "Probability of a change occurring",
+			"description": "A number from 0 to 1.",
+			"example": "0.4",
+			"type": "number",
+			"required": true
+		},
+		"reagent": {
+			"label": "Reagent ID",
+			"description": "A reagent ID. See the list here: https://wiki.spacestation14.io/wiki/User:Moony/chem_prototypes.json",
+			"type": "string",
+			"required": true
+		},
+		"when": {
+			"label": "Condition",
+			"example": "more than 1u lexorin present",
+			"type": "string",
+			"required": true
+		}
+	},
+	"description": "Describes a chance of adding or removing certain reagent when a condition satisfies.\n\n"
+}
+</templatedata></noinclude>