Difference between revisions of "Template:Itembox"
m (Worked on some documentation. Still much more work to do.) |
m (Template:Tooltip moved to Template:Item Infobox: Pretty sure I've settled on this for a permanent name.) |
(No difference)
| |
Revision as of 12:20, 23 November 2009
This entire page and template is currently in the process of being refactored. (11/20/09)
Template:Itembox is designed for use on item pages to display an item's picture and properties. It is designed to simulate the item being in a character's backpack with the standard in-game cursor hovering over it and displaying the item's tooltip, all in the format found in the the Ultima Online Classic Client.
- Note: If the Classic Client is ever dropped in favor of the Enhanced Client, the look and feel of this template will be changed accordingly.
All of the properties that are displayed in the tooltip portion of the template are displayed as centered and using white text except for the name of the item, which is displayed in yellow text. Specific item property names are also links to their corresponding pages.
Notes on 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:Item Infobox 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 that specific item's properties should be included. Unlike many of the other templates that show in their entirety no matter what, if one of the parameters from this template is not included or left blank, its associated property will simply not display at all. It is recommended that blank parameters be left out entirely when using this template, in order not to waste space.
Template
{{Item Infobox
|image=
|imageheight=
|name=
|usesremaining=
|blessed=
|weight=
|elvesonly=
|ammo=
|damagemodifier=
|requirementmondainslegacy=
|armorset=
|jewelryset=
|weaponarmorset=
|durabilityincrease=
|spellchanneling=
|velocity=
|hitstaminaleech=
|swingspeedincrease=
|damageincrease=
|physicalresist=
|fireresist=
|coldresist=
|poisonresist=
|energyresist=
|physicaldamage=
|firedamage=
|colddamage=
|poisondamage=
|energydamage=
|mindamage=
|maxdamage=
|weaponspeed=
|range=
|strengthrequirement=
|handedweapon=
|skillrequired=
|durability=
}}
Parameters
[[Category:{{{category}}} Templates|Itembox]]
image
- Usage: Optional
- Description: The image parameter takes a string denoting the name of a valid image of the item on UOGuide. This is used to generate the item's image in the containing area of the backpack. If this parameter is left blank or omitted, a default value of "Image_Needed.png" is used. Although this parameter is marked as "Optional," if this parameter is not supplied a value an image will be displayed that says "IMAGE NEEDED" and the page will be flagged and put into a category of item pages lacking images so that it may be given a valid image in the future.
- Valid Value(s): Any string that is the name of a valid image on UOGuide.
imageheight
- Usage: Optional
- Description: The imageheight parameter takes a number denoting the height of the item image. This is used to generate the layout code necessary to vertically center the image in the containing area of the backpack.
- Valid Value(s): Any whole number.
name
- Usage: Optional
- Description: The name parameter takes a string denoting the name of the item. This is used to generate the first line of the tooltip section. If this parameter is left blank or omitted, a default value of "{{PAGENAME}}" is used. It is recommended that this field be left blank unless the item's page name has a parenthetical differentiation in it; I.e. "Item Name (Item)."
- Valid Value(s): Any string.
usesremaining
|usesremaining=
The usesremaining parameter displays the number of uses remaining on an item in the format "Uses Remaining: X", where X is the value inputted. The usesremaining parameter does not accept any value less than 1.
The usesremaining parameter displays as follows:
blessed
|blessed=
The blessed parameter displays the Blessed or Cursed property on an item. To display the Cursed property, use values of "cursed", "CURSED", or "Cursed". To display the Blessed property, use any other value.
The blessed parameter displays as follows:
- Blessed:
- Cursed:
weight
|weight=
The weight parameter displays the weight of an item in the format "Weight: X Stones", where X is the value inputted. The weight parameter does not accept any value less than 1.
The weight parameter displays as follows:
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 inputted. The swingspeedincrease parameter does not accept any value less than 1.
The swingspeedincrease parameter displays as follows:
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 inputted value and Y is the resist type. Resist parameters do not accept any value 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 inputted 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': Template:ColoredLink
- Input of '2': Template:ColoredLink
- 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 inputted. For consistency's sake, the value inputted is applied to both the current durability and the maximum durability. The durability parameter does not accept any value less than 1.
The durability parameter displays as follows:
- Template:ColoredLink 255 / 255