Template:DropsLine/doc

This is a documentation subpage for Template:DropsLine.

It contains usage information, categories, and other content that is not part of the original template page.

Template:DropsLine invokes function main in Module:DropsLine using Lua.

The DropsLine templates are used to list a monster's drops. Three templates are used to form the drop logs:

{{DropsTableHead}} - Contains table headers for the top of the drop table
{{DropsLine}} - Template for all of the individual drop lines
{{DropsTableBottom}} - Contains table footers for the bottom of the drop table

Predefined and alternate templates

Several predefined templates have been made to assist with several common uses.

Clue scroll drops: {{DropsLineClue}}

This DropsLine is aimed primarily for monsters that are killed in combat. For other ways of getting drops, use:

{{DropsLineSkill}} - Skilling drops
{{DropsLineReward}} - General rewards (treasure trails, mystery boxes, etc.)

Usage

{{DropsTableHead}}
{{DropsLine
|name          = <!-- Name of item -->
|namenotes     = <!-- (Optional) Notes added to the item name without disrupting GE price.-->
|quantity      = <!-- Quantity(s) dropped by monster. Separate with commas. -->
|rolls         = <!-- (Optional) How many rolls per kill does this drop get (e.g. for bosses that have 2 drops per kill like Zulrah) -->
|rarity        = <!-- How rare the item is: Always, Common, Uncommon, Rare, Very rare, Varies -->
|raritynotes   = <!-- (Optional) Extra things added into the Rarity column, to not disrupt the colouring -->
|approx        = <!-- (Optional) "yes" if the rarity is an approximation. -->
|altrarity     = <!-- (Optional) Display a second rarity, separated by a semicolon -->
|altraritydash = <!-- (Optional) Set to "yes" to use a dash separator instead of a semicolon -->
|members       = <!-- (Optional) Override the default members option -->
|version       = <!-- (Optional) Which version(s) (comma separated) of a monster has this drop; only needed if drop should be annotated with a version, and DropsTableHead does not already specify this  -->
|gemw          = <!-- (Optional) "no" if item is not sold on the GE -->
|gemwname      = <!-- (Optional) If the item name is not the exact same as the name on the Grand Exchange, specify the name in this parameter -->
|image         = <!-- (Optional) Manual addition of image if item is not sold on GE. Don't add [[File:_]] -->
|smw           = <!-- (Optional) Set this to "No" to stop this item from appearing in SMW results -->
|smwname       = <!-- (Optional) Used to specify the page to list in SMW results. Most commonly used to specify a page #anchor to have SMW link to specific item versions -->
|alt           = <!-- (Optional) Alternate display name for the item -->
{{DropsTableBottom}}

NOTE: The template should be used in one line, like the example below.

Unfilled drops line for quick copy-paste

GE item:
{{DropsLine|name=|quantity=|rarity=}}
Non-GE item:
{{DropsLine|name=|quantity=|rarity=|gemw=no|image=}}

Parameter details

name

Name of the item/drop, should link directly to the article.

namenotes (optional)

If extra notes need adding to the item name, such as for noted items, use the "Name notes" parameter. This will allow the Image and gemw parameters to still work.

quantity

Quantity of the item dropped by the monster. If multiple quantities are randomly dropped, list them all and separate with commas. Do not use commas as thousand separators, and do not use abbreviations like k and m - input 9000, not 9,000 or 9k.

The price column automatically detects several types of ranges:

Several individual values separated with commas, e.g. 1,4,7
- Uses the first and the last values (not max and min; numbers in the middle ignored), so make sure to order them in ascending order.
A range in the form min-max, e.g. 1-10
- Uses the number on the left of the - as min, and the right as max
A combination of the above two, e.g. 1-3,5,7-9,11
- First separates by commas, then if the first is a range, uses the left of the - as min; if the last is a range, uses the right of the - as max; otherwise if either is not a range uses the number that is there as min or max, respectively. In the example, the min number would be 1 and the max 11. Make sure they're ordered in ascending order.

The word (noted) is removed before parsing it, but other variations are not. All other characters and text are parsed as is, so make sure the Quantity field only contains numbers, commas, hyphens and (noted), nothing else.

rarity

Rarity of the item. Only 6 available options:

Rarity	Explanation	Exact rate (if known)
Always	Always dropped by the monster	1/1
Common	The most common of items. Renowned for being common. Nearly always dropped.	1/2 to 1/25
Uncommon	Dropped sometimes, but not necessarily renowned for being common	1/26 to 1/99
Rare	Rarely dropped. Will take quite a few kills to obtain.	1/100 to 1/999
Very rare	Renowned for being rare among players. Hardly ever dropped. Items like the elysian sigil, some dragon items, etc.	1/1000 or rarer
Varies/Random/ Once/Conditional	Dropped with a mechanic more complex than a simple drop rate. Use the `Raritynotes` parameter to indicate how the drop probability varies with boss level.

Leaving the rarity blank or entering a rarity other than always/common/uncommon/rare/very rare/varies defaults to a white colour. You may optionally append |approx = yes if the drop rate is an estimation.

raritynotes (optional)

If extra notes on the items rarity need to be entered into the column, such as a citation, or some other requirement to be dropped (e.g. the specific bones for Rag and Bone Man I are only dropped during that quest, etc), use the "Raritynotes" parameter. This will allow the colouring of the standard rarities to still work.

version

Which drop versions (comma separated) of the monster have this drop. The text used as the drop version name will be shown in {{Drop sources}} on item pages to indicate the specific instance that provides the drop. Any drop without a version is considered to apply to all infobox versions at all locations. Version should be specified in DropsTableHead when the same version applies to the whole table.

When a version is specified in DropsLine, that version should also be defined in {{Infobox Monster}} using the dropversion parameter. Note that the dropversion need not be the same as the version used for the infobox switches.

The dropversion is used as a key for passing information from the infobox to the drop. A specific example for how the combat level is passed:

{{Infobox Monster}} sets |version1 = Type A, |level1 = 10, and |dropversion1 = Low level. This defines a MediaWiki Variable DropLevel_combat_Low level = 10.
{{DropsLine}} sets |version = Low level. This reads the variable DropLevel_combat_Low level to get the level 10, and stores the result into Semantic MediaWiki Property:Drop JSON.
{{Drop sources}} reads Property:Drop JSON to find all data about the drop, monster name, and level. The resulting output displays the monster name as Monster Name Low level, and the level as 10 .

Drops versions can also be defined in the various Skill info templates for specifying skill levels.

gemw

Whether the item is listed on the Grand Exchange Market Watch. If yes, leave blank, and the price will be pulled automatically. If no, enter "no", which puts "Not sold" in the table cell. Entering "no" will remove the image, requiring manual configuring of the item's image using the "Image=" field.

image

A manual configuration of the item's image. Only use this parameter when the image name (minus extension) does not exactly match the item name. Casing is important, so be sure the "Name" parameter also leads directly to the item's page. In normal circumstances, the item image can automatically be pulled from its GEMW page. Do not add square brackets and the file prefix. Just use "Name.png".