Template:AbilityInteraction/doc - Revision history

Vergir: Restore original wording of the text param description (with help from vergir-bot LLM)

2026-08-02T10:20:33Z

Restore original wording of the text param description (with help from vergir-bot LLM)

← Older revision		Revision as of 10:20, 2 August 2026
Line 19:		Line 19:
	},		},
	"text": {		"text": {
	"description": "Wikitext shown in the body ~~of the box~~. May contain wikilinks, templates such as AbilityIcon, and lists.",		"description": "Wikitext shown in the box body. May contain wikilinks, templates such as AbilityIcon, and lists.",
	"type": "content",		"type": "content",
	"required": true		"required": true

Vergir: Document the "enhanced" state (with help from vergir-bot LLM)

2026-08-02T10:16:33Z

Document the "enhanced" state (with help from vergir-bot LLM)

← Older revision		Revision as of 10:16, 2 August 2026
Line 19:		Line 19:
	},		},
	"text": {		"text": {
	"description": "Wikitext shown in the box ~~body~~. May contain wikilinks, templates such as AbilityIcon, and lists.",		"description": "Wikitext shown in the body of the box. May contain wikilinks, templates such as AbilityIcon, and lists.",
	"type": "content",		"type": "content",
	"required": true		"required": true
	},		},
	"state": {		"state": {
	"description": "Omit when the interaction applies normally. Use partial when it applies only in part, or disabled when it does not apply at all.",		"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": [ "partial", "disabled" ]		"suggestedvalues": [ "partial", "disabled", "enhanced" ]
	}		}
	},		},
Line 49:		Line 49:
	\| text =		\| text =
	Affects the charge's duration and, consequently, distance the charge covers.		Affects the charge's duration and, consequently, distance the charge covers.
			}}

			=== Enhanced interaction ===

			<pre>
			{{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.
			}}
			</pre>
			{{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.
	}}		}}

Vergir: another doc update.

2026-07-15T15:56:32Z

another doc update.

← Older revision		Revision as of 15:56, 15 July 2026
Line 40:		Line 40:
	<pre>		<pre>
	{{AbilityInteraction		{{AbilityInteraction
	\| interaction = ~~dispel~~		\| interaction = Ability Duration
	\| text =		\| text =
	* Any dispel immediately "drops" the ~~target off~~ the ~~cart~~.		Affects the charge's duration and, consequently, distance the charge covers.
	}}		}}
	</pre>		</pre>
	{{AbilityInteraction		{{AbilityInteraction
	\| interaction = ~~dispel~~		\| interaction = Ability Duration
	\| text =		\| text =
	* Any dispel immediately "drops" the ~~target off~~ the ~~cart~~.		Affects the charge's duration and, consequently, distance the charge covers.
	}}		}}

Line 70:		Line 70:
	}}		}}

	=== Interaction ~~that does not apply~~ ===		=== Disabled Interaction ===

	<pre>		<pre>
Line 94:		Line 94:

	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.		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>

Vergir: update doc

2026-07-15T15:52:08Z

update doc

