Template:AbilityInteraction/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Vergir (talk | contribs)
m clarify docs
Vergir (talk | contribs)
Restore original wording of the text param description (with help from vergir-bot LLM)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Usage ==
== Usage ==


{{tl|AbilityInteraction}} displays a boxed note describing how a specific ability interacts with an item or mechanic.
{{tl|AbilityInteraction}} displays a boxed note describing how an ability interacts with an item or mechanic. Under the hood it is a fancy wrapper around {{tl|IconBox}}.


The header colour is set by the {{code|1=type}} parameter ({{code|positive}}, {{code|negative}}, or {{code|info}}). Setting {{code|1=state=disabled}} desaturates the icon to mark an interaction that does not apply.
To use this template, look at the list of possible Interactions and examples of usage below.


== Parameters ==
== Parameters ==
Line 11: Line 11:
"description": "",
"description": "",
"params": {
"params": {
"title": {
"interaction": {
"description": "Text shown in the box header.",
"description": "Name of the interaction in the registry. Case-insensitive, and aliases are accepted. The Interactions section of this page lists every available name.",
"type": "string",
"required": true
},
"type": {
"description": "Header colour: positive (green), negative (red), or info (blue).",
"type": "string",
"type": "string",
"required": true,
"required": true,
"suggestedvalues": [ "positive", "negative", "info" ]
"example": "debuff resist",
"suggestedvalues": [ "(see full list below)" ]
},
},
"file": {
"text": {
"description": "File name of the icon image, without the File: prefix.",
"description": "Wikitext shown in the box body. May contain wikilinks, templates such as AbilityIcon, and lists.",
"type": "string",
"type": "content",
"example": "Healing Booster.png",
"required": true
"required": true
},
"link": {
"description": "Where the header and icon link. A bare page name (e.g. Healing Booster) or a full URL.",
"type": "string",
"example": "Healing Booster",
"required": true
},
"text": {
"description": "Wikitext shown in the box body. May contain wikilinks, templates such as AbilityIcon, and <br> for multiple lines.",
"type": "content"
},
},
"state": {
"state": {
"description": "Set to disabled to desaturate the icon.",
"description": "Omit when the interaction applies normally. Use partial when it applies only in part, disabled when it does not apply at all, or enhanced when it applies more strongly than usual.",
"type": "string",
"type": "string",
"suggestedvalues": [ "disabled" ]
"suggestedvalues": [ "partial", "disabled", "enhanced" ]
}
}
},
},
"paramOrder": [ "title", "text", "type", "file", "link", "state" ],
"paramOrder": [ "interaction", "text", "state" ],
"format": "block"
"format": "block"
}
}
Line 51: Line 36:
== Examples ==
== Examples ==


=== Positive Interaction ===
=== Standard interaction ===


<pre>
<pre>
{{AbilityInteraction
{{AbilityInteraction
| type  = positive
| interaction = Ability Duration
| file  = Melee Charge.png
| text =
| link  = Melee Charge
Affects the charge's duration and, consequently, distance the charge covers.
| title = Melee
| text  = This ability benefits from Melee damage bonuses and triggers relevant item effects.
}}
}}
</pre>
</pre>
{{AbilityInteraction
{{AbilityInteraction
| type  = positive
| interaction = Ability Duration
| file  = Melee Charge.png
| text =
| link  = Melee Charge
Affects the charge's duration and, consequently, distance the charge covers.
| title = Melee
| text  = This ability benefits from Melee damage bonuses and triggers relevant item effects.
}}
}}


=== Negative Interaction ===
=== Enhanced interaction ===
 
<pre>
<pre>
{{AbilityInteraction
{{AbilityInteraction
| type  = negative
| interaction = cooldown
| file  = Debuff Reducer.png
| state = enhanced
| link  = Debuff Reducer
| text = Cooldown reduction applies to each charge separately, so it is far more effective here than on a single-charge ability.
| title = Debuff Resist
| text = The duration of movement slow and accuracy debuff can be shortened with [[Debuff Resist]].
}}
}}
</pre>
</pre>
{{AbilityInteraction
{{AbilityInteraction
| type  = negative
| interaction = cooldown
| file  = Debuff Reducer.png
| state = enhanced
| link  = Debuff Reducer
| text = Cooldown reduction applies to each charge separately, so it is far more effective here than on a single-charge ability.
| title = Debuff Resist
| text = The duration of movement slow and accuracy debuff can be shortened with [[Debuff Resist]].
}}
}}


=== Neutral interaction with disabled state ===
=== Partial interaction ===


