Module:ItemData/nav/doc: Difference between revisionsGive feedback
m get_item_nav_cards typo, separated by space not bullet point |
No edit summary |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
=Overview= | =Overview= | ||
Functions for creating navigation boxes/lists for items, grouped by a slot/category and souls | Functions for creating navigation boxes/lists for items, grouped by a slot/category and souls. Supports filtering for Street Brawl items. | ||
=Functions= | =Functions= | ||
| Line 6: | Line 6: | ||
Gets a list of items that are each sent to the [[Template:ItemIcon]] template, separated by bullet points. | 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. | Filters down to a slot/specific category, and within a range of souls. Can optionally filter for Street Brawl items. | ||
===Parameters=== | ===Parameters=== | ||
* '''slot''' - Slot/category that the items should be, should be Weapon, Armor, or Tech | * '''slot''' - Slot/category that the items should be, should be Weapon, Armor, or Tech | ||
* '''min_souls''' - Minimum souls that the items should have | * '''min_souls''' - Minimum souls that the items should have | ||
* '''max_souls''' - Maximum souls that the items should have | * '''max_souls''' - Maximum souls that the items should have ('''Note:''' the command does not include items ''equal to'' this value, so in order to include them it should be written as <code>cost + 1</code>) | ||
* '''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. | * '''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. | ||
* '''filter''' - (OPTIONAL) - Filters items based on Street Brawl status. Options: <code>exclude_street_brawl</code> (show only regular items), <code>street_brawl_only</code> (show only Street Brawl items), or unset (show all) | |||
===Examples=== | ===Examples=== | ||
| Line 25: | Line 26: | ||
{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3000}} | {{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3000}} | ||
To include the 3000 items | |||
<code><nowiki>{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3001}}</nowiki></code> | |||
{{#invoke:ItemData/nav|get_item_nav_bulletpoints|Armor|1250|3001}} | |||
==get_item_nav_cards== | ==get_item_nav_cards== | ||
Gets a list of items that are each sent to the [[Template:ItemBox]] template, separated by space. | 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. | Filters down to a specific slot/category, and within a range of souls. Can optionally filter for Street Brawl items. | ||
===Parameters=== | ===Parameters=== | ||
| Line 45: | Line 51: | ||
{{#invoke:ItemData/nav|get_item_nav_cards|Armor|1250|3000}} | {{#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]]. Street Brawl items are automatically separated into their own row at the end. | |||
===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. | |||
* '''street_brawl_label''' - (OPTIONAL) - Custom label text for the Street Brawl row. Defaults to "Street Brawl" | |||
===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. | |||
==generate_active_items_table== | |||
Creates table of localized released active items. Used in [[Template:Active Items]] | |||
===Example=== | |||
<pre>{{#invoke:ItemData/nav|generate_active_items_table}}</pre> | |||
{{#invoke:ItemData/nav|generate_active_items_table}} | |||