Template:Reaction page/doc

From bg3.wiki
Jump to navigation Jump to search

This template generates formatted section for reactions.

See also

This template has the following subtemplates:

Usage

This template works by displaying a tooltip style box with the reaction details as specified, and also inserts the reactions into a table for later use. It is a cut down version and combination of {{Feature page}} a meant to be included where the reaction is the same name as the passive feature that grants it.

{{Reaction page
| name = 
| description = 
| extra description = 
| higher levels =

<!-- Damage -->
| damage = 
| damage type = 
| damage modifier = 

<!-- Images -->
| image = 
| controller icon = 
| hotbar icon = 

<!-- Properties -->
| cost = 
| save = 
| save dc = 
| on save = 
| targets =
| recharge = 
| ask =

<!-- Conditions applied -->
| condition 1 = 
| condition 1 duration = 
| condition 1 save = 
| condition 1 dc = 
| condition 2 = 
| condition 2 duration = 
| condition 2 save = 
| condition 2 dc = 

<!-- Creature summons -->
| creature 1 = 
| creature 1 hp = 
| creature 1 description = 
| creature 1 duration = 
| creature 2 = 
| creature 2 hp = 
| creature 2 description = 
| creature 2 duration = 

<!-- Technical information -->
| uid = 
| interrupt context = 
| enable context = 
| stack = 
}}

Examples

Entropic Ward

Markup
{{Reaction page
| name = Entropic Ward <!-- This can usually be omitted if it matches the page title -->
| summary = '''Entropic Ward''' is a passive feature/reaction unique to [[The Great Old One]] Warlock subclass.
| description = Impose {{Disadvantage}} on an {{Attack Roll}} against you.<br><br>If the attack misses, you gain {{Advantage}} on your next Attack Roll against the attacker for 1 turn.
| extra description = 

<!-- These images can omitted if the prefixes match the page name -->
| image = Entropic Ward.webp
| controller icon = Entropic Ward Icon.webp
| hotbar icon = Entropic Ward Unfaded Icon.webp

| cost = reaction
| save = 
| on save = 
| targets = One attacking enemy
| ask = yes

| uid = Interrupt_EntropicWard
| interrupt context = OnPostRoll
| enable context = OnActionResourcesChanged
| stack = 

| notes = Notes go here
| bugs = Bugs go here
}}
Renders as
Entropic Ward is a passive feature/reaction unique to The Great Old One Warlock subclass.

Description

Impose DisadvantageDisadvantage on an Attack RollAttack Roll against you.

If the attack misses, you gain AdvantageAdvantage on your next Attack Roll against the attacker for 1 turn.

Properties

Cost
Reaction
Targets: One attacking enemy Targets: One attacking enemy
Ask Ask


Technical details

Ico stats.png UID
Interrupt_EntropicWard
https://bg3.norbyte.dev/search?q=name:Interrupt_EntropicWard+type:interrupt
Ico Report.webp Interrupt Contexts
OnPostRoll
Ico Report.webp Enable Contexts
OnActionResourcesChanged

Notes

Notes go here

Bugs

Bugs go here

With save DC

Markup
{{Reaction page
| summary = '''Soul Catching Boon''' is a free reaction granted by the {{SmRarityItem|Gloves of Soul Catching}} after landing an unarmed strike. It grants the wearer a +5 bonus to a missed {{Attack roll}}, potentially turning it into a hit.

This reaction is mutually exclusive with {{SmSAI|Soul Snare: Heal}} and {{SmSAI|Soul Catching Prowess}}. Only one of these three {{SmPass|Soul Catching}} features can be used in a single turn.
| name = Soul Catching Boon <!-- This can usually be omitted if it matches the page title -->
| description = Gain +5 bonus on your next {{Attack Roll}}.

<!-- These images can omitted if the prefixes match the page name -->
| image = Generic Buff.webp
| controller icon = Generic Buff Icon.webp
| hotbar icon = Generic Buff Unfaded Icon.webp

| cost = reaction
| save = WIS
| save dc = caster
| targets = One attacking enemy
| recharge = Per turn
| uid = Interrupt_Legendary_SoulCatching_Attack
| ask = yes
| interrupt context = OnPostRoll
| enable context = OnStatusApplied;OnStatusRemoved

}}
Renders as
Soul Catching Boon is a free reaction granted by the Gloves of Soul Catching after landing an unarmed strike. It grants the wearer a +5 bonus to a missed Attack RollAttack Roll, potentially turning it into a hit. This reaction is mutually exclusive with Soul Snare: HealSoul Snare: Heal and Soul Catching ProwessSoul Catching Prowess. Only one of these three Soul CatchingSoul Catching features can be used in a single turn.

Description

Gain +5 bonus on your next Attack RollAttack Roll.

Properties

Cost
Reaction
WIS Save (Spell save DC)WIS Save (Spell save DC)
Targets: One attacking enemy Targets: One attacking enemy
Recharge: Per turn Recharge: Per turn
Ask Ask


Technical details

Ico stats.png UID
Interrupt_Legendary_SoulCatching_Attack
https://bg3.norbyte.dev/search?q=name:Interrupt_Legendary_SoulCatching_Attack+type:interrupt
Ico Report.webp Interrupt Contexts
OnPostRoll
Ico Report.webp Enable Contexts
OnStatusApplied, OnStatusRemoved

With recharge and extra description

