Difference between revisions of "Template:Itembox"

Revision as of 16:59, 10 May 2009

Template:Tooltip is a template intended for use on item pages to display item properties in a tooltip-style format. It is designed to simulate the look of the tooltips that one encounters when hovering the mouse over an item in the Ultima Online 2d client.

Note: If the 2d client is ever dropped in favor of the KR or SA clients, the look and feel of this template will be changed accordingly.

All of the properties in Template:Items are displayed as centered in the tooltip, and all are displayed in white text except for the name of the item, which is displayed in yellow text. Most item properties are displayed as links to their related page as is some other text.

Example: In the display of the swingspeedincrease parameter the words "Swing Speed Increase" will be displayed as a link to that page, whereas in the display of the skillrequired parameter it is not the words "Skill Required" that will be displayed as a link, but the actual skill that is entered as that parameter's value, such as "Swordsmanship" or "Archery", that will be displayed as a link.

NOTE: This template is far from finished. As more item property parameters are included and as more functionality is added to the current item property parameters, both the complete template that is displayed for copying and pasting in the "Full Template" section and the information on specific item property parameters below will be updated.

Usage

Since it is highly unlikely if not impossible that an item will ever be encountered that uses absolutely every item property that is available in the template, Template:Tooltip has been designed with conditional parameters. This means that when using this template on an item's page it is intended that only the parameters which correspond to the properties which are displayed on that specific item should be included. Unlike many of the other templates that show in their entirety no matter what, if one of the parameters from Template:Items is not included or left blank, its associated property will simply not display at all.

It is suggested that when using Template:Tooltip one should choose one of the two following strategies:

1. Copy and paste the entirety of the template, which is shown in a the "Full Template" section below, and delete those parameters whose corresponding properties are not present on the item which you are editing.
2. Copy and paste only the parameters from below that correspond to properties which are present on the item that you are editing and ignore the others completely.

It is NOT recommended that you copy and paste the complete template and leave it in its entirety with blank, unused parameters. Template:Tooltip was designed conditionally so that this would not be necessary. It was intended that this template would be easier to use and read due to less unused code, and that this in turn would have the added benefit of saving valuable server space.

Full Template

The following is the entirety of Template:Tooltip, which includes every item property parameter that has so far been added.

{{Item
|name=
|blessed=
|weight=
|hitstaminaleech=
|spellchanneling=
|swingspeedincrease=
|damageincrease=
|physicalresist=
|fireresist=
|coldresist=
|poisonresist=
|energyresist=
|physicaldamage=
|firedamage=
|colddamage=
|poisondamage=
|energydamage=
|mindamage=
|maxdamage=
|weaponspeed=
|range=
|strengthrequirement=
|handedweapon=
|skillrequired=
|durability=
}}

Parameters

name

|name=

The name parameter displays the name of the item at the top of the tooltip. It is the only item property that displays in yellow text. When entering a value for this parameter, any string may be used. If the name parameter is left blank or not used, the template is coded to automatically use the name of the page on which it is being used. It is recommended in most instances that the name parameter be left out in order to take advantage of this functionality.

The name parameter displays as follows:

• Manually-entered value:
  • An_sword_001
• Automatic value (the derived name of this Template page):
  • Itembox

blessed

|blessed=

The blessed parameter displays whether an item is Blessed or Cursed. In order for the Blessed property to display, this parameter requires a value of "yes", "YES", "Yes", "y", or "Y". In order for the Cursed property to display, this parameter requires a value of "cursed", "CURSED", or "Cursed".

The blessed parameter displays as follows:

• Blessed:
  • Template:ColoredLink
• Cursed:
  • Template:ColoredLink

weight

|weight=

The weight parameter displays the weight of an item in the format "Weight: X Stones", where X is the value inputed. The weight parameter does not accept any value less than 1.

The weight parameter displays as follows:

• Template:ColoredLink: 10 Stones

swingspeedincrease

|swingspeedincrease=

The swingspeedincrease parameter displays the Swing Speed Increase property on an item in the format "Swing Speed Increase X%", where X is the value inputed. The swingspeedincrease parameter does not accept any value less than 1.

The swingspeedincrease parameter displays as follows:

• Template:ColoredLink 30%

Resist parameters

|physicalresist=
|fireresist=
|coldresist=
|poisonresist=
|energyresist=

The resist parameters display their corresponding resist property (physical, fire, cold, poison, or energy) on an item in the format "Y Resist X%", where X is the inputed value and Y is the resist type. Resist parameters do not accept any value of less than 1.

The resist parameters display as follows:

• physicalresist: Template:ColoredLink 10%
• fireresist: Template:ColoredLink 10%
• coldresist: Template:ColoredLink 10%
• poisonresist: Template:ColoredLink 10%
• energyresist: Template:ColoredLink 25%

Damage Type parameters

|physicaldamage=
|firedamage=
|colddamage=
|poisondamage=
|energydamage=

The damage type parameters display their corresponding damage type property (physical, fire, cold, poison, or energy) on an item in the format "Y Damage X%", where X is the inputed value and Y is the damage type. Damage types do not accept any value of less than 1. If the combined value of the damage types you use for an item does not equal 100, none of the damage types will display, as any other combined value would be impossible within the limitations of the game.

The damage type parameters display as follows:

• physicaldamage: Template:ColoredLink 20%
• firedamage: Template:ColoredLink 20%
• colddamage: Template:ColoredLink 20%
• poisondamage: Template:ColoredLink 20%
• energydamage: Template:ColoredLink 20%

handedweapon

|handedweapon=

The handedweapon parameter displays whether an item, when equipped, requires one hand to wield, or two. As these are currently the only two possible options in the game, the only two valid input values are as follows:

• 1
• 2

If any value other than the preceding two are used, the property will not display.

The handedweapon parameter displays as follows:

• Input of '1': One-Handed Weapon
• Input of '2': Two-Handed Weapon
• Any other input: (Does not display)

durability

|durability=

The durability parameter displays the durability of an item in the format "Durability: X / X", where X is the value inputed. For consistency's sake, the value inputed is applied to both the maximum durability as well as the current durability. The durability parameter does not accept any value less than 1.

The durability parameter displays as follows:

• Template:ColoredLink 255 / 255