Template:Condition/Format: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
(Created page with "<includeonly><div>[[File:{{{icon}}}|frameless|40px|link=|{{{name}}}]] <strong>{{{name}}}</strong></div> {{#if: {{{duration|}}} | {{InfoBlob| {{Duration|{{{duration}}}}} }} }} {{#if: {{{save|}}} | {{InfoBlob| {{SavingThrow|{{{save}}}}} }} }} {{{effects}}}</includeonly><noinclude> Meant to be used with a Cargo query. Preview: == Single effect description == {{Condition/Format | name = Bleeding | icon = Bleeding Condition Icon.png | duration = 3 | save = CON | effects =...")
 
(Updated documentation and added category)
 
(41 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<includeonly><div>[[File:{{{icon}}}|frameless|40px|link=|{{{name}}}]] <strong>{{{name}}}</strong></div>
<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|}}} |
{{#if: {{{duration|}}} |
<p>{{InfoBlob | {{Duration | {{{duration}}} }} }}</p>
{{InfoBlob| {{Duration|{{{duration}}}}} }}
}}{{#if: {{{save|}}} |
}} {{#if: {{{save|}}} |
<p>{{InfoBlob | {{SavingThrow | {{{save}}} | dc = {{{dc|}}} }} }}</p>
{{InfoBlob| {{SavingThrow|{{{save}}}}} }}
}}{{#if: {{{radius m|}}} |
<p>{{InfoBlob | {{Radius | m = {{{radius m}}} | showtext = true }} }}</p>
}}
}}
{{{effects}}}</includeonly><noinclude>
<div>
Meant to be used with a Cargo query.  Preview:
{{{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.png
| save = {{{condition save|}}}
| duration = 3
| dc = {{{condition dc|}}}
| save = CON
| duration = {{{condition duration|}}}
| effects = Inflicts damage every turn.
}}
}}
</div>


== Duration only ==
}} {{#if: {{{condition2|}}} |


{{Condition/Format
<h3> Condition: {{{condition2}}} </h3>
| name = Bleeding
 
| icon = Bleeding Condition Icon.png
<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">
| duration = 3
{{Condition | {{{condition2}}}
| effects = Inflicts damage every turn.
| save = {{{condition2 save|}}}
| dc = {{{condition2 dc|}}}
| 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
{{Condition/Format
| page = Bleeding (Condition)
| name = Bleeding
| name = Bleeding
| icon = Bleeding Condition Icon.png
| icon = Bleeding Condition Icon.webp
| save = CON
| effects = Bleeds you out.
| effects = Inflicts damage every turn.
}}
}}
 
</nowiki>
= Effect listing =
| <nowiki>
 
{{Condition/Format
{{Condition/Format
| page = Bleeding (Condition)
| name = Bleeding
| name = Bleeding
| icon = Bleeding Condition Icon.png
| icon = Bleeding Condition Icon.webp
| duration = 3
| save = CON
| 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
{{Condition/Format
| page = Bleeding (Condition)
| name = Bleeding
| name = Bleeding
| icon = Bleeding Condition Icon.png
| icon = Bleeding Condition Icon.webp
| duration = 3
| effects =
| effects =
* Inflicts damage every turn.
* Inflicts damage every turn.
* Cured by healing.
* 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
| name = Bleeding
| icon = Bleeding Condition Icon.png
| icon = Bleeding Condition Icon.webp
| save = CON
| inline = true
| effects =
| types = diseased
* Inflicts damage every turn.
}}. Blah blah blah.
* Cured by healing.
</nowiki>
}}
}}
== Template data ==
<templatedata>
{
"description": "Display a block of information about a condition.",
    "format": "inline",
"params": {
        "page": {
"description": "Condition page to link to.",
"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>
</noinclude>

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 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 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 Oh no I'm bleeding
  • Inflicts damage every turn.
  • Cured by healing.
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 Bleeding. Blah blah blah.

Template data

Display a block of information about a condition.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
namepage

Condition page to link to.

Page namerequired
namename

Name of the condition.

Stringrequired
iconicon

Icon file of the condition.

Filerequired
altnamealtname

An alternative display name for the condition link.

Stringoptional
durationduration

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
Stringoptional
savesave

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
Stringoptional
dcdc

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
Stringoptional
typestypes

Any condition types the condition belongs to.

Example
Diseased
Stringoptional
radius mradius m

Radius of the condition in metres. This is rarely used.

Numberoptional
inlineinline

Whether the condition should be formatted inline. See also Template:Condition inline.

Booleandeprecated
Subpages of this template.
Retrieved from "https://dev.bg3.wiki/w/index.php?title=Template:Condition/Format&oldid=209956"