Editing Module:NpcData/docGive feedback

{{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> <!-- Note the typo -->
** '''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>