User:Magill/Sandbox-tooltip/doc

From Lotro-Wiki.com
Jump to navigation Jump to search

Creating new Items

  • Use Create new item for things to appear in the Item namespace. The goal of this complex template is to mimic, as closely as possible, the tooltips found in-game.
  • All information for this template can be found on the in-game tool-tip!
Note: When creating a page, realize that not all parameters apply to every item. Leave any unused (i.e. blank) entries from the template in place, even if they do not apply to the page you are creating or woking on. These are needed to reduce confusion for possible future updates, especially by Wiki-bots.

However, there are a few things which are not "Item:" entries, or are part of more complex Wiki pages.

Important: regarding the "blank" or Yes" explanation for many parameters -- blank will not enable the feature of that parameter, but "Yes" or any other text will enable it, as will a single character, digit, or anything other than a space. Hence, blank means "off" (which is default), while any text means "on". ("any text" can be N/n/Y/y/Yes/yes, etc.)

  • The background of the Tooltip is black "background"; the same colors are used on this page. The display example follows the description which is followed by the category where applicable.

Explanation and usage of the parameters

mode={{{mode|}}}
Leave as is
arg={{{arg|}}}
Leave as is
amount={{{amount|}}}
Leave as is
name=
The item name, as it appears in game. Exact page name is required here to avoid issues with names containing diacritics and apostrophes (do not use {{PAGENAME}}). {{subst:PAGENAME}} usually works correctly, but if the item name does not equal the page name, replace the code with the item name spelled exactly as in-game. Example: the page is named "Chainsaw (Level 33)" but the item is simply named "Chainsaw" in-game (and assumingly other Chainsaw pages for other levels exist on the wiki).
icon=
The icon to display on the tooltip; omit the "File:" prefix and the filename extension ".png," but include "-icon;" passed to {{icon}}. Preferably this is a generic icon, see Category:Icons for further details. Should an icon not exist, use the exact page name to avoid issues with names containing diacritics and apostrophes (do not use {{PAGENAME}}). Example: "Cloak 1 (incomparable)-icon"
disambigpage=
name of Lotro-Wiki page for this item. Please retain {{subst:FULLPAGENAME}} in the disambigpage field. Otherwise you must use ' instead of any apostrophe ( ' ).
quality=
item quality, passed to {{quality}} to generate formatted item name in the appropriate color. Examples: Common, Uncommon, Rare, Incomparable, Epic. Rare Item

Basic Info:

unique=
used for unique items; blank, or "Yes" to show "Unique" in the upper right corner of the tooltip. "Unique"
indestructible=
used for indestructible items; blank, or "Yes" to show "Cannot Be Destroyed" in the tooltip. Cannot Be Destroyed
consumed=
used for food and potions; blank, or "Yes" to show "Consumed On Use" in the tooltip. Consumed on Use
cosmetic=
used to denote cosmetic items; blank, or "Yes" to show "Cosmetic" in the tooltip. Cosmetic (Cat=Category:Cosmetic Items)
bind=
binding type: BoE ("Bind on Equip"), BoA ("Bind on Acquire"), or BtA "Bind to Account") -- a rarely used old term is BtAoA ("Bind To Account on Acquire"). Bind on Equip
barter=
used for items that can be bartered for faction standing or items; blank, or "Yes" to show "Barter Item" in the tooltip. Barter Item (Cat=Category: Barter Items)
dye=
if an item is dyed by default; blank, or the colour name. Examples: "Turquoise", "Black", .... Dye: Turquoise
type=
item type from the ingame tooltip; blank, or the type. Example: "One-handed Axe", "Heavy Armour", "Resource", .... One-handed Axe (Cat=Category:One-handed Axe Items)
slot=
item slot, used only to designates a category for equip-able items (not weapons); nothing is displayed on the tooltip unless the slot is a Jewellery slot; blank, or the one-word slot name see: Category: Positional Items. Examples: "Gloves", "Ear", "Back", "Feet", .... (Cat=Category:Back Items)
purchased_store=
used for items purchased from the LOTRO Store; blank, or "Yes" to show "Purchased from store" in the tooltip. Purchased from store
deco-slot=
(cat) used to denote housing decoration items: will put an item into the matching decoration category; blank, or the proper category. Examples: "Ambient Music", "Paint Color", "Yard", .... Decoration Category: Yard (Cat=Category:Decoration Category: Yard)
LImodifier=
used to describe the Legendary Titles Index modifier applied to a legendary item; blank, or description. Guardian of the Deep Halls If used, add "Legendary Item Title Items" to one of the categories below.

