Template:NpcData/doc - Revision history

LVL: Updated doc to reflect current code and made it easier to understand

2026-02-07T15:51:40Z

Updated doc to reflect current code and made it easier to understand

LVL at 15:12, 14 November 2025

2025-11-14T15:12:10Z

← Older revision		Revision as of 15:12, 14 November 2025
Line 1:		Line 1:
	This template is a shortcut for [[Module:NpcData]] to make it easier to display NPC stats on a page.		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 ~~like <code>Shield.BaseAbsorptionPerSecond</code>~~) or an item from a list of stats ~~(like the 4th value in a list of resistances)~~.		It can be used to get a single stat (including nested ones) or an item from a list of stats.

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

	=== Getting a Single Stat ===		=== Getting a Single or Nested Stat ===
	This is the most common use. Provide the information in the following order.		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'''		'''Syntax'''
	<code><nowiki>{{NpcData\|NPC Name\|~~Stat Name~~\|Rounding}}</nowiki></code>		<code><nowiki>{{NpcData\|NPC Name\|Key 1\|Key 2\|...\|Rounding}}</nowiki></code>

	'''Parameters'''		'''Parameters'''
	* '''First parameter (NPC Name):''' The internal key for the NPC (e.g., <code>npc_boss_tier2</code>).		* '''First parameter (NPC Name):''' The internal key for the NPC (e.g., <code>npc_boss_tier2</code>).
	* '''Second ~~parameter~~ (~~Stat Name~~):''' The ~~name of~~ the stat you want ~~to look up (e.g~~., ~~<code>MaxHealth</code>)~~. ~~Supports dot notation for~~ nested ~~stats (e.g.~~, ~~<code>Shield.BaseAbsorptionPerSecond</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.
	* '''~~Third~~ parameter (Rounding):''' (Optional) A number to round the result to that many significant figures.		* '''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'''		'''Examples'''
Line 25:		Line 25:
	** '''Result:''' {{NpcData\|trooper_medic\|MaxHeath}}		** '''Result:''' {{NpcData\|trooper_medic\|MaxHeath}}

	* To get a nested shield stat:		* To get a nested shield stat (using multiple parameters):
	** '''Code:''' <code><nowiki>{{NpcData\|npc_super_neutral\|Shield.BaseAbsorptionPerSecond}}</nowiki></code>		** '''Code:''' <code><nowiki>{{NpcData\|npc_super_neutral\|Shield\|BaseAbsorptionPerSecond}}</nowiki></code>
	** '''Result:''' {{NpcData\|npc_super_neutral\|Shield.BaseAbsorptionPerSecond}}		** '''Result:''' {{NpcData\|npc_super_neutral\|Shield\|BaseAbsorptionPerSecond}}

			* To get a deeply nested ability name:
			** '''Code:''' <code><nowiki>{{NpcData\|npc_boss_tier2\|BoundAbilities\|1\|Name}}</nowiki></code>
			** '''Result:''' {{NpcData\|npc_boss_tier2\|BoundAbilities\|1\|Name}}

	----		----
Line 48:		Line 52:
	<templatedata>		<templatedata>
	{		{
	"description": "A shortcut for Module:NpcData to display stats for NPCs, ~~either a single value~~ or an item from a list.",		"description": "A shortcut for Module:NpcData to display stats for NPCs. Can retrieve simple stats, nested stats, or an item from a list.",
	"params": {		"params": {
	"1": {		"1": {
Line 59:		Line 63:
	},		},
	"2": {		"2": {
	"label": "~~Stat or~~ List Name",		"label": "Key 1 / List Name",
	"description": "The name of the stat (e.g., MaxHealth) or the ~~list (e.g., NearbyEnemyResistanceValues). Supports dot notation for~~ nested ~~stats~~ (e.g., Shield~~.BaseAbsorptionPerSecond~~).",		"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.",
	"type": "string",		"type": "string",
	"required": true,		"required": true,
Line 67:		Line 71:
	},		},
	"3": {		"3": {
			"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.",
			"type": "string",
			"required": false
			},
			"4": {
			"label": "Key 3 / Rounding",
			"description": "The third key in a nested path OR an optional rounding number.",
			"type": "string",
			"required": false
			},
			"5": {
	"label": "Rounding",		"label": "Rounding",
	"description": "~~(Optional) A~~ number to round ~~a stat~~ to that many significant figures~~. Does not apply when getting an item from a list~~.",		"description": "An optional number to round the result to that many significant figures.",
	"type": "number",		"type": "number",
	"required": false,		"required": false
	~~"aliases": [ "round" ]~~
	},		},
	"index": {		"index": {

LVL: Updated to reflect new template code

2025-11-13T16:17:12Z

Updated to reflect new template code

← Older revision		Revision as of 16:17, 13 November 2025
Line 1:		Line 1:
	This template is a shortcut for [[Module:NpcData]] to make it easier to display NPC stats on a page.		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 (like ~~`MaxHealth`~~) or an item from a list of stats (like the 4th value in a list of resistances).		It can be used to get a single stat (including nested ones like <code>Shield.BaseAbsorptionPerSecond</code>) or an item from a list of stats (like the 4th value in a list of resistances).

	== How to Use ==		== How to Use ==
Line 12:		Line 12:

	'''Parameters'''		'''Parameters'''
	* '''First parameter (NPC Name):''' The internal key for the NPC (e.g., `npc_boss_tier2`).		* '''First parameter (NPC Name):''' The internal key for the NPC (e.g., <code>npc_boss_tier2</code>).
	* '''Second parameter (Stat Name):''' The name of the stat you want to look up (e.g., `MaxHealth`).		* '''Second parameter (Stat Name):''' The name of the stat you want to look up (e.g., <code>MaxHealth</code>). Supports dot notation for nested stats (e.g., <code>Shield.BaseAbsorptionPerSecond</code>).
	* '''Third parameter (Rounding):''' (Optional) A number to round the result to that many significant figures.		* '''Third parameter (Rounding):''' (Optional) A number to round the result to that many significant figures.

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

			* To get a nested shield stat:
			** '''Code:''' <code><nowiki>{{NpcData\|npc_super_neutral\|Shield.BaseAbsorptionPerSecond}}</nowiki></code>
			** '''Result:''' {{NpcData\|npc_super_neutral\|Shield.BaseAbsorptionPerSecond}}

	----		----
	=== Getting an Item from a List ===		=== Getting an Item from a List ===
	To get a single value from a list, you must use the named `index=` parameter.		To get a single value from a list, you must use the named <code>index=</code> parameter.

	'''Syntax'''		'''Syntax'''
Line 34:		Line 38:
	'''Parameters'''		'''Parameters'''
	* '''First parameter (NPC Name):''' The internal key for the NPC.		* '''First parameter (NPC Name):''' The internal key for the NPC.
	* '''Second parameter (List Name):''' The name of the list property (e.g., `NearbyEnemyResistanceValues`).		* '''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 `1`, the second is `2`, and so on.		* '''index=''' The position in the list. The first item is <code>1</code>, the second is <code>2</code>, and so on.

	'''Example'''		'''Example'''
