Module:ItemData/nav/doc

Revision as of 01:47, 31 October 2024 by Sur (talk | contribs) (examples now use Armor instead of Weapon to help showcase that its using unlocalized key, not english translation)

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

{{ItemIcon|Extra Health|size=26px}}{{ItemIcon|Extra Regen|size=26px}}{{ItemIcon|Extra Stamina|size=26px}}{{ItemIcon|Grit|size=26px}}{{ItemIcon|Healing Rite|size=26px}}{{ItemIcon|Melee Lifesteal|size=26px}}{{ItemIcon|Rebuttal|size=26px}}{{ItemIcon|Sprint Boots|size=26px}}


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

  Extra Health  Extra Regen  Extra Stamina  Grit  Healing Rite  Melee Lifesteal  Rebuttal  Sprint Boots

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

{{ItemBox|itemName=Extra Health|overrideLinkClick=Extra Health|lowGraphics=true}} {{ItemBox|itemName=Extra Regen|overrideLinkClick=Extra Regen|lowGraphics=true}} {{ItemBox|itemName=Extra Stamina|overrideLinkClick=Extra Stamina|lowGraphics=true}} {{ItemBox|itemName=Grit|overrideLinkClick=Grit|lowGraphics=true}} {{ItemBox|itemName=Healing Rite|overrideLinkClick=Healing Rite|lowGraphics=true}} {{ItemBox|itemName=Melee Lifesteal|overrideLinkClick=Melee Lifesteal|lowGraphics=true}} {{ItemBox|itemName=Rebuttal|overrideLinkClick=Rebuttal|lowGraphics=true}} {{ItemBox|itemName=Sprint Boots|overrideLinkClick=Sprint Boots|lowGraphics=true}}


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

 
Imbue

Extra Health

Active
 
Imbue

Extra Regen

Active
 
Imbue

Extra Stamina

Active
 
Imbue

Grit

Active
 
Imbue

Healing Rite

Active
 
Imbue

Melee Lifesteal

Active
 
Imbue

Rebuttal

Active
 
Imbue

Sprint Boots

Active