Template:Condition/Format: Difference between revisions

Latest revision as of 23:24, 21 July 2024

Template documentation

Template responsible for formatting {{Condition}}. This is intended for internal use by the parent template only.

Examples

Markup

{{Condition/Format
| page = Bleeding (Condition)
| name = Bleeding
| icon = Bleeding Condition Icon.webp
| effects = Bleeds you out.
}}

Renders as

Bleeding

Bleeds you out.

Markup

{{Condition/Format
| page = Bleeding (Condition)
| name = Bleeding
| icon = Bleeding Condition Icon.webp
| save = CON
| dc = 13
| effects = Inflicts damage every turn.
| duration = Saving Throw
}}

Renders as

Bleeding

Duration: Until successful Saving Throw

DC 13 Constitution saving throw

Inflicts damage every turn.

Markup

{{Condition/Format
| page = Bleeding (Condition)
| name = Bleeding
| icon = Bleeding Condition Icon.webp
| effects =
* Inflicts damage every turn.
* Cured by healing.
| altname = Oh no I'm bleeding
| types = Diseased
| duration = 
}}

Renders as

Oh no I'm bleeding

Inflicts damage every turn.
Cured by healing.

Diseased

Markup

Inline example: {{Condition/Format
| page = Bleeding (Condition)
| name = Bleeding
| icon = Bleeding Condition Icon.webp
| inline = true
| types = diseased
}}. Blah blah blah.

Renders as

Inline example: Bleeding. Blah blah blah.

Template data

Display a block of information about a condition.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
name	`page`	Condition page to link to.	Page name	required
name	`name`	Name of the condition.	String	required
icon	`icon`	Icon file of the condition.	File	required
altname	`altname`	An alternative display name for the condition link.	String	optional
duration	`duration`	Duration of the condition. This is generally a number of turns, but refer to Template:Duration for special values. Suggested values `Long rest` `Permanent` `Saving Throw` `Whilst on surface` Example 10	String	optional
save	`save`	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) Suggested values `STR` `DEX` `CON` `INT` `WIS` `CHA` Example Strength	String	optional
dc	`dc`	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. Suggested values `caster` `weapon action` Example 15	String	optional
types	`types`	Any condition types the condition belongs to. Example Diseased	String	optional
radius m	`radius m`	Radius of the condition in metres. This is rarely used.	Number	optional
inline	`inline`	Whether the condition should be formatted inline. See also Template:Condition inline.	Boolean	deprecated

