Module:Tier List/doc: Difference between revisions

Revision as of 17:59, 8 March 2026

Module:Tier_List is used to generate tier lists directly within the wiki.

It currently supports two rendering methods:

drawCargoTable – renders entries using Cargo data
drawSimple – renders entries directly from the provided text

Usage

drawCargoTable

Use drawCargoTable when the first argument is the name of a Cargo table, and the remaining arguments are the tiers in top-to-bottom order.

Required argument order:

Cargo table name
All tiers, ordered from top to bottom

Within each tier, define the tier label first, followed by a semicolon character (;), then a comma-separated list of item names.

The item names should match the values stored in the Cargo table exactly.

Example

{{#invoke:Tier List|drawCargoTable
|Mask
|S;Zeus,Monopoly,Thanos,Animal Control
|A;Anonymous,Anti-Silence,Bunny,Death Knight,Death Wish
|B;Equalizer,Ghost,Glitch,Grave Digger
|C;Headless,Holy,Joker,Lover,Monopoly,Muqsit
|D;Necromancer,Outpost,Party,Pilgrim
}}

S

Zeus

Monopoly

Thanos

Animal Control

A

Anonymous

Anti-Silence

Bunny

Death Knight

Death Wish

B

Equalizer

Ghost

Glitch

Grave Digger

C

Headless

Holy

Joker

Lover

Monopoly

Muqsit

D

Necromancer

Outpost

Party

Pilgrim

drawSimple

Use drawSimple when you want to render a tier list directly from the provided text without using Cargo.

Required argument order:

All tiers, ordered from top to bottom

Within each tier, define the tier label first, followed by a semicolon character (;), then a comma-separated list of item names.

Example

{{#invoke:Tier List|drawSimple
|S;Blackout,Divine Immolation,Godly Overload,Deadly Disarmor
|A;Bleed,Deathbringer,Guardians,Gears,Execute
|B;Angelic,Armored,Dodge,Enlighted,Ghost
|C;Auto Smelt,Haste,Glowing,Headless,Confusion
|D;Aquatic,Anti Gravity,Experience,Decapitation
}}

S

Blackout

Divine Immolation

Godly Overload

Deadly Disarmor

A

Bleed

Deathbringer

Guardians

Gears

Execute

B

Angelic

Armored

Dodge

Enlighted

Ghost

C

Auto Smelt

Haste

Glowing

Headless

Confusion

D

Aquatic

Anti Gravity

Experience

Decapitation

Notes

drawCargoTable expects the first argument to be a valid Cargo table name.
For Cargo rendering, item names must match the stored name values exactly.
drawSimple does not query Cargo and only displays the provided labels directly.
drawTierList may still exist as an alias for drawCargoTable if backward compatibility is enabled.

@@ Line 1: / Line 1: @@
-<code>Module:Tier_List</code> is used to generate tier lists directly within the wiki using HTML, and the existing character labels.
+<code>Module:Tier_List</code> is used to generate tier lists directly within the wiki.
+It currently supports two rendering methods:
+* <code>drawCargoTable</code> – renders entries using Cargo data
+* <code>drawSimple</code> – renders entries directly from the provided text
 ==Usage==
-A tier list requires that arguments be present in order.
-# The abbreviation for the game (IE: GGACR, GBVS, DBFZ, etc)
-# All of the tiers, ordered from top to bottom
-Within a given tier, you must define the label for that tier (the letter that appears inside of the colored square) followed by a semicolon character (';').
+===drawCargoTable===
+Use <code>drawCargoTable</code> when the first argument is the name of a Cargo table, and the remaining arguments are the tiers in top-to-bottom order.
+Required argument order:
+# Cargo table name
+# All tiers, ordered from top to bottom
-===Short Names in Labels===
+Within each tier, define the tier label first, followed by a semicolon character (<code>;</code>), then a comma-separated list of item names.
-The tier list will attempt to find the appropriate icon and link for a given character. If you choose not to use the full name of a character, you must set up a necessary redirect from the short name to the full name. This applies to both the icon file and the character page itself.
-For example: We want to show "Sol" on our tier list instead of "Sol Badguy". We must create 2 redirects.
+The item names should match the values stored in the Cargo table exactly.
-* Redirect from <code><nowiki>[[File:GGACR_Sol_Icon.png]]</nowiki></code> to <code><nowiki>[[File:GGACR_Sol_Badguy_Icon.png]]</nowiki></code>
-* Redirect from <code><nowiki>[[GGACR/Sol]]</nowiki></code> to <code><nowiki>[[GGACR/Sol_Badguy]]</nowiki></code>
-==Example==
+====Example====
 <pre>
-{{#invoke:Tier List|drawTierList
+{{#invoke:Tier List|drawCargoTable
 |Mask
 |S;Zeus,Monopoly,Thanos,Animal Control
@@ Line 27: / Line 30: @@
 </pre>
-{{#invoke:Tier List|drawTierList
+{{#invoke:Tier List|drawCargoTable
 |Mask
-|S;Monopoly,Zeus,Thanos,Animal Control
+|S;Zeus,Monopoly,Thanos,Animal Control
 |A;Anonymous,Anti-Silence,Bunny,Death Knight,Death Wish
 |B;Equalizer,Ghost,Glitch,Grave Digger
@@ Line 35: / Line 38: @@
 |D;Necromancer,Outpost,Party,Pilgrim
 }}
+===drawSimple===
+Use <code>drawSimple</code> when you want to render a tier list directly from the provided text without using Cargo.
+Required argument order:
+# All tiers, ordered from top to bottom
+Within each tier, define the tier label first, followed by a semicolon character (<code>;</code>), then a comma-separated list of item names.
+====Example====
+<pre>
+{{#invoke:Tier List|drawSimple
+|S;Blackout,Divine Immolation,Godly Overload,Deadly Disarmor
+|A;Bleed,Deathbringer,Guardians,Gears,Execute
+|B;Angelic,Armored,Dodge,Enlighted,Ghost
+|C;Auto Smelt,Haste,Glowing,Headless,Confusion
+|D;Aquatic,Anti Gravity,Experience,Decapitation
+}}
+</pre>
+{{#invoke:Tier List|drawSimple
+|S;Blackout,Divine Immolation,Godly Overload,Deadly Disarmor
+|A;Bleed,Deathbringer,Guardians,Gears,Execute
+|B;Angelic,Armored,Dodge,Enlighted,Ghost
+|C;Auto Smelt,Haste,Glowing,Headless,Confusion
+|D;Aquatic,Anti Gravity,Experience,Decapitation
+}}
+==Notes==
+* <code>drawCargoTable</code> expects the first argument to be a valid Cargo table name.
+* For Cargo rendering, item names must match the stored <code>name</code> values exactly.
+* <code>drawSimple</code> does not query Cargo and only displays the provided labels directly.
+* <code>drawTierList</code> may still exist as an alias for <code>drawCargoTable</code> if backward compatibility is enabled.