Editing Module:ItemData/nav/doc

=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)
<code><nowiki>{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3000|debug_mode=true}}</nowiki></code>

{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3000|debug_mode=true}}


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

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

==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)
<code><nowiki>{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3000|debug_mode=true}}</nowiki></code>

{{#invoke:ItemData/nav|get_item_nav_cards|Armor|1250|3000|debug_mode=true}}


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

{{#invoke:ItemData/nav|get_item_nav_cards|Armor|1250|3000}}

==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)
<code><nowiki>{{#invoke:ItemData/nav|write_item_slot_subgroup|Weapon|get_item_nav_bulletpoints|debug_mode=true}}</nowiki></code>

{{#invoke:ItemData/nav|write_item_slot_subgroup|Weapon|get_item_nav_bulletpoints|debug_mode=true}}


With debug_mode off
<code><nowiki>{{#invoke:ItemData/nav|write_item_slot_subgroup|Weapon|get_item_nav_bulletpoints}}</nowiki></code>

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

Recall that it creates subgroup parameters for the mentioned templates.