Categories

While a few parameters will also direct the page into the proper Category (marked "Cat="), the following five parameters are available to provide additional categorization.
first-category
used only to designate a category; nothing is displayed on the tooltip.
Second-category
used only to designate a category; nothing is displayed on the tooltip.
third-category
used only to designate a category; nothing is displayed on the tooltip.
fourth-category
used only to designate a category; nothing is displayed on the tooltip.
fifth-category
used only to designate a category; nothing is displayed on the tooltip.

Stats:

armour=
the amount of "Armour stat" the item grants to its wearer; blank, or integer. Example: "123". 123 Armour
dmg=
basic weapon damage; blank, or provide an integer range. Example: "13 - 17". 13 - 17 Damage (Combines with "dmgtype" if defined.)
dmgtype=
the basic weapon damage type; blank, or the type. Examples: "Common", "Fire", "Beleriand", .... 13 - 17 Beleriand Damage
dps=
weapon dps; blank, or decimal value. Example: "12.3". 12.3 DPS</style>
bonus=
bonus weapon damage; blank, or the bonus. Example: "+9 Damage to The Dead". +9 Damage to The Dead</style>

On-Use Details:

use=
Provide any details on the item's "on-use"-effect; blank, or the on-use-effect text. Also for "One use" and the like. On Use:On-use-effect
skilltype=
Provide the type of skill that an item's on-use-effect uses (melee/tactical/...), used only if shown on ingame tooltip; blank, or skill type. mele Skill
resistance=
Provide a type of resistance that the item's on-use-effect has (cry/song/...), use if shown on ingame tooltip; blank, or the resistance type.Resistance: token
radius=
Provide here the radius of the item's on-use-effects; blank, or integer. Example: "20 feet". Radius: 20 feet
maxtargets=
Provide maximum amount of targets that the item's on-use-effect has; blank, or integer. Example: "3". Max Targets: 3
duration=
Provide here duration of the item's on-use-effects; blank, or value/range. Examples: "2m 30s", "40s - 1m30s", ... Duration: 2m 30s
max_duration=
Provide here maximum duration of the item's on-use-effects (some items have max duration rather than "duration"); blank, or value. Example: "2m".Maximum Duration: 2m
range=
Provide the range that the item's on-use-effect has; blank, or a range. Example: "5m - 9m". Range: 5m - 9m
expiration=
Provide here what will happen when use expires (template will add 'Applied on expiration:'); blank, or expiration effect.
expirationdur=
Provide here duration of until the item's applied-on-expiration will take effect; blank, or duration.
induction=
Time for induction; blank, or time. Example: "3s".
channeldur=
Channeled Duration; blank, or time. Example: "10s".
cooldown=
Provide here a cooldown of the item's on-use-effects; blank, or time. Example: "45s".
item_duration=
Provide the Item Duration (mostly used by store-bought mount whistles); blank, or time. Example: "24h".

Requirements:

