Module:ItemData/nav/doc - Revision history

LVL at 16:29, 30 January 2026

2026-01-30T16:29:30Z

← Older revision		Revision as of 16:29, 30 January 2026
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===
Line 13:		Line 13:
	* '''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>)		* '''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 34:		Line 35:
	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 52:		Line 53:

	==write_item_slot_subgroup==		==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]]		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===		===Parameters===
Line 58:		Line 59:
	* '''type''' - The subfunction to call that determines the list formatting style. Options are 'get_item_nav_bulletpoints' or 'get_item_nav_cards'		* '''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.		* '''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===		===Examples===

Monster Domosed at 20:28, 22 April 2025

2025-04-22T20:28:24Z

← Older revision		Revision as of 20:28, 22 April 2025
Line 72:		Line 72:

	Recall that it creates subgroup parameters for the mentioned templates.		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}}

Gammaton32: /* get_item_nav_bulletpoints */ better examples

2025-04-22T01:13:33Z

get_item_nav_bulletpoints: better examples

← Older revision		Revision as of 01:13, 22 April 2025
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\|1250\|~~3001~~\|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\|1250\|~~3001~~\|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\|1250\|3000}}</nowiki></code>

			{{#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>		<code><nowiki>{{#invoke:ItemData/nav\|get_item_nav_bulletpoints\|Armor\|1250\|3001}}</nowiki></code>

Gammaton32: Undo revision 24590 by Gammaton32 (talk) restored

2025-04-22T01:12:24Z

Undo revision 24590 by Gammaton32 (talk) restored

← Older revision		Revision as of 01:12, 22 April 2025
Line 11:		Line 11:
	* '''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.

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

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


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

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

	==get_item_nav_cards==		==get_item_nav_cards==

Gammaton32: Reverted edit by Gammaton32 (talk) to last revision by Sur

2025-04-22T01:09:14Z

Reverted edit by Gammaton32 (talk) to last revision by Sur

← Older revision		Revision as of 01:09, 22 April 2025
Line 11:		Line 11:
	* '''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 ~~('''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>)~~		* '''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.		* '''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)		With debug_mode on (for illustration purposes)
	<code><nowiki>{{#invoke:ItemData/nav\|get_item_nav_bulletpoints\|Armor\|1250\|~~3001~~\|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\|1250\|~~3001~~\|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\|1250\|~~3001~~}}</nowiki></code>		<code><nowiki>{{#invoke:ItemData/nav\|get_item_nav_bulletpoints\|Armor\|1250\|3000}}</nowiki></code>

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

	==get_item_nav_cards==		==get_item_nav_cards==

Gammaton32: /* get_item_nav_bulletpoints */ updated info

2025-04-22T01:04:48Z

get_item_nav_bulletpoints: updated info

← Older revision		Revision as of 01:04, 22 April 2025
Line 11:		Line 11:
	* '''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.

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

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


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

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

	==get_item_nav_cards==		==get_item_nav_cards==

Sur: write_item_slot_subgroup added type parameter

2024-11-01T18:21:27Z

write_item_slot_subgroup added type parameter

← Older revision		Revision as of 18:21, 1 November 2024
Line 51:		Line 51:
	===Parameters===		===Parameters===
	* '''slot''' - Slot/category to create the subgroup for, ie Weapon, Armor, or Tech		* '''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.		* '''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)		With debug_mode on (for illustration purposes)
	<code><nowiki>{{#invoke:ItemData/nav\|write_item_slot_subgroup\|Weapon\|debug_mode=true}}</nowiki></code>		<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\|debug_mode=true}}		{{#invoke:ItemData/nav\|write_item_slot_subgroup\|Weapon\|get_item_nav_bulletpoints\|debug_mode=true}}


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

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

	Recall that it ~~adds~~ subgroup parameters for the mentioned templates.		Recall that it creates subgroup parameters for the mentioned templates.

Sur: write_item_slot_subgroup initial

2024-11-01T17:36:05Z

write_item_slot_subgroup initial

← Older revision		Revision as of 17:36, 1 November 2024
Line 47:		Line 47:

	==write_item_slot_subgroup==		==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
			* '''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\|debug_mode=true}}</nowiki></code>

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


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

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

			Recall that it adds subgroup parameters for the mentioned templates.

Sur: write_item_slot_subgroup pre initial

2024-11-01T17:16:40Z

write_item_slot_subgroup pre initial

← Older revision		Revision as of 17:16, 1 November 2024
Line 45:		Line 45:

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

			==write_item_slot_subgroup==
			{{#invoke:ItemData/nav\|write_item_slot_subgroup\|Weapon}}

Sur: get_item_nav_cards typo, separated by space not bullet point

2024-10-31T02:10:30Z

get_item_nav_cards typo, separated by space not bullet point

← Older revision		Revision as of 02:10, 31 October 2024
Line 27:		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~~.		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.