Module:ItemData/nav/doc: Difference between revisions

From Deadlock Wiki
Jump to navigation Jump to search
Sur (talk | contribs)
m examples now use Armor instead of Weapon to help showcase that its using unlocalized key, not english translation
Sur (talk | contribs)
m example now uses 1250 to 3000 instead of 500 to 1250 to show that its ordered by souls as there is a 1750 soul item
Line 16: Line 16:
===Examples===
===Examples===
With debug_mode on (for illustration purposes)
With debug_mode on (for illustration purposes)
<code><nowiki>{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|500|1250|debug_mode=true}}</nowiki></code>
<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|500|1250|debug_mode=true}}
{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3000|debug_mode=true}}




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


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


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




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


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

Revision as of 01:54, 31 October 2024

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

{{ItemIcon|Bullet Armor}} • {{ItemIcon|Bullet Lifesteal}} • {{ItemIcon|Combat Barrier}} • {{ItemIcon|Debuff Reducer}} • {{ItemIcon|Divine Barrier}} • {{ItemIcon|Enchanter's Barrier}} • {{ItemIcon|Enduring Speed}} • {{ItemIcon|Healbane}} • {{ItemIcon|Healing Booster}} • {{ItemIcon|Healing Nova}} • {{ItemIcon|Reactive Barrier}} • {{ItemIcon|Restorative Locket}} • {{ItemIcon|Return Fire}} • {{ItemIcon|Spirit Armor}} • {{ItemIcon|Spirit Lifesteal}}


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

Bullet Armor Bullet Lifesteal Combat Barrier Debuff Reducer Divine Barrier Enchanter's Barrier Enduring Speed Healbane Healing Booster Healing Nova Reactive Barrier Restorative Locket Return Fire Spirit Armor Spirit Lifesteal

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

{{ItemBox|item_name=Bullet Armor}} {{ItemBox|item_name=Bullet Lifesteal}} {{ItemBox|item_name=Combat Barrier}} {{ItemBox|item_name=Debuff Reducer}} {{ItemBox|item_name=Divine Barrier}} {{ItemBox|item_name=Enchanter's Barrier}} {{ItemBox|item_name=Enduring Speed}} {{ItemBox|item_name=Healbane}} {{ItemBox|item_name=Healing Booster}} {{ItemBox|item_name=Healing Nova}} {{ItemBox|item_name=Reactive Barrier}} {{ItemBox|item_name=Restorative Locket}} {{ItemBox|item_name=Return Fire}} {{ItemBox|item_name=Spirit Armor}} {{ItemBox|item_name=Spirit Lifesteal}}


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


Souls1,250
Bullet Armor
Souls1,250
Bullet Lifesteal
Souls1,250
Combat Barrier
Souls1,250
Debuff Reducer
Souls1,250
ACTIVE
Divine Barrier
Souls1,750

Enduring Speed
Souls1,250
Healbane
Souls1,250
Healing Booster
Souls1,750
ACTIVE

Healing Nova
Souls1,250
Reactive Barrier
Souls1,250
ACTIVE
Restorative Locket
Souls1,250
ACTIVE
Return Fire
Souls1,250
Spirit Armor
Souls1,250
Spirit Lifesteal