Module:ItemData/nav/doc

Revision as of 01:04, 31 October 2024 by Sur (talk | contribs) (initial version)

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|Weapon|500|1250|debug_mode=true}}

{{ItemIcon|Close Quarters|size=26px}}{{ItemIcon|Extended Magazine|size=26px}}{{ItemIcon|Headshot Booster|size=26px}}{{ItemIcon|High-Velocity Rounds|size=26px}}{{ItemIcon|Monster Rounds|size=26px}}{{ItemIcon|Rapid Rounds|size=26px}}{{ItemIcon|Restorative Shot|size=26px}}


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

  Close Quarters  Extended Magazine  Headshot Booster  High-Velocity Rounds  Monster Rounds  Rapid Rounds  Restorative Shot

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|Weapon|500|1250|debug_mode=true}}

{{ItemBox|itemName=Close Quarters|overrideLinkClick=Close Quarters|lowGraphics=true}} {{ItemBox|itemName=Extended Magazine|overrideLinkClick=Extended Magazine|lowGraphics=true}} {{ItemBox|itemName=Headshot Booster|overrideLinkClick=Headshot Booster|lowGraphics=true}} {{ItemBox|itemName=High-Velocity Rounds|overrideLinkClick=High-Velocity Rounds|lowGraphics=true}} {{ItemBox|itemName=Monster Rounds|overrideLinkClick=Monster Rounds|lowGraphics=true}} {{ItemBox|itemName=Rapid Rounds|overrideLinkClick=Rapid Rounds|lowGraphics=true}} {{ItemBox|itemName=Restorative Shot|overrideLinkClick=Restorative Shot|lowGraphics=true}}


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

 
Imbue

Close Quarters

Active
 
Imbue

Extended Magazine

Active
 
Imbue

Headshot Booster

Active
 
Imbue

High-Velocity Rounds

Active
 
Imbue

Monster Rounds

Active
 
Imbue

Rapid Rounds

Active
 
Imbue

Restorative Shot

Active