Template:DropSource/doc: Difference between revisions

From August Wiki
Jump to navigation Jump to search
Created page with "== DropSource Module Variables == === Main Source Variables === * '''source1''', '''source2''', '''source3''', etc. - The names of the sources that drop the item * '''source1Lvl''', '''source2Lvl''', '''source3Lvl''', etc. - The combat level for each source * '''rarity1''', '''rarity2''', '''rarity3''', etc. - The rarity of the item from each source === Quantity Variables === * '''itemQuant''' - Default quantity for all sources (used if no specific quantity is provided..."
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
=How to use this Template=
==Syntax==
To make an entry for a Drop Source, use the Template call <pre>{{DropSource}}</pre>
Inside of the template you'll enter parameters to fill in the template with the appropriate information.
== DropSource Module Variables ==
== DropSource Module Variables ==


Line 33: Line 38:
* And so on...
* And so on...


The module displays a sortable, filterable table showing what sources drop an item, with information about level requirements, quantities, and rarity.
==Example==
Below is an example of the syntax, and the resulting table that is created.
<pre>
{{Template:DropSource
| source1 = Cerberus
| source1Lvl = 318
| source1Quant = 1
| rarity1 = Unknown
| source2 = Legendary Mystery Crate
| source2Lvl = N/A
| source2Quant = 1
| rarity2 = Uncommon
| source3 = Deez
| source3Lvl = N/A
| source3Quant = 1
| rarity3 = Rare
}}
</pre>
{{Template:DropSource
| source1 = Cerberus
| source1Lvl = 318
| source1Quant = 1
| rarity1 = Unknown
| source2 = Legendary Mystery Crate
| source2Lvl = N/A
| source2Quant = 1
| rarity2 = Uncommon
| source3 = Deez
| source3Lvl = N/A
| source3Quant = 1
| rarity3 = Rare
}}
[[Category:Templates]]

Latest revision as of 02:49, 16 March 2025

How to use this Template

Syntax

To make an entry for a Drop Source, use the Template call

{{DropSource}}

Inside of the template you'll enter parameters to fill in the template with the appropriate information.

DropSource Module Variables

Main Source Variables

  • source1, source2, source3, etc. - The names of the sources that drop the item
  • source1Lvl, source2Lvl, source3Lvl, etc. - The combat level for each source
  • rarity1, rarity2, rarity3, etc. - The rarity of the item from each source

Quantity Variables

  • itemQuant - Default quantity for all sources (used if no specific quantity is provided)
  • source1Quant, source2Quant, source3Quant, etc. - Specific quantity for each source (overrides the default)

Rarity

  • rarityStyles - Table mapping rarity names to CSS classes and sort values:
    • Always: table-bg-blue, sort value 1
    • Common: table-bg-green, sort value 16
    • Uncommon: table-bg-yellow, sort value 64
    • Rare: table-bg-orange, sort value 256
    • Very rare: table-bg-red, sort value 1024

Local Variables (Internal)

  • index - Counter used for iterating through numbered sources
  • source - Current source name being processed
  • level - Current level value being processed
  • rarity - Current rarity value being processed
  • quantity - Current quantity value being processed
  • rarityClass - CSS class determined by rarity value
  • raritySort - Sort value determined by rarity value

Format Note

The numbering convention is sequential:

  • First source is specified with source1, source1Lvl, rarity1, and optionally source1Quant
  • Second source is specified with source2, source2Lvl, rarity2, and optionally source2Quant
  • And so on...

Example

Below is an example of the syntax, and the resulting table that is created.

{{Template:DropSource
| source1 = Cerberus
| source1Lvl = 318
| source1Quant = 1
| rarity1 = Unknown
| source2 = Legendary Mystery Crate
| source2Lvl = N/A
| source2Quant = 1
| rarity2 = Uncommon
| source3 = Deez
| source3Lvl = N/A
| source3Quant = 1
| rarity3 = Rare
}}
Source Level Quantity Rarity
Cerberus 318 1 Unknown
Legendary Mystery Crate N/A 1 Uncommon
Deez N/A 1 Rare