Markup
{{Reaction page
| name = Sneak Attack (Critical Hit)
| description = Deal extra damage to a foe you have {{Advantage}} against.
| extra description = You can also Sneak Attack targets {{Cond|Threatened}} by adjacent allies provided you aren't attacking with {{Disadvantage}}.
| image = Sneak Attack Melee.webp
| controller icon = Sneak Attack Melee Icon.webp
| hotbar icon = Sneak Attack Melee Unfaded Icon.webp

| ask = 
| recharge = Per turn

| uid = Interrupt_SneakAttack_Critical
| interrupt context = OnCastHit
| enable context = OnActionResourcesChanged;OnEquip
| stack = SneakAttack
}}
Renders as

Description

Deal extra damage to a foe you have AdvantageAdvantage against.

You can also Sneak Attack targets ThreatenedThreatened by adjacent allies provided you aren't attacking with DisadvantageDisadvantage.

Properties

Recharge: Per turn Recharge: Per turn


Technical details

Ico stats.png UID
Interrupt_SneakAttack_Critical
https://bg3.norbyte.dev/search?q=name:Interrupt_SneakAttack_Critical+type:interrupt
Ico Report.webp Interrupt Contexts
OnCastHit
Ico Report.webp Enable Contexts
OnActionResourcesChanged, OnEquip
SneakAttack https://bg3.norbyte.dev/search?q=%22data%2CStack%2CSneakAttack%22

Template data

Page generating template for any reaction.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Reaction namename

The name of the reaction, as it is displayed. This can be omitted if the page name matches the name exactly.

Example
Opportunity Attack
Stringoptional
Reaction descriptiondescription

This is the full in-game description of the reaction. Try to reflect the in-game description as closely as possible, but any errors in the in-game description should be corrected (and noted).

Contentrequired
Extra descriptionextra description

The extra in-game description of the reaction, shown when the tooltip is locked on screen. This content will also be collapsed in feature boxes and similar contexts.

Contentoptional
Changes at higher levelshigher levels

Describes how this reaction scales with level.

Example
When the spell is cast at 2nd Level or higher, the damage increases 1d6 Fire damage for each spell slot level above 1st.
Contentoptional
Tooltip imageimage

This is the reaction's in-game 380x380 tooltip image. This can be omitted if the desired image is {{PAGENAME}}.webp.

Example
Opportunity Attack.webp
Filesuggested
Controller iconcontroller icon

This is the reaction's 144x144 tooltip image used for the controller interface. This can be omitted if the desired image is {{PAGENAME}} Icon.webp.

Example
Opportunity Attack Icon.webp
Filesuggested
Iconhotbar icon

This is the reaction's in-game 64x64 hotbar icon used in the keyboard and mouse interface. This can be omitted if the desired image is {{PAGENAME}} Unfaded Icon.webp.

Example
Defensive Duellist Unfaded Icon.webp
Filesuggested
Resource costcost

The resource(s) needed to use this reaction. This is a comma separated list of resource names. Refer to Template:Resource for the complete list of resource names and aliases.

Suggested values
action bonus reaction spell1 l1
Example
reaction, level1
Stringsuggested
Saving throwsave

Specify the ability score for saving throw used by this reaction.

Suggested values
STR DEX CON WIS INT CHA
Example
WIS
Stringoptional
Saving throw DCsave dc

The DC for the saving throw of this reaction. This can be a fixed value or a special variable like caster or weapon action.

Suggested values
16 caster weapon action
Example
15
Stringoptional
On save effecton save

Used in conjunction with 'save', describes what happens when the target successfully makes their saving throw.

Suggested values
Targets still take half damage.
Example
Targets still take half damage.
Stringoptional
Affected targetstargets

This indicates what this reaction targets or affects.

Example
Enemies only
Stringoptional
Recharge frequencyrecharge

The frequency of recharge for this reaction, if any.

Suggested values
Long Rest Short Rest Per battle Per turn
Example
Per turn
Stringoptional
Additional propertiesadditional

Freeform field for adding any additional properties to the reaction.

Contentoptional
Askask

Whether this reaction defaults to yes when deciding whether to ask the user to trigger.

Example
yes
Stringoptional
UID(s)uid uids

The UID of the reaction as defined in the Stats/Generated files. For actions with multiple variants, multiple UIDs can be specified with a comma separated list. Additional optional information can also be added to each UID with a ":" separator.

Example
Interrupt_LegendaryResistance:Generic version, Interrupt_LegendaryResistance_Strength:Strength specific version
Stringoptional
Interrupt context flagsinterrupt context

A semi-colon separated list of the interrupt contexts of this reaction. These define when the reaction actually triggers.

Suggested values
OnCastHit OnPostRoll OnPreDamage OnSpellCast OnLeaveAttackRange OnEnterAttackRange OnStatusApplied
Example
OnPostRoll
Stringoptional
Enable context flagsenable context

A semi-comma separated list of the enable contexts of this reaction. These define flags that will enable or disable the reaction.

Suggested values
OnStatusApplied OnStatusRemoved OnActionResourcesChanged OnEquip
Example
OnStatusApplied
Stringoptional
Stackstack

The stack this reaction belongs to. Only one reaction per stack can be triggered at any time.

Suggested values
BardicInspiration DivineSmite SwarmKeeper HellishRebuke LegendaryResistance SongOfDefense SneakAttack CosmicOmen HeartOfTheStorm BendLuck AttackOfOpportunity
Example
BardicInspiration
Stringoptional