barskill=
The first barring skill goes here; blank, or skill.
barskill2=
A second barring skill goes here; blank, or skill.
barskill3=
If barring skill(s) is/are passive, put "Yes" or anything in this field; blank, or "Yes".
bartrait=
The barring trait goes here; blank, or trait.
noeffect=
Effect that can't be effective to use the item; blank, or effect.
nomp=
If an item can't be used during Monsterplay; blank, or "Yes".
level=
numeric value of the minimum level required to use this item; blank, or integer.
maxlevel=
numeric value of the maximum level that can use this item; blank, or integer.
class=
class that can use the item; "blank, or class"to show in tooltip in white as: "Class: <class>".
class2=
A second class if mentioned goes here; blank, or class -- "Class: <class>, <class2>"
class3=
A third class if mentioned goes here; blank, or class -- "Class: <class>, <class2>, <class3>"
class4=
A fourth class if mentioned goes here; blank, or class -- "Class: <class>, <class2>, <class3>, <class4>"
race=
race that can use the item; blank, or race.
skillreq=
skill required to use the item; blank, or skill.
skillreq2=
skill required to use the item; blank, or skill.
questhav=
quest that must be in your quest log; blank, or quest name.
questreq=
quest that must have been completed; blank, or quest name.
bquest=
Items which begin a quest (Starts Quest: ...); blank, or quest name.
profession=
profession that can use the item (used together with |proficiency=); blank, or profession.
proficiency=
proficiency in the profession needed to use the item (used together with |profession=); blank, or proficiency.
faction=
faction name required to use this item (used together with |standing=); blank, or faction name. See also Template:Reputation Item.
standing=
faction reputation standing required to use this item (used together with |faction=); blank, or standing.
virtue=
virtue required to use item; blank, or virtue. Example: "Honesty".
virtuerank=
virtue rank required to use item (template will add ", Rank " between); blank, or integer. Example: "5".
gloryrank=
numeric value of the freep rank required to use this item; blank, or integer.
infamyrank=
numeric value of the creep rank required to use this item; blank, or integer.
mpreq=
If an item requires Monster Play effect put "Yes" or anything in this field; blank, or "Yes".

Info:

temporary=
used for items that are destroyed on exit such as skirmish minor tokens; blank, or "Yes". Will mark an item with the text "Destroyed upon exiting the instance" in red font.
attrib=
item's attribute(s); blank, or attribute(s). List all stat bonuses, delimit individual bonuses with <br> (+6 Vitality <br> +3 Will). Include also text for "Wield:" and "z% chance to apply". Use {{Color|khaki|...}} for text in beige.
  • attrib: Enumerate all attributes as they are read at the in-game tooltip. Use <br> to separate items, e.g. +5 Might <br> +10 Maximum Power.
    Currently there is no good way to display the colour variations in "Wield: abc" and "x% chance to appl..." which varies randomly (?) between green and beige. Use {{Color|khaki|...}} around the beige text.
    Altogether this means that "attrib" may carry a very long line of text, everything on one unbroken line.
durability=
item's maximum durability; blank, or integer.
dur_class=
item's durability class (Brittle/Normal/Tough); blank, or text.
flavor =
item's description text (quotes are added by the template); blank, or text.
set=
name of the item-set, only if the item is part of set; blank, or text.
If an existing Wiki page is found with an incorrect name, move the page to the correct name.
sell=
price an NPC will pay for the item (use {{worth}}), displayed only if values are added. Example: {{worth|g=|s=12|c=99|dp=}}
vendor=
price the item costs when purchased from an NPC (use {{worth}}), see "sell="
Lotrostore=
price the item costs when purchased from Lotro Store (use {{worth}}), see "sell=". Example: Example: {{worth|tp=50}}
stack=
max number of items that can be stacked in one inventory slot, if known; blank, or integer.


Relics:

These three parameters need to be added manually to those "Items" which need to be deconstructed to reveal the relic sealed inside.
relic-name=
The name of the relic
relic-icon=
The icon of the relic
relic-attrib=
The attributes of the relic


Magill/Sandbox-tooltip/doc


Retrieved from "https://lotro-wiki.com/w/index.php?title=User:Magill/Sandbox-tooltip/doc&oldid=1485454"