@@ Line 1: / Line 1: @@
-<includeonly>[[File:{{{icon}}}|frameless|30px|link=|{{{name}}}]] <strong>[[{{{name}}} (Condition)|{{{name}}}]]</strong> {{#if: {{{duration|}}}{{{save|}}} | <div> }}{{#if: {{{duration|}}} |
+<includeonly>{{#if:{{{inline|}}}|<span class="bg3wiki-condition" style="white-space: nowrap">{{IconLink|{{{icon}}}|{{{page}}}|{{#if: {{{altname|}}} | {{{altname}}} | {{{name|{{{page}}}}}}}}|w={{{w|25}}}|h={{{w|25}}}}}</span>|<div class="bg3wiki-condition"><strong>{{IconLink|{{{icon}}}|{{{page}}}|{{#if: {{{altname|}}} | {{{altname}}} | {{{name|{{{page}}}}}}}}|w={{{w|30}}}|h={{{w|30}}}}}</strong>{{#if: {{{duration|}}} |
-{{InfoBlob| {{Duration|{{{duration}}}}} }}
+<p>{{InfoBlob | {{Duration | {{{duration}}} }} }}</p>
-}} {{#if: {{{save|}}} |
+}}{{#if: {{{save|}}} |
-{{InfoBlob| {{SavingThrow|{{{save}}}}} }}
+<p>{{InfoBlob | {{SavingThrow | {{{save}}} | dc = {{{dc|}}} }} }}</p>
-}}{{#if: {{{duration|}}}{{{save|}}} | </div> }}
+}}{{#if: {{{radius m|}}} |
-{{#if:{{{skip effect|}}}||{{{effects}}} }}</includeonly><noinclude>
+<p>{{InfoBlob | {{Radius | m = {{{radius m}}} | showtext = true }} }}</p>
-Meant to be used with a Cargo query.  Preview:
+}}
+<div>
+{{{effects}}}
+</div>
+{{#if: {{{types|}}} |
+<div>{{Condition Type | {{{types|}}} }}</div>
+}}{{#if: {{{condition|}}} |
-== Single effect description ==
+<h3> Condition: {{{condition}}} </h3>
-{{Condition/Format
+<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">
-| name = Bleeding
+{{Condition | {{{condition}}}
-| icon = Bleeding Condition Icon.webp
+| save = {{{condition save|}}}
-| duration = 3
+| dc = {{{condition dc|}}}
-| save = CON
+| duration = {{{condition duration|}}}
-| effects = Inflicts damage every turn.
 }}
+</div>
+}} {{#if: {{{condition2|}}} |
-== Duration only ==
+<h3> Condition: {{{condition2}}} </h3>
-{{Condition/Format
+<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">
-| name = Bleeding
+{{Condition | {{{condition2}}}
-| icon = Bleeding Condition Icon.webp
+| save = {{{condition2 save|}}}
-| duration = 3
+| dc = {{{condition2 dc|}}}
-| effects = Inflicts damage every turn.
+| duration = {{{condition2 duration|}}}
 }}
+</div>
-== Save only ==
+}}</div>}}</includeonly><noinclude>{{documentation|content=
+Template responsible for formatting {{t link|Condition}}. This is intended for internal use by the parent template only.
+== Examples ==
+{{Template demo
+| style = list
+| <nowiki>
 {{Condition/Format
+| page = Bleeding (Condition)
 | name = Bleeding
 | icon = Bleeding Condition Icon.webp
-| save = CON
+| effects = Bleeds you out.
-| effects = Inflicts damage every turn.
 }}
+</nowiki>
-= Effect listing =
+| <nowiki>
 {{Condition/Format
+| page = Bleeding (Condition)
 | name = Bleeding
 | icon = Bleeding Condition Icon.webp
-| duration = 3
 | save = CON
-| effects =
+| dc = 13
-* Inflicts damage every turn.
+| effects = Inflicts damage every turn.
-* Cured by healing.
+| duration = Saving Throw
 }}
+</nowiki>
-== Duration only ==
+|<nowiki>
 {{Condition/Format
+| page = Bleeding (Condition)
 | name = Bleeding
 | icon = Bleeding Condition Icon.webp
-| duration = 3
 | effects =
 * Inflicts damage every turn.
 * Cured by healing.
+| altname = Oh no I'm bleeding
+| types = Diseased
+| duration =
 }}
+</nowiki>
-== Save only ==
+| <nowiki>
+Inline example: {{Condition/Format
-{{Condition/Format
+| page = Bleeding (Condition)
 | name = Bleeding
 | icon = Bleeding Condition Icon.webp
-| save = CON
+| inline = true
-| effects =
+| types = diseased
-* Inflicts damage every turn.
+}}. Blah blah blah.
-* Cured by healing.
+</nowiki>
 }}
-== Icon and name only ==
+== Template data ==
+<templatedata>
-{{Condition/Format
+{
-| name = Bleeding
+	"description": "Display a block of information about a condition.",
-| icon = Bleeding Condition Icon.webp
+    "format": "inline",
-| effects =
+	"params": {
-* Inflicts damage every turn.
+        "page": {
-* Cured by healing.
+			"description": "Condition page to link to.",
-| skip effect = true
+			"required": true,
-}}
+			"label": "name",
+			"type": "wiki-page-name"
+		},
+		"name": {
+			"description": "Name of the condition.",
+			"required": true,
+			"label": "name",
+			"type": "string"
+		},
+        "icon": {
+			"description": "Icon file of the condition.",
+			"required": true,
+			"label": "icon",
+			"type": "wiki-file-name"
+		},
+        "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"
+        },
+        "types": {
+            "description": "Any condition types the condition belongs to.",
+            "type": "string",
+            "example": "Diseased"
+        },
+		"radius m": {
+            "description": "Radius of the condition in metres. This is rarely used.",
+            "type": "number"
+        },
+        "inline": {
+			"description": "Whether the condition should be formatted inline. See also Template:Condition inline.",
+			"type": "boolean",
+            "deprecated": true
+		}
+	}
+}
+</templatedata>}}
+[[Category:Templates]]
+[[Category:Condition templates]]
+</noinclude>

Template:Condition/Format: Difference between revisions

Latest revision as of 23:24, 21 July 2024

Examples

Template data

Navigation menu

Search