Module:ItemData/nav/doc

Revision as of 01:54, 31 October 2024 by Sur (talk | contribs) (example now uses 1250 to 3000 instead of 500 to 1250 to show that its ordered by souls as there is a 1750 soul item)

This is the documentation page for Module:ItemData/nav

Overview

Functions for creating navigation boxes/lists for items, grouped by a slot/category and souls

Functions

get_item_nav_bulletpoints

Gets a list of items that are each sent to the Template:ItemIcon template, separated by bullet points.

Filters down to a slot/specific category, and within a range of souls.

Parameters

  • slot - Slot/category that the items should be, should be Weapon, Armor, or Tech
  • min_souls - Minimum souls that the items should have
  • max_souls - Maximum souls that the items should have
  • debug_mode - (OPTIONAL) - if set to 'true', the wikitext is unprocessed, allowing for it to be read more clearly. Also used for showcasing the documentation examples more clearly.

Examples

With debug_mode on (for illustration purposes) {{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3000|debug_mode=true}}

{{ItemIcon|Battle Vest|size=26px}}{{ItemIcon|Bullet Lifesteal|size=26px}}{{ItemIcon|Debuff Reducer|size=26px}}{{ItemIcon|Enchanter's Emblem|size=26px}}{{ItemIcon|Enduring Speed|size=26px}}{{ItemIcon|Guardian Ward|size=26px}}{{ItemIcon|Healbane|size=26px}}{{ItemIcon|Healing Booster|size=26px}}{{ItemIcon|Reactive Barrier|size=26px}}{{ItemIcon|Restorative Locket|size=26px}}{{ItemIcon|Return Fire|size=26px}}{{ItemIcon|Spirit Lifesteal|size=26px}}{{ItemIcon|Spirit Shielding|size=26px}}{{ItemIcon|Trophy Collector|size=26px}}{{ItemIcon|Weapon Shielding|size=26px}}


With debug_mode off {{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3000}}

  Battle Vest  Bullet Lifesteal  Debuff Reducer  Enchanter's Emblem  Enduring Speed  Guardian Ward  Healbane  Healing Booster  Reactive Barrier  Restorative Locket  Return Fire  Spirit Lifesteal  Spirit Shielding  Trophy Collector  Weapon Shielding

get_item_nav_cards

Gets a list of items that are each sent to the Template:ItemBox template, separated by bullet points.

Filters down to a specific slot/category, and within a range of souls.

Parameters

Same as get_item_nav_bulletpoints

Examples

With debug_mode on (for illustration purposes) {{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3000|debug_mode=true}}

{{ItemBox|itemName=Battle Vest|overrideLinkClick=Battle Vest|lowGraphics=true}} {{ItemBox|itemName=Bullet Lifesteal|overrideLinkClick=Bullet Lifesteal (item)|lowGraphics=true}} {{ItemBox|itemName=Debuff Reducer|overrideLinkClick=Debuff Reducer|lowGraphics=true}} {{ItemBox|itemName=Enchanter's Emblem|overrideLinkClick=Enchanter's Emblem|lowGraphics=true}} {{ItemBox|itemName=Enduring Speed|overrideLinkClick=Enduring Speed|lowGraphics=true}} {{ItemBox|itemName=Guardian Ward|overrideLinkClick=Guardian Ward|lowGraphics=true}} {{ItemBox|itemName=Healbane|overrideLinkClick=Healbane|lowGraphics=true}} {{ItemBox|itemName=Healing Booster|overrideLinkClick=Healing Booster|lowGraphics=true}} {{ItemBox|itemName=Reactive Barrier|overrideLinkClick=Reactive Barrier|lowGraphics=true}} {{ItemBox|itemName=Restorative Locket|overrideLinkClick=Restorative Locket|lowGraphics=true}} {{ItemBox|itemName=Return Fire|overrideLinkClick=Return Fire|lowGraphics=true}} {{ItemBox|itemName=Spirit Lifesteal|overrideLinkClick=Spirit Lifesteal (item)|lowGraphics=true}} {{ItemBox|itemName=Spirit Shielding|overrideLinkClick=Spirit Shielding|lowGraphics=true}} {{ItemBox|itemName=Trophy Collector|overrideLinkClick=Trophy Collector|lowGraphics=true}} {{ItemBox|itemName=Weapon Shielding|overrideLinkClick=Weapon Shielding|lowGraphics=true}}


With debug_mode off {{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3000}}

 
Imbue

Battle Vest

Active
 
Imbue

Bullet Lifesteal

Active
 
Imbue

Debuff Reducer

Active
 
Imbue

Enchanter's Emblem

Active
 
Imbue

Enduring Speed

Active
 
Imbue

Guardian Ward

Active
 
Imbue

Healbane

Active
 
Imbue

Healing Booster

Active
 
Imbue

Reactive Barrier

Active
 
Imbue

Restorative Locket

Active
 
Imbue

Return Fire

Active
 
Imbue

Spirit Lifesteal

Active
 
Imbue

Spirit Shielding

Active
 
Imbue

Trophy Collector

Active
 
Imbue

Weapon Shielding

Active