Module:NpcData/doc - Revision history

Gammaton32: /* Available Functions */ outdated example

2026-08-11T14:07:15Z

Available Functions: outdated example

← Older revision		Revision as of 14:07, 11 August 2026
Line 27:		Line 27:
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|trooper_normal\|MaxHealth}}</nowiki></code>		** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|trooper_normal\|MaxHealth}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_npc_var\|trooper_normal\|MaxHealth}}		** '''Result:''' {{#invoke:NpcData\|get_npc_var\|trooper_normal\|MaxHealth}}

	* To get the Respawn Delay for a Rejuvenator (nested object):
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|citadel_item_pickup_rejuv\|RebirthModifier\|RespawnDelay}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_npc_var\|citadel_item_pickup_rejuv\|RebirthModifier\|RespawnDelay}}

	* To get the name of a Walker's second ability (nested in BoundAbilities):		* To get the name of a Walker's second ability (nested in BoundAbilities):

LVL: Updated doc to reflect the current code

2026-02-07T15:25:52Z

Updated doc to reflect the current code

← Older revision		Revision as of 15:25, 7 February 2026
Line 10:		Line 10:

	=== Get a Single or Nested Stat (`get_npc_var`) ===		=== Get a Single or Nested Stat (`get_npc_var`) ===
	This is the primary function for retrieving NPC data. It can get a simple top-level stat or traverse into nested objects and arrays ~~using additional parameters~~.		This is the primary function for retrieving NPC data. It can get a simple top-level stat or traverse deeply into nested objects and arrays (up to 6 levels deep via the template).

	'''Syntax'''		'''Syntax'''