← Older revision		Revision as of 15:52, 15 July 2026
Line 1:		Line 1:
	== Usage ==		== Usage ==

	{{tl\|AbilityInteraction}} displays a boxed note describing how an ability interacts with an item or mechanic. It is ~~meant for the {{code\|1=interactions}} parameter of~~ {{tl\|~~AbilitySection~~}}.		{{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 interaction is chosen by name from a registry in [[Module:AbilityInteraction]], which supplies the header text, color, icon~~, ~~and link. Call sites supply only~~ the ~~body text~~ and~~, where relevant, a state.~~		To use this template, look at the list of possible Interactions and examples of usage below.

	Nothing else is customizable, and that is deliberate: it keeps a given mechanic looking identical everywhere it appears. A box that needs custom presentation should use {{tl\|IconBox}} directly rather than adding parameters here.

	Setting {{code\|1=state{{=}}disabled}} always produces a neutral (blue) header, whatever type the registry entry declares. A disabled box means the interaction does not apply, so it carries no positive or negative meaning.

	== Parameters ==		== Parameters ==
Line 13:		Line 9:
	<templatedata>		<templatedata>
	{		{
	"description": "~~A boxed note describing how an ability interacts with an item or mechanic. Presentation comes from a registry in Module:AbilityInteraction.~~",		"description": "",
	"params": {		"params": {
	"interaction": {		"interaction": {
Line 20:		Line 16:
	"required": true,		"required": true,
	"example": "debuff resist",		"example": "debuff resist",
	"suggestedvalues": [ "~~debuff resist", "dispel", "indomitable", "slowing hex", "unstoppable~~" ]		"suggestedvalues": [ "(see full list below)" ]
	},		},
	"text": {		"text": {
Line 37:		Line 33:
	}		}
	</templatedata>		</templatedata>

	~~An unrecognized {{code\|1=interaction}} renders a visible error in place of the box. An unrecognized {{code\|1=state}} does not — it renders as though no state were given.~~

	~~== 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]]. Each entry sets {{code\|aliases}}, {{code\|title}}, {{code\|type}}, {{code\|iconfile}}, and {{code\|link}}. The table above and the parameter suggestions update on their own.

	~~The registry key and its aliases are matched in lower case. Aliases are assumed not to collide with each other.~~

	== Examples ==		== Examples ==
Line 102:		Line 84:
	\| text = This ability is '''not''' interrupted by [[Slowing Hex]].		\| 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.

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

Vergir: Rewrite for the interaction registry: three parameters, self-generating registry table, and a pointer to IconBox for custom boxes (with help from vergir-bot LLM)

2026-07-15T14:27:31Z

Rewrite for the interaction registry: three parameters, self-generating registry table, and a pointer to IconBox for custom boxes (with help from vergir-bot LLM)

Diff

~2026-DefendRapidObjective662: Update docs for the file to iconfile parameter rename (with help from vergir-bot LLM)

2026-07-14T22:02:32Z

Update docs for the file to iconfile parameter rename (with help from vergir-bot LLM)

← Older revision		Revision as of 22:02, 14 July 2026
Line 22:		Line 22:
	"suggestedvalues": [ "positive", "negative", "info" ]		"suggestedvalues": [ "positive", "negative", "info" ]
	},		},
	"~~file~~": {		"iconfile": {
	"description": "File name of the icon image, without the File: prefix.",		"description": "File name of the icon image, without the File: prefix.",
	"type": "string",		"type": "string",
Line 44:		Line 44:
	}		}
	},		},
	"paramOrder": [ "title", "text", "type", "~~file~~", "link", "state" ],		"paramOrder": [ "title", "text", "type", "iconfile", "link", "state" ],
	"format": "block"		"format": "block"
	}		}
Line 55:		Line 55:
	<pre>		<pre>
	{{AbilityInteraction		{{AbilityInteraction
	\| type = positive		\| type = positive
	\| ~~file~~ = Melee Charge.png		\| iconfile = Melee Charge.png
	\| link = Melee Charge		\| link = Melee Charge
	\| title = Melee		\| title = Melee
	\| text =		\| text =
	* This ability benefits from Melee damage bonuses and triggers relevant item effects.		* This ability benefits from Melee damage bonuses and triggers relevant item effects.
	* Once a T3 upgrade is acquired it's considered a Heavy Melee attack.		* Once a T3 upgrade is acquired it's considered a Heavy Melee attack.
Line 65:		Line 65:
	</pre>		</pre>
	{{AbilityInteraction		{{AbilityInteraction
	\| type = positive		\| type = positive
	\| ~~file~~ = Melee Charge.png		\| iconfile = Melee Charge.png
	\| link = Melee Charge		\| link = Melee Charge
	\| title = Melee		\| title = Melee
	\| text =		\| text =
	* This ability benefits from Melee damage bonuses and triggers relevant item effects.		* This ability benefits from Melee damage bonuses and triggers relevant item effects.
	* Once a T3 upgrade is acquired it's considered a Heavy Melee attack.		* Once a T3 upgrade is acquired it's considered a Heavy Melee attack.
Line 77:		Line 77:
	<pre>		<pre>
	{{AbilityInteraction		{{AbilityInteraction
	\| type = negative		\| type = negative
	\| ~~file~~ = Debuff Reducer.png		\| iconfile = Debuff Reducer.png
	\| link = Debuff Reducer		\| link = Debuff Reducer
	\| title = Debuff Resist		\| title = Debuff Resist
	\| text =		\| text =
	[[Debuff Resist]] shortens the duration of movement slow and accuraccy debuff.		[[Debuff Resist]] shortens the duration of movement slow and accuraccy debuff.

Line 88:		Line 88:
	</pre>		</pre>
	{{AbilityInteraction		{{AbilityInteraction
	\| type = negative		\| type = negative
	\| ~~file~~ = Debuff Reducer.png		\| iconfile = Debuff Reducer.png
	\| link = Debuff Reducer		\| link = Debuff Reducer
	\| title = Debuff Resist		\| title = Debuff Resist
	\| text =		\| text =
	[[Debuff Resist]] shortens the duration of movement slow and accuraccy debuff.		[[Debuff Resist]] shortens the duration of movement slow and accuraccy debuff.

Line 102:		Line 102:
	<pre>		<pre>
	{{AbilityInteraction		{{AbilityInteraction
	\| type = info		\| type = info
	\| ~~file~~ = Slowing Hex.png		\| iconfile = Slowing Hex.png
	\| link = Slowing Hex		\| link = Slowing Hex
	\| title = Slowing Hex		\| title = Slowing Hex
	\| state = disabled		\| state = disabled
	\| text = This ability is '''not''' interrupted by [[Slowing Hex]].		\| text = This ability is '''not''' interrupted by [[Slowing Hex]].
	}}		}}
	</pre>		</pre>
	{{AbilityInteraction		{{AbilityInteraction
	\| type = info		\| type = info
	\| ~~file~~ = Slowing Hex.png		\| iconfile = Slowing Hex.png
	\| link = Slowing Hex		\| link = Slowing Hex
	\| title = Slowing Hex		\| title = Slowing Hex
	\| state = disabled		\| state = disabled
	\| text = This ability is '''not''' interrupted by [[Slowing Hex]].		\| text = This ability is '''not''' interrupted by [[Slowing Hex]].
	}}		}}

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

Vergir at 14:46, 14 July 2026

2026-07-14T14:46:49Z

← Older revision		Revision as of 14:46, 14 July 2026
Line 59:		Line 59:
	\| link = Melee Charge		\| link = Melee Charge
	\| title = Melee		\| title = Melee
	\| text = This ability benefits from Melee damage bonuses and triggers relevant item effects.		\| text =
			* This ability benefits from Melee damage bonuses and triggers relevant item effects.
			* Once a T3 upgrade is acquired it's considered a Heavy Melee attack.
	}}		}}
	</pre>		</pre>
Line 67:		Line 69:
	\| link = Melee Charge		\| link = Melee Charge
	\| title = Melee		\| title = Melee
	\| text = This ability benefits from Melee damage bonuses and triggers relevant item effects.		\| text =
			* This ability benefits from Melee damage bonuses and triggers relevant item effects.
			* Once a T3 upgrade is acquired it's considered a Heavy Melee attack.
	}}		}}

Line 77:		Line 81:
	\| link = Debuff Reducer		\| link = Debuff Reducer
	\| title = Debuff Resist		\| title = Debuff Resist
	\| text = ~~The~~ duration of movement slow and ~~accuracy~~ debuff ~~can be~~ shortened ~~with [[Debuff Resist]]~~.		\| text =
			[[Debuff Resist]] shortens the duration of movement slow and accuraccy debuff.

			The duration of damage-over-time effect is '''not''' shortened.
	}}		}}
	</pre>		</pre>
Line 85:		Line 92:
	\| link = Debuff Reducer		\| link = Debuff Reducer
	\| title = Debuff Resist		\| title = Debuff Resist
	\| text = ~~The~~ duration of movement slow and ~~accuracy~~ debuff ~~can be~~ shortened ~~with [[Debuff Resist]]~~.		\| text =
			[[Debuff Resist]] shortens the duration of movement slow and accuraccy debuff.

			The duration of damage-over-time effect is '''not''' shortened.
	}}		}}

