Editing Module:NpcData/docGive feedback

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 ==
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> <!-- Note the typo -->
** '''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`) ===
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}}

<includeonly>
</includeonly>
@@ Line 9: / Line 9: @@
 == Available Functions ==
-=== Get a Single or Nested Stat (`get_npc_var`) ===
+=== Get a Single Stat (`get_npc_var`) ===
-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).
+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|Key 1|Key 2|...|Rounding}}</nowiki></code>
+<code><nowiki>{{#invoke:NpcData|get_npc_var|NPC Name|Stat Name|Rounding}}</nowiki></code>
 '''Parameters'''
-* '''NPC Name:''' The internal key for the NPC (e.g., `npc_boss_tier2`, `trooper_normal`).
+* '''NPC Name:''' The internal key for the NPC. For example, `npc_boss_tier2` or `trooper_medic`.
-* '''Key 1, Key 2, ...:''' The path to the stat you want.
+* '''Stat Name:''' The name of the stat you want to look up. For example, `MaxHealth` or `StompDamage`.
-** For a simple stat, this is one key (e.g., `MaxHealth`).
+* '''Rounding:''' (Optional) A number to round the result to that many significant figures.
-** 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.
 '''Examples'''
-* To get the max health of a Normal Trooper:
+* To get the stomp damage of the Tier 2 Boss:
-** '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|trooper_normal|MaxHealth}}</nowiki></code>
+** '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|npc_boss_tier2|StompDamage}}</nowiki></code>
-** '''Result:''' {{#invoke:NpcData|get_npc_var|trooper_normal|MaxHealth}}
+** '''Result:''' {{#invoke:NpcData|get_npc_var|npc_boss_tier2|StompDamage}}
-* To get the name of a Walker's second ability (nested in BoundAbilities):
+* To get the max health of a Medic Trooper:
-** '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|npc_boss_tier2|BoundAbilities|ESlot_Signature_2|Name}}</nowiki></code>
+** '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|trooper_medic|MaxHealth}}</nowiki></code>
-** '''Result:''' {{#invoke:NpcData|get_npc_var|npc_boss_tier2|BoundAbilities|ESlot_Signature_2|Name}}
+** '''Result:''' {{#invoke:NpcData|get_npc_var|trooper_medic|MaxHealth}}
-* To get a value from a list of modifiers (nested array):
+* If you misspell a stat, you will see an error:
-** '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|npc_boss_tier2|IntrinsicModifiers|1|BULLET_ARMOR_DAMAGE_RESIST}}</nowiki></code>
+** '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|trooper_medic|MaxHeath}}</nowiki></code> <!-- Note the typo -->
-** '''Result:''' {{#invoke:NpcData|get_npc_var|npc_boss_tier2|IntrinsicModifiers|1|BULLET_ARMOR_DAMAGE_RESIST}}
+** '''Result:''' {{#invoke:NpcData|get_npc_var|trooper_medic|MaxHeath}}
-* If a path is incorrect, an error message will show the full path attempted:
+----
-** '''Code:''' <code><nowiki>{{#invoke:NpcData|get_npc_var|trooper_normal|InvalidKey|Stat}}</nowiki></code>
+=== Get a Nested Stat (`get_nested_var`) ===
-** '''Result:''' <span class="error">Error: Key "InvalidKey" not found in path "trooper_normal".</span>
+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`) ===
+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}}
+<includeonly>
+</includeonly>