Template:NpcData/doc: Difference between revisionsGive feedback

This template is a shortcut for [[Module:NpcData]] to make it easier to display NPC stats on a page.

It can be used to get a single stat (including nested ones) or an item from a list of stats.

=== Getting a Single or Nested Stat ===

This is the most common use. Provide the information in the following order. For nested stats, simply add more parameters for each level of nesting.

'''Syntax'''

<code><nowiki>{{NpcData|NPC Name|Key 1|Key 2|...|Rounding}}</nowiki></code>

* '''First parameter (NPC Name):''' The internal key for the NPC (e.g., <code>npc_boss_tier2</code>).

* '''Second, Third, etc. parameters (Keys):''' The path to the stat you want. For a simple stat, this is just one key. For a nested stat, provide each key as a separate parameter.

* '''Final parameter (Rounding):''' (Optional) If the final parameter is a number, it will be used to round the result to that many significant figures.

'''Examples'''

* To get the max health of a Medic Trooper:

** '''Code:''' <code><nowiki>{{NpcData|trooper_medic|MaxHealth}}</nowiki></code>

* If you misspell a stat, you will see an error:

** '''Code:''' <code><nowiki>{{NpcData|trooper_medic|MaxHeath}}</nowiki></code> <!-- Note the typo -->

** '''Result:''' {{NpcData|trooper_medic|MaxHeath}}

* To get a nested shield stat (using multiple parameters):

** '''Code:''' <code><nowiki>{{NpcData|npc_super_neutral|Shield|BaseAbsorptionPerSecond}}</nowiki></code>

** '''Result:''' {{NpcData|npc_super_neutral|Shield|BaseAbsorptionPerSecond}}

To get a single value from a list, you must use the named <code>index=</code> parameter.

<code><nowiki>{{NpcData|NPC Name|List Name|index=Position Number}}</nowiki></code>

* '''First parameter (NPC Name):''' The internal key for the NPC.

* '''Second parameter (List Name):''' The name of the list property (e.g., <code>NearbyEnemyResistanceValues</code>).

* '''index=''' The position in the list. The first item is <code>1</code>, the second is <code>2</code>, 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>{{NpcData|npc_boss_tier2|NearbyEnemyResistanceValues|index=4}}</nowiki></code>

** '''Result:''' {{NpcData|npc_boss_tier2|NearbyEnemyResistanceValues|index=4}}

"description": "A shortcut for Module:NpcData to display stats for NPCs. Can retrieve simple stats, nested stats, or an item from a list.",

"description": "The internal key for the NPC (e.g., npc_boss_tier2).",

"example": "trooper_medic",

"label": "Key 1 / List Name",

"description": "The name of the stat (e.g., MaxHealth), the first key in a nested path (e.g., Shield), or the name of a list.",

"example": "MaxHealth",

"label": "Key 2 / Rounding",

"description": "The second key in a nested path (e.g., BaseAbsorptionPerSecond) OR an optional number to round the result to that many significant figures.",

"label": "Key 3 / Rounding",

"description": "The third key in a nested path OR an optional rounding number.",

"description": "An optional number to round the result to that many significant figures.",