Template:Se/doc: Difference between revisions
no edit summary
No edit summary |
No edit summary Tags: Manual revert Mobile edit Mobile web edit |
||
(13 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__'''Refer to the [[Status Effects#Index of Effect Icons|Index of Effect Icons]] for the full list of images.''' | |||
'''Refer to the [[Status Effects#Index of Effect Icons|Index of Effect Icons]] for | |||
== Usage == | == Usage == | ||
<nowiki>{{se | <nowiki>{{se | ||
| icon = no | |||
| id = | |||
| name = | |||
| alt = | |||
| type = | |||
| tt = no | |||
| label = no | |||
| font = | |||
}}</nowiki> | |||
=== Examples === | === Common Status Effects === | ||
* <code><nowiki>{{se|id=045|name=Super Armor|type=sb}}</nowiki></code> and <code><nowiki>{{se||Super Armor}}</nowiki></code> will return: {{se||Super Armor}} | * {{se|045}} Super Armor | ||
* <code><nowiki>{{se|087|Faint|Stun|ed}}</nowiki></code> and <code><nowiki>{{se||Faint|Stun}}</nowiki></code> will return: {{se||Faint|Stun}} | * {{se|074}} Anti-Magic | ||
* <code><nowiki>{{se|703}}</nowiki></code> will return: {{se|703}}<templatedata> | * {{se|116}} Bleed | ||
* {{se|071}} Burn | |||
* {{se|095}} Confusion | |||
* {{se|079}} Curse | |||
* {{se|094}} Extreme Coldness | |||
* {{se|087}} Faint / Conviction / Power Faint | |||
* {{se|070}} Flattened | |||
* {{se|081}} Freeze | |||
* {{se|458}} Groggy | |||
* {{se|090}} Leg Injury | |||
* {{se|129}} Lethargy | |||
* {{se|236}} Mana Pollution | |||
* {{se|092}} Move Slowdown | |||
* {{se|088}} Panic | |||
* {{se|076}} Poison | |||
* {{se|313}} Silence | |||
* {{se|085}} Wound | |||
=== Types of Status Effects=== | |||
* '''Default''': Self Buff | |||
* '''pb''': Party Buff | |||
* '''aob''': Ally Only Buff | |||
* '''pd''': Party Debuff | |||
* '''aod''': Ally Only Debuff | |||
* '''sapb''': Self/Ally Pick-up Buff | |||
* '''stb''': Selective Target Buff | |||
* '''sb''': Self Buff | |||
* '''sd''': Self Debuff | |||
* '''eb''': Enemy Buff | |||
* '''ed''': Enemy Debuff | |||
* '''sapd''': Self/Ally Pick-up Debuff | |||
* '''cb''': Couple Buff | |||
* '''aoeb''': Ally Only & Enemy Buff | |||
* '''aoed''': Ally Only & Enemy Debuff | |||
===Examples=== | |||
*<code><nowiki>{{se|id=045|name=Super Armor|type=sb}}</nowiki></code> and <code><nowiki>{{se||Super Armor}}</nowiki></code> will return: {{se||Super Armor}} | |||
*<code><nowiki>{{se|087|Faint|Stun|ed}}</nowiki></code> and <code><nowiki>{{se||Faint|Stun}}</nowiki></code> will return: {{se||Faint|Stun}} | |||
*<code><nowiki>{{se||Bleed|icon=no}}</nowiki></code> will return: {{se||Bleed|icon=no}} | |||
*<code><nowiki>{{se||Bleed|tt=no}}</nowiki></code> will return: {{se||Bleed|tt=no}} | |||
*<code><nowiki>{{se||Bleed|label=no}}</nowiki></code> will return: {{se||Bleed|label=no}} | |||
*<code><nowiki>{{se|703}}</nowiki></code> will return: {{se|703}}<templatedata> | |||
{ | { | ||
Line 43: | Line 66: | ||
], | ], | ||
"label": "ID", | "label": "ID", | ||
"description": "The number that identifies the status effect. This parameter can be skipped; the icon will be updated accordingly if the \"name\" parameter matches one of the status effects listed | "description": "The number that identifies the status effect. This parameter can be skipped; the icon will be updated accordingly if the \"name\" parameter matches one of the status effects listed above.", | ||
"example": "105", | "example": "105", | ||
"type": "number", | "type": "number", | ||
Line 56: | Line 79: | ||
"description": "The name of the status effect. Links to Status Effects by default, but it can also link to its own subpage if it exists (i.e. Status Effects/Armor Break).", | "description": "The name of the status effect. Links to Status Effects by default, but it can also link to its own subpage if it exists (i.e. Status Effects/Armor Break).", | ||
"example": "Destruction Aura", | "example": "Destruction Aura", | ||
"type": "string" | "type": "string", | ||
"suggested": true | |||
}, | }, | ||
"3": { | "3": { | ||
Line 62: | Line 86: | ||
"alt" | "alt" | ||
], | ], | ||
"label": "Alternative | "label": "Alternative label", | ||
"description": "An alternative | "description": "An alternative label that does not affect the links nor the icon. This parameter is usually not necessary, but it can be useful in rare ocassions.", | ||
"example": "Stun", | "example": "Stun", | ||
"type": "string" | "type": "string" | ||
Line 72: | Line 96: | ||
], | ], | ||
"label": "Type", | "label": "Type", | ||
"description": "The type of the status effect, i.e. Party Buff or Enemy Debuff displaying in the tooltip's content. | "description": "The type of the status effect, i.e. Party Buff or Enemy Debuff displaying in the tooltip's content. Full list above.", | ||
"example": "pb", | "example": "pb", | ||
"type": "string", | "type": "string", | ||
"default": "Self Buff" | "default": "Self Buff", | ||
"suggested": true | |||
}, | |||
"prefix": { | |||
"label": "Text before", | |||
"type": "string" | |||
}, | |||
"suffix": { | |||
"label": "Text after", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"tt": { | |||
"label": "Tooltip toggle", | |||
"description": "Disables the tooltip. The only input available is \"no\".", | |||
"example": "no", | |||
"type": "string" | |||
}, | |||
"icon": { | |||
"label": "Icon toggle", | |||
"description": "Disables the status effect icon. The \"ID\" parameter becomes useless. The only input available is \"no\".", | |||
"example": "no", | |||
"type": "string" | |||
}, | |||
"label": { | |||
"label": "Label toggle", | |||
"description": "Disables the label. The \"name\" parameter can still be used, if needed, to change the icon's link. The only input available is \"no\".", | |||
"example": "no", | |||
"type": "string" | |||
}, | |||
"font": { | |||
"label": "Font", | |||
"description": "The style of the font. Available: bold, italic, bold italic", | |||
"example": "bold", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
"description": "The '''se''' (short for Status Effect) template is used to display the icons of the game's many status effects. Mainly transcluded on skill pages to make it clear which icon belongs to which skill. When hovering over the name, a tooltip indicating the type of the effect will appear (self, party, etc)." | "description": "The '''se''' (short for Status Effect) template is used to display the icons of the game's many status effects. Mainly transcluded on skill pages to make it clear which icon belongs to which skill. When hovering over the name, a tooltip indicating the type of the effect will appear (self, party, etc).", | ||
"paramOrder": [ | |||
"1", | |||
"2", | |||
"3", | |||
"4", | |||
"font", | |||
"prefix", | |||
"suffix", | |||
"icon", | |||
"tt", | |||
"label" | |||
], | |||
"format": "inline" | |||
} | } | ||
</templatedata> | </templatedata> |