Template:AdjustReagent: Difference between revisions

From Space Station 14 Wiki
(docs)
(docs)
Line 7: Line 7:
[[Category:Templates without specific category]]
[[Category:Templates without specific category]]
[[Category:Templates without documentation pages]]
[[Category:Templates without documentation pages]]
</noinclude>
<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 name",
"description": "TODO",
"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>

Revision as of 15:06, 24 June 2024

Template documentation
view or edit this documentation about 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]

ParameterDescriptionTypeStatus
Amount of changeamount

Usually a whole number

Default
0
Example
4
Numbersuggested
Probability of a change occurringprob

A number from 0 to 1.

Example
0.4
Numberrequired
Reagent namereagent

TODO

Stringrequired
Conditionwhen

no description

Example
more than 1u lexorin present
Stringrequired