Template:DropsLine/doc

From the RuneScape Wiki, the wiki for all things RuneScape
Jump to: navigation, search
Information icon-grey.svg
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 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

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

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

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. If unknown, leave blank or use "Unknown." -->
|Quantitynotes = <!-- (Optional) Extra things added into the Quantity column, to not disrupt the colouring-->
|Rarity      = <!-- How rare the item is, specify as a fraction (eg. "1/128") or use: Always, Common, Uncommon, Rare, Very rare, Varies, Unknown -->
|Raritynotes = <!-- (Optional) Extra things added into the Rarity column, to not disrupt the colouring-->
|Members     = <!-- (Optional) "yes" if item is members-only -->
|gemw        = <!-- (Optional) "no" if item is not sold on the GE -->
|alch        = <!-- (Optional) "no" if item cannot be alchemised -->
|AltValue    = <!-- (Optional) The value to display when gemw=no and/or alch=no -->
|AltCurrency = <!-- (Optional) The currency of the AltValue for items that have no value in coins -->
|Image       = <!-- (Optional) Manual addition or override of the image icon. Don't add [[File:_]] -->
|Sort        = <!-- (Optional) Manual sort category override -->
|Version     = <!-- (Optional) Used to apply the drop to only specified versions of the monster -->
|nosmw       = <!-- (Optional) Suppress SMW output -->
|smwjson     = <!-- (Optional) Adds item to RDT SMW instead of normal SMW. Used only on {{Rare drop table}} -->
}}
{{DropsTableEnd}}

The template should be used in one line, like the examples below.

Unfilled drop lines for quick copy-paste

GE Item

{{DropsLine|Name = |Quantity = |Rarity = }}

Non-GE item (can be alchemised)

{{DropsLine|Name = |Quantity = |Rarity = |gemw = no}}

Non-GE item (cannot be alchemised)

{{DropsLine|Name = |Quantity = |Rarity = |gemw = no|alch = no}}

Non-GE item (cannot be alchemised, has a value)

{{DropsLine|Name = |Quantity = |Rarity = |gemw = no|alch = no|AltValue = }}

All parameters
{{DropsLine|Name = |Namenotes = |Quantity = |Quantitynotes = |Rarity = |Raritynotes = |Members = |gemw = |alch = |AltValue = |AltCurrency = |Image = |Sort = |Version = |nosmw = }}

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, use the "Namenotes" parameter. This will allow the Image, gemw and other parameters to still work. If a reference needs to be added to the name this should be done here using a ref tag <ref name="refname">Reference text</ref>

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. If a range is dropped specify this with a dash as in 1-3 and if items are dropped noted add this to the quantity column as (noted) with a space between the quantity and noted.

The quantity 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.

Quantitynotes (optional)

