The Deadlock Wiki

Template:AbilityInteraction/doc: Difference between revisions

Browse history interactively
Newer edit →

Vergir (talk | contribs)

2 user groups
1,624 edits
undo
VisualWikitext
Vergir (talk | contribs)
Contributors, Interface administrators
1,624 edits
Create documentation for AbilityInteraction template (with help from vergir-bot LLM)
 
Vergir (talk | contribs)
Contributors, Interface administrators
1,624 edits
m clarify docs
Line 1: Line 1:
== Usage ==
== Usage ==
{{tl|AbilityInteraction}} displays a boxed note describing how a specific ability interacts with an item or mechanic. It is intended for hero and ability pages, where several boxes are usually stacked together. Each call renders one box: a coloured header and a body.


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. The {{code|1=link}} parameter accepts either a bare page name or a full URL.
{{tl|AbilityInteraction}} displays a boxed note describing how a specific ability interacts with an item or mechanic.
 
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.
 
== Parameters ==
 
<templatedata>
{
"description": "",
"params": {
"title": {
"description": "Text shown in the box header.",
"type": "string",
"required": true
},
"type": {
"description": "Header colour: positive (green), negative (red), or info (blue).",
"type": "string",
"required": true,
"suggestedvalues": [ "positive", "negative", "info" ]
},
"file": {
"description": "File name of the icon image, without the File: prefix.",
"type": "string",
"example": "Healing Booster.png",
"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": {
"description": "Set to disabled to desaturate the icon.",
"type": "string",
"suggestedvalues": [ "disabled" ]
}
},
"paramOrder": [ "title", "text", "type", "file", "link", "state" ],
"format": "block"
}
</templatedata>


== Examples ==
== Examples ==
=== Positive Interaction ===
<pre>
<pre>
{{AbilityInteraction
{{AbilityInteraction
| type  = positive
| type  = positive
| file  = Healing Booster.png
| file  = Melee Charge.png
| link  = Healing Booster
| link  = Melee Charge
| title = Healing Booster
| title = Melee
| text  = The [[Healing]] from this ability is amplified.
| text  = This ability benefits from Melee damage bonuses and triggers relevant item effects.
}}
}}
</pre>
</pre>
{{AbilityInteraction
{{AbilityInteraction
| type  = positive
| type  = positive
| file  = Healing Booster.png
| file  = Melee Charge.png
| link  = Healing Booster
| link  = Melee Charge
| title = Healing Booster
| title = Melee
| text  = The [[Healing]] from this ability is amplified.
| text  = This ability benefits from Melee damage bonuses and triggers relevant item effects.
}}
}}
=== Negative Interaction ===
<pre>
{{AbilityInteraction
| type  = negative
| file  = Debuff Reducer.png
| link  = Debuff Reducer
| title = Debuff Resist
| text  = The duration of movement slow and accuracy debuff can be shortened with [[Debuff Resist]].
}}
</pre>
{{AbilityInteraction
| type  = negative
| file  = Debuff Reducer.png
| link  = Debuff Reducer
| title = Debuff Resist
| text  = The duration of movement slow and accuracy debuff can be shortened with [[Debuff Resist]].
}}
=== Neutral interaction with disabled state ===


<pre>
<pre>
Line 41: Line 109:
}}
}}


<templatedata>
<noinclude>[[Category:Template documentation]]</noinclude>
{
"description": "Displays a boxed note describing how an ability interacts with an item or mechanic. One call renders one box.",
"params": {
"title": {
"label": "Header title",
"description": "Text shown in the box header.",
"type": "string",
"required": true
},
"text": {
"label": "Body text",
"description": "Wikitext shown in the box body. May contain wikilinks, templates such as AbilityIcon, and <br> for multiple lines.",
"type": "content",
"required": true
},
"type": {
"label": "Colour preset",
"description": "Header colour: positive (green), negative (red), or info (blue).",
"type": "line",
"suggestedvalues": [ "positive", "negative", "info" ]
},
"file": {
"label": "Icon file",
"description": "File name of the icon image, without the File: prefix.",
"type": "wiki-file-name",
"example": "Healing Booster.png"
},
"link": {
"label": "Link target",
"description": "Where the header and icon link. A bare page name (e.g. Healing Booster) or a full URL.",
"type": "string",
"example": "Healing Booster"
},
"state": {
"label": "State",
"description": "Set to disabled to desaturate the icon.",
"type": "line",
"suggestedvalues": [ "disabled" ]
}
},
"paramOrder": [ "title", "text", "type", "file", "link", "state" ],
"format": "block"
}
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>
Retrieved from "https://deadlock.wiki/Template:AbilityInteraction/doc"