Template:NpcData/doc: Difference between revisionsGive feedback
Updated to reflect new template code |
No edit summary |
||
| 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 | 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| | <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 | * '''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''' | '''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 | ** '''Code:''' <code><nowiki>{{NpcData|npc_super_neutral|Shield|BaseAbsorptionPerSecond}}</nowiki></code> | ||
** '''Result:''' {{NpcData|npc_super_neutral|Shield | ** '''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, | "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": " | "label": "Key 1 / List Name", | ||
"description": "The name of the stat (e.g., MaxHealth) | "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": " | "description": "An optional number to round the result to that many significant figures.", | ||
"type": "number", | "type": "number", | ||
"required": false | "required": false | ||
}, | }, | ||
"index": { | "index": { | ||
Revision as of 15:12, 14 November 2025
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.
How to Use
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
{{NpcData|NPC Name|Key 1|Key 2|...|Rounding}}
Parameters
- First parameter (NPC Name): The internal key for the NPC (e.g.,
npc_boss_tier2). - 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:
{{NpcData|trooper_medic|MaxHealth}} - Result: 350
- Code:
- If you misspell a stat, you will see an error:
- Code:
{{NpcData|trooper_medic|MaxHeath}} - Result: Error: Key "MaxHeath" not found in path "trooper_medic".
- Code:
- To get a nested shield stat (using multiple parameters):
- Code:
{{NpcData|npc_super_neutral|Shield|BaseAbsorptionPerSecond}} - Result: Error: Key "Shield" not found in path "npc_super_neutral".
- Code:
- To get a deeply nested ability name:
- Code:
{{NpcData|npc_boss_tier2|BoundAbilities|1|Name}} - Result: Error: Key "1" not found in path "npc_boss_tier2.BoundAbilities".
- Code:
Getting an Item from a List
To get a single value from a list, you must use the named index= parameter.
Syntax
{{NpcData|NPC Name|List Name|index=Position Number}}
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 is2, and so on.
Example
- The Tier 2 Boss has a list of resistance values. To get the 4th value in that list:
- Code:
{{NpcData|npc_boss_tier2|NearbyEnemyResistanceValues|index=4}} - Result: Error: Key "NearbyEnemyResistanceValues" not found in path "npc_boss_tier2".
- Code:
A shortcut for Module:NpcData to display stats for NPCs. Can retrieve simple stats, nested stats, or an item from a list.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| NPC Name | 1 npc | The internal key for the NPC (e.g., npc_boss_tier2).
| String | required |
| Key 1 / List Name | 2 stat | The name of the stat (e.g., MaxHealth), the first key in a nested path (e.g., Shield), or the name of a list.
| String | required |
| Key 2 / Rounding | 3 | The second key in a nested path (e.g., BaseAbsorptionPerSecond) OR an optional number to round the result to that many significant figures. | String | optional |
| Key 3 / Rounding | 4 | The third key in a nested path OR an optional rounding number. | String | optional |
| Rounding | 5 | An optional number to round the result to that many significant figures. | Number | optional |
| Index | index | 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.
| Number | optional |