If extra notes need adding to the item quantity, use the "Quantitynotes" parameter. This will allow sorting by quantity to still work.Do not use to specify noted, do this using (noted) after the number/range under "Quantity". If a reference needs to be added to the quantity this should be done here using a ref tag <ref name="refname">Reference text</ref>. If a reference is being used it should use the reference group "d". For example |Quantitynotes = <ref name="drop-notes" group="d">Only inside [[Armadyl's Eyrie]]</ref>

Rarity

Rarity of the item. Rarity can either be a number or a category, a number is preferred.

Number

Whether sourced through RuneMetrics drop logs, from a Jagex moderator statement, or other, drop chances can be given as a rarity. They should generally be added as a fraction, e.g. 1/128, 10/512, 1/5000 etc. The module will automatically provide colours and similar. Numbers will automatically be converted to the users preference of fraciton, 1 over fraction or percent.

RuneMetrics

If the RuneMetrics drop logs project is used for drop chances, the kills parameter of the table head should be provided as the number of kills. This will automatically provide a source on the Rarity column header and make the table bottom generate the references list below the table. The reference is in group "drops", so other references intended for below the table should use this.

Other

The source for the drop chance should be provided via a reference in the Raritynotes parameter. Generally it should use the reference group "drops", unless it is a citation (see RuneScape:Style guide/References and citations for more info.

Category

Categories should be used if there's no good way to find an accurate drop chance. There are 6 available options:

Rarity Explanation
Always Always dropped by the monster
Common The most common of items. Renowned for being common. Nearly always dropped.
Uncommon Dropped sometimes, but not necessarily renowned for being common
Rare Rarely dropped. Will take quite a few drops to obtain.
Very rare Renowned for being rare among players. Hardly ever dropped. Items like the divine sigil, some dragon items, etc.
Varies/Random 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 or a number defaults to a white color.

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 are only dropped during that quest, Dragon eggs are only dropped when the player has level 99 Summoning, items only dropped in the God wars dungeon etc), use the "Raritynotes" parameter. This will allow the colouring of the standard rarities to still work.

Generally these are added using a ref tag <ref name="refname" group="d">Reference text</ref>. If a reference is being used in Raritynotes, generally it should use the reference group "d". For example: |Raritynotes = <ref name="drop-notes" group="d">Players who previously bought this in the [[Battle of Lumbridge]] will have a greater chance of receiving this as a drop.</ref>

Members (optional)

Whether or not it is a members item. This data is pulled automatically by the module, however for abilities or other non-item drops this must be set manually. If a drop is members-only set to "yes".

gemw (optional)

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, or the alchemy/AltValue if one is specified. Possible values are "no" and "yes".

alch (optional)

Whether of not an item can be alchemised, use "no" if it cannot be alchemised. Possible values are "no" and "yes".

AltValue (optional)

Specify an alternate value for an item. Used for items that are not sold on the GE but have a value, Tokkul is an example. This should be the value of a single item, the total value or range is calculated automatically. Should be an unformated number, do not use commas as thousand separators, and do not use abbreviations like k and m - input 9000, not 9,000 or 9k. This will be displayed in place of the GE price and/or the high alchemy price (and is marked as an alternate value). Set |gemw=no and/or |alch=no to display the AltValue in the respective column.

AltCurrency (optional)

Specify an alternate currency for the AltValue. Allows the specification of a currency other than coins (gp) for the alternate value if the item has no value in coins. Possible values are: Rusty coins, Zemomark, Tokkul, Runecrafting guild tokens, Trading sticks, Ecto-tokens, Chimes, Beans, Pieces of eight, Dungeoneering tokens, Teci.

Image (optional)

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".

Sort (optional)

Drops automatically have a sortkey calculated for the image column, which is the default sort for a drops table. The sortkey is always category raritynum lowercasename, with the category calculated from the item name - e.g. weapons 5 abyssal whip. The calculated category is one of: runes talismans armour weapons ammunition logs herbs seeds spirits ores bars gems raw potions salvage !!Bones zzz !!! !other, where zzz is the rare drop table (sorts to end), !!! is coins (sorts to front), and !other is everything that isn't recognised as one of the other categories.

If the automatically calculated sort category is poor, then it can be defined with the Sort parameter to correct it. While any value can be entered, it should be one of the above to fit correctly with the other items (though if everything is changed...). The rarity sort number cannot be changed.

Version (optional)

Used to specify that the drop only applies to the specified version of the monster. A single or comma separated list of version names for the monster. These version names must match the version names used in the infobox. If a Version was specified in the DropsTableHead these values are added to that one. Note: Cannot be used to override the version specified in DropsTableHead only add to it. Will automatically add a rarity note specifying that the drop only applies to the given versions.

nosmw (optional)

If this is present (it doesn't matter what the exact value is), Semantic MediaWiki output will be suppressed. This will prevent the item from being added to drop source lists generated by {{Dropping monsters list}}. Mostly for historical articles, or where the monster is not reachable anymore.

smwjson (optional)

When set to smwjson=rdt, the item is added to rare drop table Semantic MediaWiki output instead of normal Semantic MediaWiki output. Used only on {{Rare drop table}}.

Data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

Template for an individual drop line for monster drop-tables.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
NameName

Name of the item (as it appears on its page)

Default
empty
Example
Bones
Auto value
empty
Stringrequired
NamenotesNamenotes

Add extra notes need adding to the item name, or a reference.

Default
empty
Example
<ref name="refname" group="d">Reference text</ref>
Auto value
empty
Stringoptional
QuantityQuantity

Quantity of the item dropped by the monster. Can be a comma seperated list and/or range. Include (noted) if it applies.

Default
empty
Example
1-10 (noted)
Auto value
empty
Unknownrequired
QuantitynotesQuantitynotes

Use to add extra info to the quantity or a reference.

Default
empty
Example
<ref name="drop-notes" group="d">Only inside [[Armadyl's Eyrie]]</ref>
Auto value
empty
Unknownoptional
RarityRarity

Rarity of the item. Rarity can either be a number or a category, a number is preferred.

Default
empty
Example
1/128
Auto value
empty
Stringrequired
RaritynotesRaritynotes

Add extra notes to the rarity, or add a reference.

Default
empty
Example
<ref name="drop-notes" group="d">Players who previously bought this in the [[Battle of Lumbridge]] will have a greater chance of receiving this as a drop.</ref>
Auto value
empty
Stringoptional
Members itemMembers

If it is a members item. Fail safe for drops that aren't items

Default
empty
Example
yes
Auto value
empty
Unknownoptional
Sold on GEgemw

Whether or not item is sold on GE

Default
empty
Example
no
Auto value
empty
Stringoptional
Alchemyalch

Whether of not an item can be alchemised, use "no" if it cannot be alchemised.

Default
empty
Example
no
Auto value
empty
Unknownoptional
Alternate ValueAltValue

Specify an alternate value for an item such as for Tokkul. This is the value of 1 item, total is calculated automatically.

Default
empty
Example
1000
Auto value
empty
Numberoptional
Alternate CurrencyAltCurrency

Specify an alternate currency for the AltValue if not gp.

Default
empty
Example
Chimes
Auto value
empty
Stringoptional
ImageImage

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.

Default
empty
Example
Left skull half.png
Auto value
empty
Unknownoptional
Sort key (Img column)Sort

The sortkey is always "category raritynum lowercasename". f the automatically calculated sort category is poor, then it can be defined with the Sort parameter to correct it.

Default
empty
Example
weapons 5 abyssal whip
Auto value
empty
Stringoptional
VersionVersion

The version, or versions of the monster that this drop table applies to. A single value or a comma separated list.

Default
empty
Example
Level 10
Auto value
empty
Stringoptional
No Semantic Wikinosmw

If this is present (it doesn't matter what the exact value is), Semantic MediaWiki output will be suppressed. This will prevent the item from being added to drop source lists generated by Template:Dropping monsters list. Mostly for historical articles, or where the monster is not reachable anymore.

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Semantic Wiki JSONsmwjson

When set to smwjson=rdt, the item is added to rare drop table Semantic MediaWiki output instead of normal Semantic MediaWiki output. Used only on Template:Rare drop table.

Default
empty
Example
empty
Auto value
empty
Unknownoptional