Template:Te/doc: Difference between revisions

From Elwiki
m (Text replacement - "tf" to "te")
m (Text replacement - "Summon Poopang.gif" to "Special Effect - Poopang.gif")
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''te''' (short for "Title Features") is a template meant to be used inside the main [[Template:Title|Title]] template. It primarily helps you add the special conditions in which a title's effect applies, but it can also be used to display a tooltip to show how an effect looks in-game.
'''te''' (short for "Title Effects") is meant to be used inside the [[Template:Title|Title]] template. Its main purpose is to help you add quickly  and easily the conditions in which a title's effect is applied, such as a specific element, the game mode, whether it overlaps other effects, and its cooldown. Ultimately, this aims to display these conditions in a standardized way across the [[Titles|Title list]].
 
This template can also be used to display tooltips, automatically updating the caption to follow a certain format, and displaying on the tooltip a linked image. The purpose of this function is to update the previous method that was used to illustrate, usually with a gif image, a title's effect, as the linked image was opened on a separate browser tab. Taking into consideration that the "double attack" effect is so commonly used, it is also possible to add it quicker without needing to link the image every time.


== Usage ==
== Usage ==
Line 18: Line 20:
</nowiki>
</nowiki>


The title accepts, at first, only one input. This can be either img, ''double'', and four other special parameters which can be used in a group or independently (e, cd, ''o'' and m).  
The title accepts, at first, only one input. This can be '''either''' img, double, and four other special parameters which can be used in a group or independently (e, cd, o and m). {{color|red|Important:|b=1}} While the four parameters can be used as a group, '''img''' and '''double''' cannot be combined with them (or with each other, for logical reasons). If '''img''' or '''double''' are needed besides the grouped parameters, you will need to add them in a separate Te template.
* '''img''' (image): as the name implies, allows you to display an image as a [Template:tt|tooltip]], while its caption gets formatted in italic and bold. It first asks for the text and then for the filename.
 
* '''double''' (double attack): Not a parameter. It works in exactly the same manner as '''img'''. It will simply add the text and image for the more commonly used Double Attack proc.
* '''img''' (image): as the name implies, allows you to display an image as a [[Template:tt|tooltip]], while its caption gets formatted in italic and bold. It will first ask for the caption, and then for the file name.
* '''double''' (double attack): it works in a similar manner as the "img" feature, however, it'll skip the second parameter and automatically display the [[:File:Special Effect - Double Attack.gif|double attack]] image on the tooltip. The caption will also get formatted.  It is not a parameter, so any further input will return nothing.
 
===Grouped parameters===
===Grouped parameters===
As explained above, these parameters can be used by themselves or as a whole group. As a group, the template will order them in a set priority as such:
As explained above, these parameters can be used by themselves or as a group. In the latter case, the template will order them in a set priority as such:
#Element
#Element
#Cooldown
#Cooldown
#Overlapped
#Overlapped
#Mode
#Mode
Therefore, in the case of a single effect having more than one condition, it is recommended to use only one template for it. It does not matter if the effect does not have all of the conditions, as it will just skip the blank ones. {{color|red|Important:|b=1}} Please keep in mind that this only applies to the conditions. If '''img''' or '''double''' are also needed, you will need to add them in a separate Tf template.
 
* '''e''' (element): Allows for the input of "current" or one of the six elements (fire/f, water/w, nature/n, wind/w, light/l, dark/d). "current" will change the template to note that the referenced effect only applies to the current weapon attributes. Either of the six elements will change the template to note that the referenced effect applies to that specific element. All of the options will add a link to [[Attributing Equipment]] and each element's respective section ("current" will link to the main section).
Therefore, in the case of a single effect having more than one condition, it is recommended to use only one template for it. It does not matter if the effect does not have all of the conditions, as it will just skip the blank ones.
 
* '''e''' (element): Allows for the input of "current" or one of the six elements (fire/f, water/w, nature/n, wind/w, light/l, dark/d). "current" will make the template note that the referenced effect only applies to the current weapon attributes. Either of the six elements will make the template note that the referenced effect applies to that specific element. All of the options will add a link to [[Attributing Equipment]] and each element's respective section ("current" will link to the main section).
* '''cd''' (cooldown): Allows for the input of the amount of time during which the referenced effect cannot be activated again. The text will get automatically formatted in lowercase. If the effect is an actual [[Status Effects|Status Effect]], please also use the [[Template:Se|Se]] template.  
* '''cd''' (cooldown): Allows for the input of the amount of time during which the referenced effect cannot be activated again. The text will get automatically formatted in lowercase. If the effect is an actual [[Status Effects|Status Effect]], please also use the [[Template:Se|Se]] template.  
* '''o''' (overlap): Not a parameter. Will simply add the message that the current effect cannot be overlapped, in a red color and bold.
* '''o''' (overlap): Will add the message that the current effect cannot be overlapped, in red and bold. It is not a parameter, so any further input will return nothing.
* '''m''' (mode): The game mode in which the referenced effect applies, can be either pve/d/dungeon or pvp/m/match. It will also be formatted in red and bold.
* '''m''' (mode): The game mode in which the referenced effect applies, can be either pve/d/dungeon or pvp/m/match. It will be formatted in red and bold.


== Examples ==
== Examples ==
* '''img''': <code><nowiki>{{te|img|summoning Poopang|Summon Poopang.gif}}</nowiki></code> will return: {{te|img|summoning Poopang|Summon Poopang.gif}}
* '''img''': <code><nowiki>{{te|img|summoning Poopang|Special Effect - Poopang.gif}}</nowiki></code> will return: {{te|img|summoning Poopang|Special Effect - Poopang.gif}}
* '''double''': <code><nowiki>{{te|double}}</nowiki></code> will return: {{te|double}}
* '''double''': <code><nowiki>{{te|double}}</nowiki></code> will return: {{te|double}}
* '''element''': <code><nowiki>{{te|e=water}}</nowiki></code> and <code><nowiki>{{te|e=w}}</nowiki></code> will return: {{te|e=w}}
* '''element''': <code><nowiki>{{te|e=water}}</nowiki></code> and <code><nowiki>{{te|e=w}}</nowiki></code> will return: {{te|e=w}}
Line 43: Line 49:
** <code><nowiki>{{te|cd=2 minutes|e=dark|o|m=pve}}</nowiki></code> will return: {{te|cd=2 minutes|e=dark|o|m=pve}}
** <code><nowiki>{{te|cd=2 minutes|e=dark|o|m=pve}}</nowiki></code> will return: {{te|cd=2 minutes|e=dark|o|m=pve}}
** <code><nowiki>{{te|o|e=current}}</nowiki></code> will return: {{te|o|e=current}}
** <code><nowiki>{{te|o|e=current}}</nowiki></code> will return: {{te|o|e=current}}
** <code><nowiki>{{te||m=match|cd=2 minutes 30 seconds}}</nowiki></code> will return: {{te||m=match|cd=2 minutes 30 seconds}}
** <code><nowiki>{{te|m=match|cd=2 minutes 30 seconds}}</nowiki></code> will return: {{te|m=match|cd=2 minutes 30 seconds}}

Latest revision as of 10:39, 25 April 2023

te (short for "Title Effects") is meant to be used inside the Title template. Its main purpose is to help you add quickly and easily the conditions in which a title's effect is applied, such as a specific element, the game mode, whether it overlaps other effects, and its cooldown. Ultimately, this aims to display these conditions in a standardized way across the Title list.

This template can also be used to display tooltips, automatically updating the caption to follow a certain format, and displaying on the tooltip a linked image. The purpose of this function is to update the previous method that was used to illustrate, usually with a gif image, a title's effect, as the linked image was opened on a separate browser tab. Taking into consideration that the "double attack" effect is so commonly used, it is also possible to add it quicker without needing to link the image every time.

Usage

{{te
|1= img | double | e, cd, o, m

|img=
    |2=
    |3=

|double

|e=
|cd=
|o
|m=
}}

The title accepts, at first, only one input. This can be either img, double, and four other special parameters which can be used in a group or independently (e, cd, o and m). Important: While the four parameters can be used as a group, img and double cannot be combined with them (or with each other, for logical reasons). If img or double are needed besides the grouped parameters, you will need to add them in a separate Te template.

  • img (image): as the name implies, allows you to display an image as a tooltip, while its caption gets formatted in italic and bold. It will first ask for the caption, and then for the file name.
  • double (double attack): it works in a similar manner as the "img" feature, however, it'll skip the second parameter and automatically display the double attack image on the tooltip. The caption will also get formatted. It is not a parameter, so any further input will return nothing.

Grouped parameters

As explained above, these parameters can be used by themselves or as a group. In the latter case, the template will order them in a set priority as such:

  1. Element
  2. Cooldown
  3. Overlapped
  4. Mode

Therefore, in the case of a single effect having more than one condition, it is recommended to use only one template for it. It does not matter if the effect does not have all of the conditions, as it will just skip the blank ones.

  • e (element): Allows for the input of "current" or one of the six elements (fire/f, water/w, nature/n, wind/w, light/l, dark/d). "current" will make the template note that the referenced effect only applies to the current weapon attributes. Either of the six elements will make the template note that the referenced effect applies to that specific element. All of the options will add a link to Attributing Equipment and each element's respective section ("current" will link to the main section).
  • cd (cooldown): Allows for the input of the amount of time during which the referenced effect cannot be activated again. The text will get automatically formatted in lowercase. If the effect is an actual Status Effect, please also use the Se template.
  • o (overlap): Will add the message that the current effect cannot be overlapped, in red and bold. It is not a parameter, so any further input will return nothing.
  • m (mode): The game mode in which the referenced effect applies, can be either pve/d/dungeon or pvp/m/match. It will be formatted in red and bold.

Examples

  • img: {{te|img|summoning Poopang|Special Effect - Poopang.gif}} will return: summoning Poopang
  • double: {{te|double}} will return: Double Attack
  • element: {{te|e=water}} and {{te|e=w}} will return: (when using water attributed weapon)
  • cooldown: {{te|cd=1 Minute 30 Seconds}} and {{te|cd=1 minute 30 seconds}} will return: (Cooldown: 1 minute 30 seconds)
  • overlap: {{te|o}} will return: (Not overlapped)
  • mode: {{te|m=pvp}} and {{te|m=m}} will return: (Match)
  • All of the last four combined:
    • {{te|cd=2 minutes|e=dark|o|m=pve}} will return: (when using dark attributed weapon) (Cooldown: 2 minutes) (Not overlapped) (Dungeon)
    • {{te|o|e=current}} will return: (only applies to current weapon attributes) (Not overlapped)
    • {{te|m=match|cd=2 minutes 30 seconds}} will return: (Cooldown: 2 minutes 30 seconds) (Match)