Template:Condition page: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
(Prevent excess blank paragraph.)
(Moved honour mode changes to inside box. Added support and documentation for Stack ID, Status groups, Tick type, Stack type and Status properties, under new "Properties" section.)
Line 14: Line 14:
{{{effects|}}} {{#if: {{{warning|}}} | <br>
{{{effects|}}} {{#if: {{{warning|}}} | <br>
<p>{{Colour|white|{{{warning}}}}}</p> }}{{#if: {{#lvar:type}} | <br>
<p>{{Colour|white|{{{warning}}}}}</p> }}{{#if: {{#lvar:type}} | <br>
{{Condition type|{{#lvar:type}} }}
{{Condition type|{{#lvar:type}} }}}}{{#if:{{{honour mode|}}}|{{blank}}
}}</div><references/>
 
{{#if:{{{honour mode|}}}|
== [[Honour mode]] ==
== [[Honour mode]] ==
{{{honour mode}}}
{{{honour mode}}}}}{{#if:{{{status groups|}}}{{{tick type|}}}{{{stack type|}}}|{{blank}}
}}{{#if:{{{notes|}}}|
 
== Properties ==
{{#if: {{{stack id|}}}|{{blank}}
 
{{SmallIcon|Info Icon.png|link=Status ID}}[[Stack ID]]: {{code|{{{stack id}}}}}}}{{#if: {{{status groups|}}}|{{blank}}
{{#arraydefine:status groups|{{{status groups|}}}|,}}
{{SmallIcon|Plus Icon.png|link=Status groups}}[[Status groups]]: {{#arrayprint:status groups|,&nbsp;|@|{{SG|@}}}}}}
{{#if: {{{tick type|}}}|{{blank}}
 
{{SmallIcon|Duration Icons.png}}[[Conditions#Duration|Lose duration]]: {{#switch: {{{tick type}}}
| start = start of turn
| end = end of turn
| none = N/A
| #default = !syntax error!
}}}}{{#if: {{{stack type|}}}|{{blank}}
 
{{SmallIcon|Sort Icon.png}}[[Conditions#Stack type|If already applied]]: {{#switch: {{{stack type}}}
| additive = add to duration
| overwrite = replace current
| ignore = don't apply
| none = N/A
| #default = !syntax error!
}}}}{{#if: {{{properties|}}}|{{blank}}
 
{{SmallIcon|Options Icon.png}}[[Status properties|More properties]]:{{#invoke:ParseList|main|{{#arraydefine:propertiesList|{{{properties|}}}|,}}{{#arrayprint:propertiesList|,|@|[[Status properties/@|@]]}}|type=htmlList}}}}}}
</div><references/>
{{#if:{{{notes|}}}|
== Notes ==
== Notes ==
{{{notes}}}
{{{notes}}}
Line 44: Line 69:
| type =
| type =
| honour mode =  
| honour mode =  
| status groups =
| tick type =
| properties =
| stack type =
| notes =
| notes =
}}
}}
Line 57: Line 86:
* Has [[resistance]] against {{DamageType|Bludgeoning}}, {{DamageType|Piercing}}, and {{DamageType|Slashing}} damage dealt by weapon attacks. Damage of these types is halved.
* Has [[resistance]] against {{DamageType|Bludgeoning}}, {{DamageType|Piercing}}, and {{DamageType|Slashing}} damage dealt by weapon attacks. Damage of these types is halved.
| this is an example = yes
| this is an example = yes
| honour mode = * If you get hit by anything you are not resistant too, you immediately die.
| type = Cursed, Prone
| status groups = SG_RemoveOnRespec
| tick type = end
| stack id = BLADE_WARD
| stack type = ignore
| properties = FreezeDuration, IgnoreResting, InitiateCombat, ApplyToDead
| notes = * note 1
| notes = * note 1
* note 2
* note 2
Line 69: Line 105:
* If Undead, has {{Disadvantage}} on [[Attack Roll]]s.
* If Undead, has {{Disadvantage}} on [[Attack Roll]]s.
| this is an example = yes
| this is an example = yes
| tick type = end
| properties = FreezeDuration, IgnoreResting, InitiateCombat, ApplyToDead
}}
}}


Line 127: Line 165:
"type": {
"type": {
"description": "The type or types of the condition. If multiple, separate the types with commas.",
"description": "The type or types of the condition. If multiple, separate the types with commas.",
"type": "string"
"type": "string",
"suggestedvalues": [
"Cursed",
"Diseased",
"Poisoned",
"Polymorphed",
"Charmed",
"Frightened",
"Incapacitated",
"Prone",
"Unconscious",
"Blinded",
"Maimed"
]
},
"status groups": {
"description": "Any status groups the condition belongs too. If multiple, separate the types with commas.",
"type": "string",
"example": "mad, invisible, helpable condition, light, weapon coating, "
},
"tick type": {
"description": "When the condition loses duration. This can be at the start or end of a turn. If marked with '''none''' the condition will be marked as not having a duration. This may be used by conditions who are active based on something else like a passive feature or standing near something.",
"type": "string",
"suggestedvalues": [
            "start",
            "end",
            "none"
            ]
},
"properties": {
"description": "Properties for the condition. If multiple, separate the types with commas.",
"type": "string",
            "example": "FreezeDuration, IgnoreResting, InitiateCombat, ApplyToDead"
},
"stack type": {
"description": "Decides what happends when the condition is applied while already being present. '''additive''' adds the durations together, '''overwrite''' replaces the present condition and duration with the new, and '''ignore''' will keep the present condition and duration. This can be important on conditions who have the same stack ID as other conditions to show which of them takes priority, and for showing if you can increase the duration of a condition by applying it again.",
"type": "string",
"suggestedvalues": [
            "additive",
            "overwrite",
            "ignore"
            ]
},
},
"effects": {
"effects": {

Revision as of 10:48, 28 December 2023

Template documentation

If the page title is Blah (Condition), then you don't have to provide the name parameter. Likewise, if the icon for the condition is called Blah Condition Icon.webp then you don't have to provide the icon parameter.

If a condition has multiple types, separate them with a semicolon.

{{Condition Page
| effects =
| type =
| honour mode = 
| status groups = 
| tick type = 
| properties = 
| stack type = 
| notes =
}}

Examples:

Blade Ward (Condition)

Condition Type Icon.pngCursedProne

Honour mode

  • If you get hit by anything you are not resistant too, you immediately die.

Properties

Status IDStack ID: BLADE_WARD

Status groupsStatus groups: SG_RemoveOnRespec

Lose duration: end of turn

If already applied: don't apply

More properties:

Notes

  • note 1
  • note 2

Sources of Blade Ward


Bone Chilled (Condition)

Properties

Lose duration: end of turn

More properties:

Sources of Bone Chilled


Flesh Rot (Condition)

Condition Type Icon.pngDiseased

Sources of Flesh Rot


Multiple types example

Condition Type Icon.pngDiseasedCursedIncapacitatedProneCharmed

This template defines the table "conditions". View table.

Template data

No description.

Template parameters

ParameterDescriptionTypeStatus
namename

If specified, overrides the name.

Default
Uses the name of the page, minus (Condition).
Stringoptional
iconicon

If specified, overrides the icon.

Default
Uses the "name" plus Condition.webp
Fileoptional
diseasedisease

If specified, sets the type to be disease

Booleandeprecated
typetype

The type or types of the condition. If multiple, separate the types with commas.

Suggested values
Cursed Diseased Poisoned Polymorphed Charmed Frightened Incapacitated Prone Unconscious Blinded Maimed
Stringoptional
status groupsstatus groups

Any status groups the condition belongs too. If multiple, separate the types with commas.

Example
mad, invisible, helpable condition, light, weapon coating,
Stringoptional
tick typetick type

When the condition loses duration. This can be at the start or end of a turn. If marked with '''none''' the condition will be marked as not having a duration. This may be used by conditions who are active based on something else like a passive feature or standing near something.

Suggested values
start end none
Stringoptional
propertiesproperties

Properties for the condition. If multiple, separate the types with commas.

Example
FreezeDuration, IgnoreResting, InitiateCombat, ApplyToDead
Stringoptional
stack typestack type

Decides what happends when the condition is applied while already being present. '''additive''' adds the durations together, '''overwrite''' replaces the present condition and duration with the new, and '''ignore''' will keep the present condition and duration. This can be important on conditions who have the same stack ID as other conditions to show which of them takes priority, and for showing if you can increase the duration of a condition by applying it again.

Suggested values
additive overwrite ignore
Stringoptional
effectseffects

The description of the condition.

Contentsuggested
this is an examplethis is an example

If specified, does not insert into the Conditions table.

Booleanoptional
suppress sourcessuppress sources

If specified, will not display "sources of".

Booleanoptional
honour modehonour mode

Changes that apply under the honour mode difficulty.

Stringoptional
notesnotes

Notes, displayed before the list of sources

Stringoptional