Template:DataProp/doc

Revision as of 15:33, 22 June 2026 by Vergir (talk | contribs) (Document Convar lookup mode: usage note, TemplateData, and Convar example (with help from vergir-bot LLM))

Usage

A shorthand template to retrieve raw technical values from datamined game data. Searches across abilities, heroes, and items automatically, and can also look up console variables (convars) on request.

Powered by Module:GameData.

Dot notation is supported for nested properties (e.g. Scale.Value). Tables with a Value field are automatically unwrapped.

To retrieve a console variable value, pass Convar as the first parameter and the convar name as the second (e.g. {{DataProp|Convar|citadel_camera_fov}}). When a convar is stored together with a description, only its value is returned.

Parameters

Retrieves a raw data value from abilities, heroes, items, or console variables.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Entity name1

Name of the ability, hero, or item. Pass the literal value Convar to look up a console variable instead.

Example
Singularity, Drifter, Grit, Convar
Stringrequired
Property2

Property key to retrieve. Supports dot notation for nested values. When the first parameter is Convar, this is the console variable name instead.

Example
DPS, BaseHealthRegen, citadel_camera_fov
Stringrequired

Examples

Hero

Drifter regenerates {{DataProp|Drifter|BaseHealthRegen}} HP each second.

Drifter regenerates 3.5 HP each second.

Weapon

Mo & Krill fires {{DataProp|Mo & Krill|BulletsPerShot}} bullets per shot.

Mo & Krill fires Prop not found: Mo & Krill/BulletsPerShot bullets per shot.

Ability

Singularity deals {{DataProp|Singularity|DPS}} damage per second.

Singularity deals 75 damage per second.

Item

Grit's barrier lasts {{DataProp|Grit|BarrierDuration}}s.

Grit's barrier lasts 4s.

Convar

The default camera field of view is {{DataProp|Convar|citadel_camera_fov}}.

The default camera field of view is 75.

Errors

If the entity does not exist:

{{DataProp|Nonexistent Thing|Whatever}}

Entity not found: Nonexistent Thing

If the entity exists but the property does not:

{{DataProp|Abrams|FakeProp}}

Prop not found: Abrams/FakeProp

If the convar does not exist:

{{DataProp|Convar|fake_convar}}

Convar not found: fake_convar