Jump to content

Module:ItemData/nav/doc

From The Deadlock Wiki
Revision as of 18:21, 1 November 2024 by Sur (talk | contribs) (write_item_slot_subgroup added type parameter)

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}} • {{ItemIcon|Bullet Lifesteal}} • {{ItemIcon|Debuff Reducer}} • {{ItemIcon|Enchanter's Emblem}} • {{ItemIcon|Enduring Speed}} • {{ItemIcon|Guardian Ward}} • {{ItemIcon|Healbane}} • {{ItemIcon|Healing Booster}} • {{ItemIcon|Reactive Barrier}} • {{ItemIcon|Restorative Locket}} • {{ItemIcon|Return Fire}} • {{ItemIcon|Spirit Lifesteal}} • {{ItemIcon|Spirit Shielding}} • {{ItemIcon|Weapon Shielding}}


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 Weapon Shielding

get_item_nav_cards

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

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|item_name=Battle Vest}} {{ItemBox|item_name=Bullet Lifesteal}} {{ItemBox|item_name=Debuff Reducer}} {{ItemBox|item_name=Enchanter's Emblem}} {{ItemBox|item_name=Enduring Speed}} {{ItemBox|item_name=Guardian Ward}} {{ItemBox|item_name=Healbane}} {{ItemBox|item_name=Healing Booster}} {{ItemBox|item_name=Reactive Barrier}} {{ItemBox|item_name=Restorative Locket}} {{ItemBox|item_name=Return Fire}} {{ItemBox|item_name=Spirit Lifesteal}} {{ItemBox|item_name=Spirit Shielding}} {{ItemBox|item_name=Weapon Shielding}}


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


Souls1,600
Battle Vest
Souls1,600
Bullet Lifesteal
Souls1,600
Debuff Reducer
Souls1,600

Enduring Speed
Souls1,600
ACTIVE
Guardian Ward
Souls1,600
Healbane
Souls1,600

Healing Booster
Souls1,600
Reactive Barrier
Souls1,600
ACTIVE
Restorative Locket
Souls1,600
ACTIVE
Return Fire
Souls1,600
Spirit Lifesteal
Souls1,600
Spirit Shielding
Souls1,600
Weapon Shielding

write_item_slot_subgroup

Writes a sub group for the navbox on Template:Item Navbox and Template:Infobox ShopItems. The sub group contains all items in each price range from "ItemPricePerTier" in Data:GenericData.json

Parameters

  • slot - Slot/category to create the subgroup for, ie Weapon, Armor, or Tech
  • type - The subfunction to call that determines the list formatting style. Options are 'get_item_nav_bulletpoints' or 'get_item_nav_cards'
  • 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|write_item_slot_subgroup|Weapon|get_item_nav_bulletpoints|debug_mode=true}}


With debug_mode off {{#invoke:ItemData/nav|write_item_slot_subgroup|Weapon|get_item_nav_bulletpoints}}

Recall that it creates subgroup parameters for the mentioned templates.