Template:Effect/doc: Difference between revisions
From Archaelund Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
This template contains a list of all combat effects ({{ListFormat|{{Effect|TagList}}|Bullets}}) and converts raw effect input (e.g. " | This template contains a list of all combat effects ({{ListFormat|{{Effect|TagList}}|Bullets}}) and converts raw effect input (e.g. "Poison,3,4,10") into a standardized output format: {{Effect|Poison,3,4,10}}. | ||
== Usage == | == Usage == | ||
| Line 6: | Line 6: | ||
{{Effect|<effect input>}} | {{Effect|<effect input>}} | ||
</pre> | </pre> | ||
where <effect input> represents a vector of | where <effect input> represents a vector of 4 comma-separated entries (e.g. "Poison,3,4,10") detailed below. | ||
For generating a semicolon-separated list of all available effects (intended for documentation purposes) use | For generating a semicolon-separated list of all available effects (intended for documentation purposes) use | ||
| Line 17: | Line 17: | ||
<tr><th>Index</th><th>Description</th><th>Value</th></tr> | <tr><th>Index</th><th>Description</th><th>Value</th></tr> | ||
<tr><td>1</td><td>The name of the effect.</td><td>one of the following tags: {{ListFormat|{{Effect|TagList}}|Bullets}}</td></tr> | <tr><td>1</td><td>The name of the effect.</td><td>one of the following tags: {{ListFormat|{{Effect|TagList}}|Bullets}}</td></tr> | ||
<tr><td>2</td><td>The | <tr><td>2</td><td>The power of the effect.</td><td>positive number</td></tr> | ||
<tr><td>3</td><td>The | <tr><td>3</td><td>The type of resistance which is used for avoiding the effect.</td><td>the index of the resistance (see [[Template:Resistances]])</td></tr> | ||
<tr><td>4</td><td>An optional modifier added to the resistance value.</td><td>arbitary number</td></tr> | |||
</table> | </table> | ||
Revision as of 17:35, 6 February 2025
Description
This template contains a list of all combat effects (Stun • Paralysis • Poison • Gut Boil) and converts raw effect input (e.g. "Poison,3,4,10") into a standardized output format: Poison (Power: 3, Resist: 
+10).
Usage
{{Effect|<effect input>}}
where <effect input> represents a vector of 4 comma-separated entries (e.g. "Poison,3,4,10") detailed below.
For generating a semicolon-separated list of all available effects (intended for documentation purposes) use
{{Effect|TagList}}
Effect input vector
| Index | Description | Value |
|---|---|---|
| 1 | The name of the effect. | one of the following tags: Stun • Paralysis • Poison • Gut Boil |
| 2 | The power of the effect. | positive number |
| 3 | The type of resistance which is used for avoiding the effect. | the index of the resistance (see Template:Resistances) |
| 4 | An optional modifier added to the resistance value. | arbitary number |
