Template:NpcData/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
LVL (talk | contribs)
Added templatedata
LVL (talk | contribs)
Updated to reflect new template code
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,

Revision as of 16:17, 13 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 like Shield.BaseAbsorptionPerSecond) 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 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). Supports dot notation for nested stats (e.g., Shield.BaseAbsorptionPerSecond).
  • 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: {{NpcData|trooper_medic|MaxHealth}}
    • Result: 350
  • 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".
  • To get a nested shield stat:
    • Code: {{NpcData|npc_super_neutral|Shield.BaseAbsorptionPerSecond}}
    • Result: Error: Key "Shield.BaseAbsorptionPerSecond" not found in path "npc_super_neutral".

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 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: {{NpcData|npc_boss_tier2|NearbyEnemyResistanceValues|index=4}}
    • Result: Error: Key "NearbyEnemyResistanceValues" not found in path "npc_boss_tier2".

A shortcut for Module:NpcData to display stats for NPCs, either a single value or an item from a list.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
NPC Name1 npc

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

Example
trooper_medic
Stringrequired
Stat or List Name2 stat

The name of the stat (e.g., MaxHealth) or the list (e.g., NearbyEnemyResistanceValues). Supports dot notation for nested stats (e.g., Shield.BaseAbsorptionPerSecond).

Example
MaxHealth
Stringrequired
Rounding3 round

(Optional) A number to round a stat to that many significant figures. Does not apply when getting an item from a list.

Numberoptional
Indexindex

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.

Example
4
Numberoptional