Ad placeholder

Template:Condition: Difference between revisions

Jump to navigation Jump to search
Split off documentation
m (Add category)
(Split off documentation)
Line 9: Line 9:
| more results text=
| more results text=
| default = [[{{{1}}} (Condition)|{{{1}}}]]{{Main namespace only|[[Category:Pages with unknown conditions]]}}
| default = [[{{{1}}} (Condition)|{{{1}}}]]{{Main namespace only|[[Category:Pages with unknown conditions]]}}
}}{{#if:{{{border|}}}|</div></div>||}}</onlyinclude></includeonly><noinclude>{{documentation|content=
}}{{#if:{{{border|}}}|</div></div>||}}</onlyinclude></includeonly><noinclude>{{documentation}}
Use this to display detailed information about a condition.
 
This template just runs the Cargo query. For the formatting, see: [[Template:Condition/Format]].
 
== Examples ==
{{Template demo
| style = list
| <nowiki>{{Condition | Bleeding }}</nowiki>
| <nowiki>{{Condition | Bleeding | altname=oh no i'm bleeding | duration = 2 | save = CON }}</nowiki>
| <nowiki>
{{Condition
| Bleeding
| save = Constitution
| duration = 2
| dc = weapon action
| border = 1
}}</nowiki>
| <nowiki>{{Condition | Feverish | radius m = 3 | duration = Long rest}}</nowiki>
}}
 
=== Inline example ===
This template can also be used inline, but refer to {{t link|Condition inline}} for a template designed for that.
{{Template demo
| <nowiki>{{Condition | Bleeding | inline = true }}</nowiki>
| <nowiki>{{Cond|Bleeding}}</nowiki>
}}
 
== See also ==
* {{t link|Condition/Format}} - An internal template actually responsible for formatting this template.
* {{t link|Condition inline}} - Similar template that just displays the icon of the condition. For use in inline text.
* {{t link|Condition page}} - Page generating template responsible for adding a condition into the condition Cargo table so that it can be referenced by this template.
 
== Template parameters ==
<templatedata>
{
"description": "Display a block of information about a condition.",
    "format": "inline",
"params": {
"1": {
"description": "Name of the condition. This should match an entry in the conditions Cargo table.",
"required": true,
"label": "name",
"type": "string"
},
        "altname": {
"description": "An alternative display name for the condition link.",
"type": "string"
},
"duration": {
            "description": "Duration of the condition. This is generally a number of turns, but refer to Template:Duration for special values.",
            "type": "string",
            "suggestedvalues": ["Long rest", "Permanent", "Saving Throw", "Whilst on surface"],
            "example": "10"
        },
"save": {
            "description": "Ability used for the saving throw to resist this condition. Accepts abilities in either the shorthand (e.g. STR) or long form (e.g. Strength)",
            "type": "string",
            "suggestedvalues": ["STR", "DEX", "CON", "INT", "WIS", "CHA"],
            "example": "Strength"
        },
        "dc": {
            "description": "The difficulty class of the saving throw to resist this condition. This is either a fixed number or a special value like \"caster\". Refer to Template:Saving Throw for these special values.",
            "type": "string",
            "suggestedvalues": ["caster", "weapon action"],
            "example": "15"
        },
"radius m": {
            "description": "Radius of the condition in metres. This is rarely used.",
            "type": "number"
        },
        "border": {
"description": "Display a border around the condition box.",
"type": "boolean"
},
        "inline": {
"description": "Whether the condition should be formatted inline. See also Template:Condition inline.",
"type": "boolean",
            "deprecated": true
}
}
}
</templatedata>}}
[[Category:Templates]]
[[Category:Templates]]
[[Category:Condition templates]]
[[Category:Condition templates]]
[[Category:Cargo templates]]
[[Category:Cargo templates]]
</noinclude>
</noinclude>

Navigation menu