Line 16:		Line 16:

	'''Parameters'''		'''Parameters'''
	* '''NPC Name:''' The internal key for the NPC. ~~For example~~, `npc_boss_tier2` or `~~trooper_medic~~`.		* '''NPC Name:''' The internal key for the NPC (e.g., `npc_boss_tier2`, `trooper_normal`).
	* '''Key 1, Key 2, ...:''' The path to the stat you want.		* '''Key 1, Key 2, ...:''' The path to the stat you want.
	** For a simple stat, this is ~~just~~ one key (e.g., `MaxHealth`).		** For a simple stat, this is one key (e.g., `MaxHealth`).
	** For a nested ~~stat~~, provide each key as a ~~separate parameter~~ (e.g., `~~Shield~~`, `~~BaseAbsorptionPerSecond~~`).		** For nested data, provide each key in order (e.g., `RebirthModifier`, `RespawnDelay`).
			** For arrays (lists), use the position number as a key (e.g., `IntrinsicModifiers`, `1`, `BULLET_ARMOR_DAMAGE_RESIST`).
	* '''Rounding:''' (Optional) A number to round the result to that many significant figures. This should always be the last parameter.		* '''Rounding:''' (Optional) A number to round the result to that many significant figures. This should always be the last parameter.

	'''Examples'''		'''Examples'''
	* To get the max health of a ~~Medic~~ Trooper ~~(a simple stat)~~:		* To get the max health of a Normal Trooper:
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|~~trooper_medic~~\|MaxHealth}}</nowiki></code>		** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|trooper_normal\|MaxHealth}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_npc_var\|~~trooper_medic~~\|MaxHealth}}		** '''Result:''' {{#invoke:NpcData\|get_npc_var\|trooper_normal\|MaxHealth}}

	* To get the ~~base shield absorption of the Mid-Boss~~ (a nested ~~stat~~):		* To get the Respawn Delay for a Rejuvenator (nested object):
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|~~npc_super_neutral~~\|~~Shield~~\|~~BaseAbsorptionPerSecond~~}}</nowiki></code>		** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|citadel_item_pickup_rejuv\|RebirthModifier\|RespawnDelay}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_npc_var\|~~npc_super_neutral~~\|~~Shield~~\|~~BaseAbsorptionPerSecond~~}}		** '''Result:''' {{#invoke:NpcData\|get_npc_var\|citadel_item_pickup_rejuv\|RebirthModifier\|RespawnDelay}}

	* To get the name of ~~the Tier 2 Boss~~'s ~~first bound~~ ability (nested in ~~an object and an array~~):		* To get the name of a Walker's second ability (nested in BoundAbilities):
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|npc_boss_tier2\|BoundAbilities\|1\|Name}}</nowiki></code>		** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|npc_boss_tier2\|BoundAbilities\|ESlot_Signature_2\|Name}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_npc_var\|npc_boss_tier2\|BoundAbilities\|1\|Name}}		** '''Result:''' {{#invoke:NpcData\|get_npc_var\|npc_boss_tier2\|BoundAbilities\|ESlot_Signature_2\|Name}}

	* ~~If you misspell~~ a ~~stat, you will see an error~~:		* To get a value from a list of modifiers (nested array):
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|~~trooper_medic~~\|~~MaxHeath~~}}</nowiki></code~~> <!-- Note the typo --~~>		** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|npc_boss_tier2\|IntrinsicModifiers\|1\|BULLET_ARMOR_DAMAGE_RESIST}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_npc_var\|~~trooper_medic~~\|~~MaxHeath~~}}		** '''Result:''' {{#invoke:NpcData\|get_npc_var\|npc_boss_tier2\|IntrinsicModifiers\|1\|BULLET_ARMOR_DAMAGE_RESIST}}

	~~----~~		* If a path is incorrect, an error message will show the full path attempted:
	~~=== Get an Item from~~ a ~~List (`get_list_elem`) ===~~		** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|trooper_normal\|InvalidKey\|Stat}}</nowiki></code>
	~~While `get_npc_var` can also access list items, this function is specifically for that purpose and is used by {{tl\|NpcData}} when the `index` parameter is set.~~		** '''Result:''' <span class="error">Error: Key "InvalidKey" not found in path "trooper_normal".</span>

	~~'''Syntax'''~~
	~~<code><nowiki>{{#invoke:NpcData\|get_list_elem\|NPC Name\|List Name\|Position Number}}</nowiki></code>~~

	~~'''Parameters'''~~
	* '''NPC Name:''' The internal key for the NPC.
	* '''List Name:''' The name of the list property, e.g., `NearbyEnemyResistanceValues`.
	* '''Position Number:''' The position in the list. The first item is ~~`1`~~, the ~~second is `2`, and so on.~~

	~~'''Example'''~~
	* The Tier 2 Boss has a list of resistance values. To get the 4th value in that list:
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|~~get_list_elem~~\|~~npc_boss_tier2~~\|~~NearbyEnemyResistanceValues~~\|4}}</nowiki></code>
	** '''Result:''' ~~{{#invoke~~:~~NpcData\|get_list_elem\|npc_boss_tier2\|NearbyEnemyResistanceValues\|4}}~~

LVL at 16:53, 20 January 2026

2026-01-20T16:53:10Z

← Older revision		Revision as of 16:53, 20 January 2026
Line 55:		Line 55:
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_list_elem\|npc_boss_tier2\|NearbyEnemyResistanceValues\|4}}</nowiki></code>		** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_list_elem\|npc_boss_tier2\|NearbyEnemyResistanceValues\|4}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_list_elem\|npc_boss_tier2\|NearbyEnemyResistanceValues\|4}}		** '''Result:''' {{#invoke:NpcData\|get_list_elem\|npc_boss_tier2\|NearbyEnemyResistanceValues\|4}}

	~~<includeonly>~~
	~~</includeonly>~~

LVL at 15:10, 14 November 2025

2025-11-14T15:10:08Z

← Older revision		Revision as of 15:10, 14 November 2025
Line 9:		Line 9:
	== Available Functions ==		== Available Functions ==

	=== Get a Single Stat (`get_npc_var`) ===		=== Get a Single or Nested Stat (`get_npc_var`) ===
	This is the ~~most common~~ function. It ~~gets~~ a ~~single number~~ or ~~piece of text for an NPC~~.		This is the primary function for retrieving NPC data. It can get a simple top-level stat or traverse into nested objects and arrays using additional parameters.

	'''Syntax'''		'''Syntax'''
	<code><nowiki>{{#invoke:NpcData\|get_npc_var\|NPC Name\|~~Stat Name~~\|Rounding}}</nowiki></code>		<code><nowiki>{{#invoke:NpcData\|get_npc_var\|NPC Name\|Key 1\|Key 2\|...\|Rounding}}</nowiki></code>

	'''Parameters'''		'''Parameters'''
	* '''NPC Name:''' The internal key for the NPC. For example, `npc_boss_tier2` or `trooper_medic`.		* '''NPC Name:''' The internal key for the NPC. For example, `npc_boss_tier2` or `trooper_medic`.
	* '''~~Stat Name~~:''' The ~~name of~~ the stat you want ~~to look up~~. For ~~example~~, `MaxHealth` or `~~StompDamage~~`.		* '''Key 1, Key 2, ...:''' The path to the stat you want.
	* '''Rounding:''' (Optional) A number to round the result to that many significant figures.		** For a simple stat, this is just one key (e.g., `MaxHealth`).
			** For a nested stat, provide each key as a separate parameter (e.g., `Shield`, `BaseAbsorptionPerSecond`).
			* '''Rounding:''' (Optional) A number to round the result to that many significant figures. This should always be the last parameter.

	'''Examples'''		'''Examples'''
	* To get the stomp damage of the Tier 2 Boss:		* To get the max health of a Medic Trooper (a simple stat):
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|npc_boss_tier2\|StompDamage}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_npc_var\|npc_boss_tier2\|StompDamage}}

	* To get the max health of a Medic Trooper:
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|trooper_medic\|MaxHealth}}</nowiki></code>		** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|trooper_medic\|MaxHealth}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_npc_var\|trooper_medic\|MaxHealth}}		** '''Result:''' {{#invoke:NpcData\|get_npc_var\|trooper_medic\|MaxHealth}}

			* To get the base shield absorption of the Mid-Boss (a nested stat):
			** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|npc_super_neutral\|Shield\|BaseAbsorptionPerSecond}}</nowiki></code>
			** '''Result:''' {{#invoke:NpcData\|get_npc_var\|npc_super_neutral\|Shield\|BaseAbsorptionPerSecond}}

			* To get the name of the Tier 2 Boss's first bound ability (nested in an object and an array):
			** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|npc_boss_tier2\|BoundAbilities\|1\|Name}}</nowiki></code>
			** '''Result:''' {{#invoke:NpcData\|get_npc_var\|npc_boss_tier2\|BoundAbilities\|1\|Name}}

	* If you misspell a stat, you will see an error:		* If you misspell a stat, you will see an error:
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|trooper_medic\|MaxHeath}}</nowiki></code> <!-- Note the typo -->		** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_npc_var\|trooper_medic\|MaxHeath}}</nowiki></code> <!-- Note the typo -->
	** '''Result:''' {{#invoke:NpcData\|get_npc_var\|trooper_medic\|MaxHeath}}		** '''Result:''' {{#invoke:NpcData\|get_npc_var\|trooper_medic\|MaxHeath}}

	~~----~~
	~~=== Get a Nested Stat (`get_nested_var`) ===~~
	~~This function retrieves values inside nested objects or arrays using dot notation.~~

	~~'''Syntax'''~~
	~~<code><nowiki>{{#invoke:NpcData\|get_nested_var\|NPC Name\|Path\|Rounding}}</nowiki></code>~~

	~~'''Parameters'''~~
	* '''NPC Name:''' The internal key for the NPC.
	* '''Path:''' Dot-separated keys, e.g., `Shield.BaseAbsorptionPerSecond` or `BoundAbilities.1.Name`.
	* '''Rounding:''' (Optional) A number to round the result to that many significant figures.

	~~'''Examples'''~~
	* To get the base shield absorption of the Super Neutral:
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_nested_var\|npc_super_neutral\|Shield.BaseAbsorptionPerSecond}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_nested_var\|npc_super_neutral\|Shield.BaseAbsorptionPerSecond}}

	* To get the name of the Tier 2 Boss's first bound ability:
	** '''Code:''' <code><nowiki>{{#invoke:NpcData\|get_nested_var\|npc_boss_tier2\|BoundAbilities.1.Name}}</nowiki></code>
	** '''Result:''' {{#invoke:NpcData\|get_nested_var\|npc_boss_tier2\|BoundAbilities.1.Name}}

	----		----
	=== Get an Item from a List (`get_list_elem`) ===		=== Get an Item from a List (`get_list_elem`) ===
	~~Some NPCs have data stored in lists (or arrays). This~~ function ~~lets you get a single item from a list~~ by ~~its position~~.		While `get_npc_var` can also access list items, this function is specifically for that purpose and is used by {{tl\|NpcData}} when the `index` parameter is set.

	'''Syntax'''		'''Syntax'''

LVL: Updated to reflect new module code

2025-11-13T16:08:41Z

Updated to reflect new module code

@@ Line 32: / Line 32: @@
 ** '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|trooper_medic|MaxHeath}}</nowiki></code> <!-- Note the typo -->
 ** '''Result:''' {{#invoke:NpcData|get_npc_var|trooper_medic|MaxHeath}}
 ----
@@ Line 49: / Line 70: @@
 ** '''Code:''' <code><nowiki>{{#invoke:NpcData|get_list_elem|npc_boss_tier2|NearbyEnemyResistanceValues|4}}</nowiki></code>
 ** '''Result:''' {{#invoke:NpcData|get_list_elem|npc_boss_tier2|NearbyEnemyResistanceValues|4}}
 <includeonly>
 </includeonly>

LVL at 16:05, 1 October 2025

2025-10-01T16:05:34Z

← Older revision		Revision as of 16:05, 1 October 2025
Line 1:		Line 1:
	This module allows you to display stats for any NPC (Non-Player Character) from the game's data files which can be found here [[Data:NpcData.json]].		This module allows you to display stats for any NPC (Non-Player Character) from the game's data files which can be found here [[Data:NpcData.json]]. For most uses, it is recommended to use the {{tl\|NpcData}} template.

	== How to Use ==		== How to Use ==

LVL at 15:50, 1 October 2025

2025-10-01T15:50:31Z

← Older revision		Revision as of 15:50, 1 October 2025
Line 1:		Line 1:
	This module allows you to display stats for any NPC (Non-Player Character) from the game's data files. ~~Using this module ensures that all stats are up-to-date and consistent across the wiki~~.		This module allows you to display stats for any NPC (Non-Player Character) from the game's data files which can be found here [[Data:NpcData.json]].

	== How to Use ==		== How to Use ==

LVL at 15:46, 1 October 2025

2025-10-01T15:46:11Z

← Older revision		Revision as of 15:46, 1 October 2025
Line 1:		Line 1:
	~~{{documentation subpage}}~~

	This module allows you to display stats for any NPC (Non-Player Character) from the game's data files. Using this module ensures that all stats are up-to-date and consistent across the wiki.		This module allows you to display stats for any NPC (Non-Player Character) from the game's data files. Using this module ensures that all stats are up-to-date and consistent across the wiki.

LVL: Created page with "{{documentation subpage}} This module allows you to display stats for any NPC (Non-Player Character) from the game's data files. Using this module ensures that all stats are up-to-date and consistent across the wiki. == How to Use == To get data from the module, you use a command that looks like `{{#invoke:NpcData|...}}`. You will tell it which function to use, which NPC you want, and what information you need. The basic format is: 2025-10-01T15:44:27Z Created page with "{{documentation subpage}} This module allows you to display stats for any NPC (Non-Player Character) from the game's data files. Using this module ensures that all stats are up-to-date and consistent across the wiki. == How to Use == To get data from the module, you use a command that looks like <code><nowiki>{{#invoke:NpcData|...}}</nowiki></code>. You will tell it which function to use, which NPC you want, and what information you need. The basic format is: <code><n..." New page {{documentation subpage}} This module allows you to display stats for any NPC (Non-Player Character) from the game's data files. Using this module ensures that all stats are up-to-date and consistent across the wiki. == How to Use == To get data from the module, you use a command that looks like <code><nowiki>{{#invoke:NpcData|...}}</nowiki></code>. You will tell it which function to use, which NPC you want, and what information you need. The basic format is: <code><nowiki>{{#invoke:NpcData|function_name|parameter1|parameter2|...}}</nowiki></code> == Available Functions == === Get a Single Stat (`get_npc_var`) === This is the most common function. It gets a single number or piece of text for an NPC. '''Syntax''' <code><nowiki>{{#invoke:NpcData|get_npc_var|NPC Name|Stat Name|Rounding}}</nowiki></code> '''Parameters''' * '''NPC Name:''' The internal key for the NPC. For example, `npc_boss_tier2` or `trooper_medic`. * '''Stat Name:''' The name of the stat you want to look up. For example, `MaxHealth` or `StompDamage`. * '''Rounding:''' (Optional) A number to round the result to that many significant figures. '''Examples''' * To get the stomp damage of the Tier 2 Boss: '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|npc_boss_tier2|StompDamage}}</nowiki></code> '''Result:''' {{#invoke:NpcData|get_npc_var|npc_boss_tier2|StompDamage}} * To get the max health of a Medic Trooper: '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|trooper_medic|MaxHealth}}</nowiki></code> '''Result:''' {{#invoke:NpcData|get_npc_var|trooper_medic|MaxHealth}} * If you misspell a stat, you will see an error: '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|trooper_medic|MaxHeath}}</nowiki></code>  '''Result:''' {{#invoke:NpcData|get_npc_var|trooper_medic|MaxHeath}} ---- === Get an Item from a List (`get_list_elem`) === Some NPCs have data stored in lists (or arrays). This function lets you get a single item from a list by its position. '''Syntax''' <code><nowiki>{{#invoke:NpcData|get_list_elem|NPC Name|List Name|Position Number}}</nowiki></code> '''Parameters''' * '''NPC Name:''' The internal key for the NPC. * '''List Name:''' The name of the list property, e.g., `NearbyEnemyResistanceValues`. * '''Position Number:''' The position in the list. The first item is `1`, the second is `2`, and so on. '''Example''' * The Tier 2 Boss has a list of resistance values. To get the 4th value in that list: '''Code:''' <code><nowiki>{{#invoke:NpcData|get_list_elem|npc_boss_tier2|NearbyEnemyResistanceValues|4}}</nowiki></code> '''Result:''' {{#invoke:NpcData|get_list_elem|npc_boss_tier2|NearbyEnemyResistanceValues|4}} ---- === Get an Ability Name (`get_ability_key`) === Use this to find the name of an ability in a specific slot for an NPC. '''Syntax''' <code><nowiki>{{#invoke:NpcData|get_ability_key|NPC Name|Slot Name}}</nowiki></code> '''Parameters''' * '''NPC Name:''' The internal key for the NPC. * '''Slot Name:''' The ability slot. Common examples are `ESlot_Weapon_Primary` or `ESlot_Signature_1`. '''Example''' * To get the name of the Tier 2 Boss's third signature ability: '''Code:''' <code><nowiki>{{#invoke:NpcData|get_ability_key|npc_boss_tier2|ESlot_Signature_3}}</nowiki></code> '''Result:''' {{#invoke:NpcData|get_ability_key|npc_boss_tier2|ESlot_Signature_3}} <includeonly> </includeonly>