Module:ItemData/nav/doc

Revision as of 18:21, 1 November 2024 by Sur (talk | contribs) (write_item_slot_subgroup added type parameter)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This is the documentation page for Module:ItemData/nav

Overview edit

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

Functions edit

get_item_nav_bulletpoints edit

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 edit

  • 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 edit

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

{{ItemIcon|Bullet Armor}} • {{ItemIcon|Bullet Lifesteal}} • {{ItemIcon|Combat Barrier}} • {{ItemIcon|Debuff Reducer}} • {{ItemIcon|Divine Barrier}} • {{ItemIcon|Enchanter's Barrier}} • {{ItemIcon|Enduring Speed}} • {{ItemIcon|Healbane}} • {{ItemIcon|Healing Booster}} • {{ItemIcon|Healing Nova}} • {{ItemIcon|Reactive Barrier}} • {{ItemIcon|Restorative Locket}} • {{ItemIcon|Return Fire}} • {{ItemIcon|Spirit Armor}} • {{ItemIcon|Spirit Lifesteal}}


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

  Bullet Armor  Bullet Lifesteal  Combat Barrier  Debuff Reducer  Divine Barrier  Enchanter's Barrier  Enduring Speed  Healbane  Healing Booster  Healing Nova  Reactive Barrier  Restorative Locket  Return Fire  Spirit Armor  Spirit Lifesteal

get_item_nav_cards edit

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 edit

Same as get_item_nav_bulletpoints

Examples edit

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

{{ItemBox|item_name=Bullet Armor}} {{ItemBox|item_name=Bullet Lifesteal}} {{ItemBox|item_name=Combat Barrier}} {{ItemBox|item_name=Debuff Reducer}} {{ItemBox|item_name=Divine Barrier}} {{ItemBox|item_name=Enchanter's Barrier}} {{ItemBox|item_name=Enduring Speed}} {{ItemBox|item_name=Healbane}} {{ItemBox|item_name=Healing Booster}} {{ItemBox|item_name=Healing Nova}} {{ItemBox|item_name=Reactive Barrier}} {{ItemBox|item_name=Restorative Locket}} {{ItemBox|item_name=Return Fire}} {{ItemBox|item_name=Spirit Armor}} {{ItemBox|item_name=Spirit Lifesteal}}


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


 1,250
 
Bullet Armor
 1,250
 
Combat Barrier
 1,250
 
Debuff Reducer
 1,250
 
ACTIVE
Divine Barrier
 1,250
 
Healbane
 1,750
 
ACTIVE

 

Healing Nova
 1,250
 
ACTIVE
Restorative Locket
 1,750
 
ACTIVE

 

Return Fire
 1,250
 
Spirit Armor

write_item_slot_subgroup edit

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 edit

  • 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 edit

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.