Line 96:		Line 106:
	\| link = Slowing Hex		\| link = Slowing Hex
	\| title = Slowing Hex		\| title = Slowing Hex
			\| state = disabled
	\| text = This ability is '''not''' interrupted by [[Slowing Hex]].		\| text = This ability is '''not''' interrupted by [[Slowing Hex]].
	~~\| state = disabled~~
	}}		}}
	</pre>		</pre>
Line 105:		Line 115:
	\| link = Slowing Hex		\| link = Slowing Hex
	\| title = Slowing Hex		\| title = Slowing Hex
			\| state = disabled
	\| text = This ability is '''not''' interrupted by [[Slowing Hex]].		\| text = This ability is '''not''' interrupted by [[Slowing Hex]].
	~~\| state = disabled~~
	}}		}}

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

Vergir: clarify docs

2026-07-14T14:35:54Z

clarify docs

Diff

Vergir: Create documentation for AbilityInteraction template (with help from vergir-bot LLM)

2026-07-14T14:22:23Z

Create documentation for AbilityInteraction template (with help from vergir-bot LLM)

New page

== 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.

== Examples ==
<pre>
{{AbilityInteraction
| type = positive
| file = Healing Booster.png
| link = Healing Booster
| title = Healing Booster
| text = The [[Healing]] from this ability is amplified.
}}
</pre>
{{AbilityInteraction
| type = positive
| file = Healing Booster.png
| link = Healing Booster
| title = Healing Booster
| text = The [[Healing]] from this ability is amplified.
}}

<pre>
{{AbilityInteraction
| type = info
| file = Slowing Hex.png
| link = Slowing Hex
| title = Slowing Hex
| text = This ability is '''not''' interrupted by [[Slowing Hex]].
| state = disabled
}}
</pre>
{{AbilityInteraction
| type = info
| file = Slowing Hex.png
| link = Slowing Hex
| title = Slowing Hex
| text = This ability is '''not''' interrupted by [[Slowing Hex]].
| state = disabled
}}

<templatedata>
{
"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>