Line 56:		Line 60:
	"2": {		"2": {
	"label": "Stat or List Name",		"label": "Stat or List Name",
	"description": "The name of the stat (e.g., MaxHealth) or the list (e.g., NearbyEnemyResistanceValues).",		"description": "The name of the stat (e.g., MaxHealth) or the list (e.g., NearbyEnemyResistanceValues). Supports dot notation for nested stats (e.g., Shield.BaseAbsorptionPerSecond).",
	"type": "string",		"type": "string",
	"required": true,		"required": true,

LVL: Added templatedata

2025-10-01T16:13:19Z

Added templatedata

← Older revision		Revision as of 16:13, 1 October 2025
Line 41:		Line 41:
	** '''Code:''' <code><nowiki>{{NpcData\|npc_boss_tier2\|NearbyEnemyResistanceValues\|index=4}}</nowiki></code>		** '''Code:''' <code><nowiki>{{NpcData\|npc_boss_tier2\|NearbyEnemyResistanceValues\|index=4}}</nowiki></code>
	** '''Result:''' {{NpcData\|npc_boss_tier2\|NearbyEnemyResistanceValues\|index=4}}		** '''Result:''' {{NpcData\|npc_boss_tier2\|NearbyEnemyResistanceValues\|index=4}}

			<templatedata>
			{
			"description": "A shortcut for Module:NpcData to display stats for NPCs, either a single value or an item from a list.",
			"params": {
			"1": {
			"label": "NPC Name",
			"description": "The internal key for the NPC (e.g., npc_boss_tier2).",
			"type": "string",
			"required": true,
			"example": "trooper_medic",
			"aliases": [ "npc" ]
			},
			"2": {
			"label": "Stat or List Name",
			"description": "The name of the stat (e.g., MaxHealth) or the list (e.g., NearbyEnemyResistanceValues).",
			"type": "string",
			"required": true,
			"example": "MaxHealth",
			"aliases": [ "stat" ]
			},
			"3": {
			"label": "Rounding",
			"description": "(Optional) A number to round a stat to that many significant figures. Does not apply when getting an item from a list.",
			"type": "number",
			"required": false,
			"aliases": [ "round" ]
			},
			"index": {
			"label": "Index",
			"description": "The position of the item to get from a list (e.g., 4 for the 4th item). Using this parameter changes the template's behavior to get an item from a list.",
			"type": "number",
			"required": false,
			"example": "4"
			}
			},
			"format": "inline"
			}
			</templatedata>

			<includeonly>
			[[Category:Templates]]
			</includeonly><noinclude>
			[[Category:Template documentation]]
			</noinclude>

LVL: Created page with "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 (like `MaxHealth`) or an item from a list of stats (like the 4th value in a list of resistances). == How to Use == === Getting a Single Stat === This is the most common use. Provide the information in the following order. '''Syntax''' `{{NpcData|NPC Name|Stat Name|Rounding}}` '''Parameters''' * '''First..."

2025-10-01T16:02:04Z

Created page with "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 (like `MaxHealth`) or an item from a list of stats (like the 4th value in a list of resistances). == How to Use == === Getting a Single Stat === This is the most common use. Provide the information in the following order. '''Syntax''' <code><nowiki>{{NpcData|NPC Name|Stat Name|Rounding}}</nowiki></code> '''Parameters''' * '''First..."

New page

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 (like `MaxHealth`) or an item from a list of stats (like the 4th value in a list of resistances).

== How to Use ==

=== Getting a Single Stat ===
This is the most common use. Provide the information in the following order.

'''Syntax'''
<code><nowiki>{{NpcData|NPC Name|Stat Name|Rounding}}</nowiki></code>

'''Parameters'''
* '''First parameter (NPC Name):''' The internal key for the NPC (e.g., `npc_boss_tier2`).
* '''Second parameter (Stat Name):''' The name of the stat you want to look up (e.g., `MaxHealth`).
* '''Third parameter (Rounding):''' (Optional) A number 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>
** '''Result:''' {{NpcData|trooper_medic|MaxHealth}}

* If you misspell a stat, you will see an error:
** '''Code:''' <code><nowiki>{{NpcData|trooper_medic|MaxHeath}}</nowiki></code> 
** '''Result:''' {{NpcData|trooper_medic|MaxHeath}}

----
=== Getting an Item from a List ===
To get a single value from a list, you must use the named `index=` parameter.

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

'''Parameters'''
* '''First parameter (NPC Name):''' The internal key for the NPC.
* '''Second parameter (List Name):''' The name of the list property (e.g., `NearbyEnemyResistanceValues`).
* '''index=''' 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>{{NpcData|npc_boss_tier2|NearbyEnemyResistanceValues|index=4}}</nowiki></code>
** '''Result:''' {{NpcData|npc_boss_tier2|NearbyEnemyResistanceValues|index=4}}