Editing Template:AbilityInteraction/docGive feedback

== Usage ==

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

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

== Parameters ==

<templatedata>
{
	"description": "",
	"params": {
		"interaction": {
			"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,
			"example": "debuff resist",
			"suggestedvalues": [ "(see full list below)" ]
		},
		"text": {
			"description": "Wikitext shown in the box body. May contain wikilinks, templates such as AbilityIcon, and lists.",
			"type": "content",
			"required": true
		},
		"state": {
			"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",
			"suggestedvalues": [ "partial", "disabled", "enhanced" ]
		}
	},
	"paramOrder": [ "interaction", "text", "state" ],
	"format": "block"
}
</templatedata>

== Examples ==

=== Standard interaction ===

<pre>
{{AbilityInteraction
| interaction = Ability Duration
| text =
Affects the charge's duration and, consequently, distance the charge covers.
}}
</pre>
{{AbilityInteraction
| interaction = Ability Duration
| text =
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.
}}

=== Partial interaction ===

<pre>
{{AbilityInteraction
| interaction = unstoppable
| state = partial
| text =
* Dispels and protects against [[Move Slow]].
* 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
| text = This ability is '''not''' interrupted by [[Slowing Hex]].
}}
</pre>
{{AbilityInteraction
| interaction = slowing hex
| 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>