<pre>
<pre>
{{AbilityInteraction
{{AbilityInteraction
| type  = info
| interaction = unstoppable
| file  = Slowing Hex.png
| state = partial
| link  = Slowing Hex
| text =
| title = Slowing Hex
* Dispels and protects against [[Move Slow]].
| text = This ability is '''not''' interrupted by [[Slowing Hex]].
* Does not dispel or protect against the accuracy debuff.
}}
</pre>
{{AbilityInteraction
| interaction = unstoppable
| state = partial
| text =
* Dispels and protects against [[Move Slow]].
* Does not dispel or protect against the accuracy debuff.
}}
 
=== Disabled Interaction ===
 
<pre>
{{AbilityInteraction
| interaction = slowing hex
| state = disabled
| state = disabled
| text = This ability is '''not''' interrupted by [[Slowing Hex]].
}}
}}
</pre>
</pre>
{{AbilityInteraction
{{AbilityInteraction
| type  = info
| interaction = slowing hex
| file  = Slowing Hex.png
| link  = Slowing Hex
| title = Slowing Hex
| text  = This ability is '''not''' interrupted by [[Slowing Hex]].
| state = disabled
| state = disabled
| text = This ability is '''not''' interrupted by [[Slowing Hex]].
}}
}}
== Interactions ==
This table is generated from the registry, so it always matches what the template accepts.
{{#invoke:AbilityInteraction|list}}
=== Adding an interaction ===
Add an entry to the {{code|REGISTRY}} table at the top of [[Module:AbilityInteraction]]. An entry should contain {{code|title}}, {{code|type}}, {{code|iconfile}}, and {{code|link}}, which pass down to the underlying {{tl|IconBox}}. The {{code|aliases}} just specifies different ways to write an interaction.
Note that the type of the interaction (positive/negative/info) should be chosen according to whether that interaction enhances the ability (positive) or hampers it (negative).


<noinclude>[[Category:Template documentation]]</noinclude>
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 10:20, 2 August 2026

{{AbilityInteraction}} displays a boxed note describing how an ability interacts with an item or mechanic. Under the hood it is a fancy wrapper around {{IconBox}}.

To use this template, look at the list of possible Interactions and examples of usage below.

Parameters

[edit source]

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
interactioninteraction

Name of the interaction in the registry. Case-insensitive, and aliases are accepted. The Interactions section of this page lists every available name.

Suggested values
(see full list below)
Example
debuff resist
Stringrequired
texttext

Wikitext shown in the box body. May contain wikilinks, templates such as AbilityIcon, and lists.

Contentrequired
statestate

Omit when the interaction applies normally. Use partial when it applies only in part, disabled when it does not apply at all, or enhanced when it applies more strongly than usual.

Suggested values
partial disabled enhanced
Stringoptional

Examples

[edit source]

Standard interaction

[edit source]
{{AbilityInteraction
| interaction = Ability Duration
| text =
Affects the charge's duration and, consequently, distance the charge covers.
}}
Ability Duration

Affects the charge's duration and, consequently, distance the charge covers.

Enhanced interaction

[edit source]
{{AbilityInteraction
| interaction = cooldown
| state = enhanced
| text = Cooldown reduction applies to each charge separately, so it is far more effective here than on a single-charge ability.
}}
Ability Cooldown Reduction

Cooldown reduction applies to each charge separately, so it is far more effective here than on a single-charge ability.

Partial interaction

[edit source]
{{AbilityInteraction
| interaction = unstoppable
| state = partial
| text =
* Dispels and protects against [[Move Slow]].
* Does not dispel or protect against the accuracy debuff.
}}
Unstoppable
  • Dispels and protects against Move Slow.
  • Does not dispel or protect against the accuracy debuff.

Disabled Interaction

[edit source]
{{AbilityInteraction
| interaction = slowing hex
| state = disabled
| text = This ability is '''not''' interrupted by [[Slowing Hex]].
}}
Slowing Hex

This ability is not interrupted by Slowing Hex.

Interactions

[edit source]

This table is generated from the registry, so it always matches what the template accepts.

Interaction Example
ability duration / duration / duration extender
Ability Duration

Example text.

ability range / range / greater expansion
Ability Range

Example text.

cooldown / ability cooldown / superior cooldown
debuff resist / debuff reducer
Debuff Resist

Example text.

dispel / dispel magic / purge / cleanse
Dispel

Example text.

echo shard
Echo Shard

Example text.

heal / healing / healing booster
Healing

Example text.

heroic aura
Heroic Aura

Example text.

indomitable
Indomitable

Example text.

interrupt / knockdown / stun
Interrupt

Example text.

monster rounds
Monster Rounds

Example text.

plated armor
Plated Armor

Example text.

reactive barrier
Reactive Barrier

Example text.

slowing hex
Slowing Hex

Example text.

stealth / Veil Walker
Stealth

Example text.

unstoppable
Unstoppable

Example text.

Adding an interaction

[edit source]

Add an entry to the REGISTRY table at the top of Module:AbilityInteraction. An entry should contain title, type, iconfile, and link, which pass down to the underlying {{IconBox}}. The aliases just specifies different ways to write an interaction.

Note that the type of the interaction (positive/negative/info) should be chosen according to whether that interaction enhances the ability (positive) or hampers it (negative).