Template:Itembox
From UO Excelsior Wiki - Ultima Online Free Shard
Revision as of 08:19, 7 April 2013 by Dramoor (talk | contribs) (Created page with "<noinclude>{{Template Overview |usedon=item |purpose=display an item's picture and properties |othernotes=It is designed to simulate the item being in a character's backpack with...")
Template:Itembox is designed for use on item pages to display an item's picture and properties. {{#if: 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. Most item property names also serve as links to their corresponding pages. The order in which the item properties are displayed is designed to be as close as possible to the order seen in UO. The order in which the template's parameters are used does not affect this order.
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 this template, Template:Itembox 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 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, as their inclusion will lead to pages being unnecessarily and excessively long and unreadable for editors. | 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. Most item property names also serve as links to their corresponding pages. The order in which the item properties are displayed is designed to be as close as possible to the order seen in UO. The order in which the template's parameters are used does not affect this order.
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 this template, Template:Itembox 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 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, as their inclusion will lead to pages being unnecessarily and excessively long and unreadable for editors. | }}
Template
{{#switch: {{Itembox
|image=
|name=
|usesremaining=
|blessed=
|weight=
|recoveredfromashipwreck=
|armorset=
|weaponarmorset=
|jewelryset=
|durabilityincrease=
|artifactrarity=
|spellconsumption=
|elvesonly=
|gargoylesonly=
|mondainslegacy=
|stygianabyss=
|highseas=
|manaburst=
|frequency=
|spellconsumption=
|ammo=
|damagemodifier=
|alchemy=
|anatomy=
|animallore=
|animaltaming=
|archery=
|armslore=
|begging=
|blacksmithing=
|bowcraftfletching=
|bushido=
|camping=
|carpentry=
|cartography=
|chivalry=
|cooking=
|detectinghidden=
|discordance=
|evaluatingintelligence=
|fencing=
|fishing=
|focus=
|forensicevaluation=
|glassblowing=
|healing=
|herding=
|hiding=
|imbuing=
|inscription=
|itemidentification=
|lockpicking=
|lumberjacking=
|macefighting=
|magery=
|masonry=
|meditation=
|mining=
|musicianship=
|mysticism=
|necromancy=
|ninjitsu=
|parrying=
|peacemaking=
|poisoning=
|provocation=
|removetrap=
|resistingspells=
|snooping=
|spellweaving=
|spiritspeak=
|stealing=
|stealth=
|swordsmanship=
|tactics=
|tailoring=
|tasteidentification=
|throwing=
|tinkering=
|tracking=
|veterinary=
|wrestling=
|randomskill=
|randomcombatskill=
|kineticeater=
|fireeater=
|coldeater=
|poisoneater=
|energyeater=
|randomeater=
|kineticresonance=
|fireresonance=
|coldresonance=
|poisonresonance=
|energyresonance=
|randomresonance=
|soulcharge=
|velocity=
|spellchanneling=
|mageweapon=
|hitlifeleech=
|hitstaminaleech=
|hitmanaleech=
|slayer=
|slayer2=
|randomitemproperty1=
|randomitemproperty2=
|randomitemproperty3=
|hitfatigue=
|hitmanadrain=
|hitcurse=
|hitdispel=
|hitfireball=
|hitharm=
|hitlightning=
|hitmagicarrow=
|hitphysicalarea=
|hitfirearea=
|hitcoldarea=
|hitpoisonarea=
|hitenergyarea=
|hitlowerdefense=
|hitlowerattack=
|balanced=
|blooddrinker=
|battlelust=
|manaphase=
|spellfocusing=
|brittle=
|surgehpregeneration=
|surgestaminaregeneration=
|surgemanaregeneration=
|reactiveparalyze=
|castingfocus=
|splinteringweapon=
|randomprotection=
|increasedweapondamage=
|increasedkarmaloss=
|selfrepair=
|strengthbonus=
|dexteritybonus=
|intelligencebonus=
|hitpointincrease=
|staminaincrease=
|manaincrease=
|hitpointregeneration=
|staminaregeneration=
|manaregeneration=
|nightsight=
|luck=
|enhancepotions=
|reflectphysicaldamage=
|hitchanceincrease=
|defensechanceincrease=
|fastercasting=
|fastercastrecovery=
|swingspeedincrease=
|damageincrease=
|spelldamageincrease=
|lowermanacost=
|lowerreagentcost=
|arcanecharges=
|randomresist=
|physicalresist=
|fireresist=
|coldresist=
|poisonresist=
|energyresist=
|magearmor=
|usebestweaponskill=
|directdamage=
|physicaldamage=
|firedamage=
|colddamage=
|poisondamage=
|energydamage=
|chaosdamage=
|mindamage=
|maxdamage=
|weaponspeed=
|range=
|lowerrequirements=
|strengthrequirement=
|handedweapon=
|skillrequired=
|durability=
|mindurability=
|maxdurability=
|lowerammocost=
|chargesremaining=
|contentsitems=
|contentsstones=
|contents2items=
|contents2stones=
|weightreduction=
|replenishcharges=
|autorecharge=
|spells=
|turnedonoff=
|petals=
|commontracks=
|uncommontracks=
|raretracks=
|lifespan=
|setphysicalresist=
|setfireresist=
|setcoldresist=
|setpoisonresist=
|setenergyresist=
|setselfrepair=
|setstrengthbonus=
|setluck=
|setreflectphysical=
|setnightsight=
|setstealth=
|setdexteritybonus=
}} | {{Itembox
|image=
|name=
|usesremaining=
|blessed=
|weight=
|recoveredfromashipwreck=
|armorset=
|weaponarmorset=
|jewelryset=
|durabilityincrease=
|artifactrarity=
|spellconsumption=
|elvesonly=
|gargoylesonly=
|mondainslegacy=
|stygianabyss=
|highseas=
|manaburst=
|frequency=
|spellconsumption=
|ammo=
|damagemodifier=
|alchemy=
|anatomy=
|animallore=
|animaltaming=
|archery=
|armslore=
|begging=
|blacksmithing=
|bowcraftfletching=
|bushido=
|camping=
|carpentry=
|cartography=
|chivalry=
|cooking=
|detectinghidden=
|discordance=
|evaluatingintelligence=
|fencing=
|fishing=
|focus=
|forensicevaluation=
|glassblowing=
|healing=
|herding=
|hiding=
|imbuing=
|inscription=
|itemidentification=
|lockpicking=
|lumberjacking=
|macefighting=
|magery=
|masonry=
|meditation=
|mining=
|musicianship=
|mysticism=
|necromancy=
|ninjitsu=
|parrying=
|peacemaking=
|poisoning=
|provocation=
|removetrap=
|resistingspells=
|snooping=
|spellweaving=
|spiritspeak=
|stealing=
|stealth=
|swordsmanship=
|tactics=
|tailoring=
|tasteidentification=
|throwing=
|tinkering=
|tracking=
|veterinary=
|wrestling=
|randomskill=
|randomcombatskill=
|kineticeater=
|fireeater=
|coldeater=
|poisoneater=
|energyeater=
|randomeater=
|kineticresonance=
|fireresonance=
|coldresonance=
|poisonresonance=
|energyresonance=
|randomresonance=
|soulcharge=
|velocity=
|spellchanneling=
|mageweapon=
|hitlifeleech=
|hitstaminaleech=
|hitmanaleech=
|slayer=
|slayer2=
|randomitemproperty1=
|randomitemproperty2=
|randomitemproperty3=
|hitfatigue=
|hitmanadrain=
|hitcurse=
|hitdispel=
|hitfireball=
|hitharm=
|hitlightning=
|hitmagicarrow=
|hitphysicalarea=
|hitfirearea=
|hitcoldarea=
|hitpoisonarea=
|hitenergyarea=
|hitlowerdefense=
|hitlowerattack=
|balanced=
|blooddrinker=
|battlelust=
|manaphase=
|spellfocusing=
|brittle=
|surgehpregeneration=
|surgestaminaregeneration=
|surgemanaregeneration=
|reactiveparalyze=
|castingfocus=
|splinteringweapon=
|randomprotection=
|increasedweapondamage=
|increasedkarmaloss=
|selfrepair=
|strengthbonus=
|dexteritybonus=
|intelligencebonus=
|hitpointincrease=
|staminaincrease=
|manaincrease=
|hitpointregeneration=
|staminaregeneration=
|manaregeneration=
|nightsight=
|luck=
|enhancepotions=
|reflectphysicaldamage=
|hitchanceincrease=
|defensechanceincrease=
|fastercasting=
|fastercastrecovery=
|swingspeedincrease=
|damageincrease=
|spelldamageincrease=
|lowermanacost=
|lowerreagentcost=
|arcanecharges=
|randomresist=
|physicalresist=
|fireresist=
|coldresist=
|poisonresist=
|energyresist=
|magearmor=
|usebestweaponskill=
|directdamage=
|physicaldamage=
|firedamage=
|colddamage=
|poisondamage=
|energydamage=
|chaosdamage=
|mindamage=
|maxdamage=
|weaponspeed=
|range=
|lowerrequirements=
|strengthrequirement=
|handedweapon=
|skillrequired=
|durability=
|mindurability=
|maxdurability=
|lowerammocost=
|chargesremaining=
|contentsitems=
|contentsstones=
|contents2items=
|contents2stones=
|weightreduction=
|replenishcharges=
|autorecharge=
|spells=
|turnedonoff=
|petals=
|commontracks=
|uncommontracks=
|raretracks=
|lifespan=
|setphysicalresist=
|setfireresist=
|setcoldresist=
|setpoisonresist=
|setenergyresist=
|setselfrepair=
|setstrengthbonus=
|setluck=
|setreflectphysical=
|setnightsight=
|setstealth=
|setdexteritybonus=
}} }}
{{#if: | {{#ifeq: {{{display}}} | yes
| ==Display==
| File:Backpack.png
{{#if: |
[[File:{{{image}}}]]
|
{{#fornumargs: key |
value | [[Category:{{#var: value}}|Itembox]]
}} }}
|
| ==Display==
{{{display}}}
}}
}}
Parameters
{{#switch: {{{parameters}}} | none = This template has no parameters. | | #default = }} {{#fornumargs: key | value | [[Category:{{#var: value}}|Itembox]] }}
image
- Usage: {{#ifeq: | mandatory | Mandatory | 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: Image_Needed.png | If this parameter is left blank or omitted, a default value of "Image_Needed.png" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: 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 put into Category:Image Needed so that it may be given a valid image as soon as possible. | 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 put into Category:Image Needed so that it may be given a valid image as soon as possible. }}
- Valid Value(s): Any string that is the name of a valid image on UOGuide.
name
- Usage: {{#ifeq: | mandatory | Mandatory | 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: {{PAGENAME}} | If this parameter is left blank or omitted, a default value of "{{PAGENAME}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: 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)." | 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
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The usesremaining parameter takes a whole number denoting the number of uses remaining on an item. This is used to generate the "Uses Remaining" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: Any whole number may be supplied for this parameter, as it is designed merely to display the "Uses Remaining" property with a realistic number. The ability to supply a specific value as opposed to having a default number is retained due to the possibility that some pages may exist for unique, one-of-a-kind rare items that have a specific number of uses remaining. | Any whole number may be supplied for this parameter, as it is designed merely to display the "Uses Remaining" property with a realistic number. The ability to supply a specific value as opposed to having a default number is retained due to the possibility that some pages may exist for unique, one-of-a-kind rare items that have a specific number of uses remaining. }}
- Valid Value(s): Any whole number.
blessed
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The blessed parameter takes a string denoting whether the item is Blessed or Cursed. This is used to generate the "Blessed" or "Cursed" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): "Cursed," "CURSED," or "cursed" to display "Cursed," and any other value to display "Blessed."
weight
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The weight parameter takes a whole number denoting the weight of the item. This is used to generate the "Weight" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
swingspeedincrease
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The swingspeedincrease parameter takes a whole number denoting the amount of Swing Speed Increase on the item. This is used to generate the "Swing Speed Increase" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
physicalresist
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The physicalresist parameter takes a whole number denoting the amount of Physical Resist on the item. This is used to generate the "Physical Resist" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
fireresist
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The fireresist parameter takes a whole number denoting the amount of Fire Resist on the item. This is used to generate the "Fire Resist" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
coldresist
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The coldresist parameter takes a whole number denoting the amount of Cold Resist on the item. This is used to generate the "Cold Resist" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
poisonresist
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The poisonresist parameter takes a whole number denoting the amount of Poison Resist on the item. This is used to generate the "Poison Resist" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
energyresist
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The energyresist parameter takes a whole number denoting the amount of Energy Resist on the item. This is used to generate the "Energy Resist" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
physicaldamage
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The physicaldamage parameter takes a whole number denoting the percentage of Physical Damage on the item. This is used to generate the "Physical Damage" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
firedamage
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The firedamage parameter takes a whole number denoting the percentage of Fire Damage on the item. This is used to generate the "Fire Damage" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
colddamage
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The colddamage parameter takes a whole number denoting the percentage of Cold Damage on the item. This is used to generate the "Cold Damage" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
poisondamage
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The poisondamage parameter takes a whole number denoting the percentage of Poison Damage on the item. This is used to generate the "Poison Damage" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
energydamage
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The energydamage parameter takes a whole number denoting the percentage of Energy Damage on the item. This is used to generate the "Energy Damage" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
handedweapon
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The handedweapon parameter takes a whole number denoting whether the item is wielded with one (1) or two (2) hands. This is used to generate the "One-Handed Weapon" or "Two-Handed Weapon" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): "1" to display "One-Handed Weapon," or "2" to display "Two-Handed Weapon."
durability
- Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
- Description: The durability parameter takes a whole number denoting the minimum and maximum durability of the item. This is used to generate the "Durability" item property in the tooltip section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Itembox. }} }} {{#if: | {{{othernotes}}} }}
- Valid Value(s): Any whole number greater than or equal to one (1).
