Module:ItemData/nav/doc: Difference between revisions

Jump to navigation Jump to search
Sur (talk | contribs)
m get_item_nav_cards pre-initial
Sur (talk | contribs)
m initial version
Line 1: Line 1:
=Overview=
=Overview=
overview
Functions for creating navigation boxes/lists for items, grouped by a slot/category and souls


=Functions=
=Functions=
==get_item_nav_bulletpoints==
==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===
===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===
===Examples===
With debug_mode on (for illustration purposes)
<code><nowiki>{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Weapon|500|1250|debug_mode=true}}</nowiki></code>
<code><nowiki>{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Weapon|500|1250|debug_mode=true}}</nowiki></code>


Line 13: Line 21:




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


Line 18: Line 27:


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


Line 23: Line 41:




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


{{#invoke:ItemData/nav|get_item_nav_cards|Weapon|500|1250}}
{{#invoke:ItemData/nav|get_item_nav_cards|Weapon|500|1250}}
===Parameters===
===Examples===