Module:ItemData/nav/doc: Difference between revisions
m get_item_nav_cards pre-initial |
m initial version |
||
| Line 1: | Line 1: | ||
=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}} | ||
Revision as of 01:04, 31 October 2024
Overview
Functions for creating navigation boxes/lists for items, grouped by a slot/category and souls
Functions
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|Basic Magazine}} • {{ItemIcon|Close Quarters}} • {{ItemIcon|Headshot Booster}} • {{ItemIcon|High-Velocity Mag}} • {{ItemIcon|Hollow Point Ward}} • {{ItemIcon|Monster Rounds}} • {{ItemIcon|Rapid Rounds}} • {{ItemIcon|Restorative Shot}}
With debug_mode off
{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Weapon|500|1250}}
Basic Magazine • 
Close Quarters • 
Headshot Booster • 
High-Velocity Mag • 
Hollow Point Ward • 
Monster Rounds • 
Rapid Rounds • 
Restorative Shot
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|item_name=Basic Magazine}} {{ItemBox|item_name=Close Quarters}} {{ItemBox|item_name=Headshot Booster}} {{ItemBox|item_name=High-Velocity Mag}} {{ItemBox|item_name=Hollow Point Ward}} {{ItemBox|item_name=Monster Rounds}} {{ItemBox|item_name=Rapid Rounds}} {{ItemBox|item_name=Restorative Shot}}
With debug_mode off
{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Weapon|500|1250}}
 500
|
|---|
|
| Basic Magazine |
| 500
|
|---|
|
| Close Quarters |
| 500
|
|---|
|
| Headshot Booster |
| 500
|
|---|
|
| Monster Rounds |
| 500
|
|---|
|
| Rapid Rounds |
| 500
|
|---|
|
| Restorative Shot |