Editing Template:DataProp/docGive feedback

== 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 commands|console variables]] (convars) on request.

Powered by [[Module:GameData|Module:GameData]].

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

An optional third parameter selects a game mode variant. Passing <code>Street Brawl</code> returns the value as changed for [[Street Brawl]]; properties that Street Brawl leaves alone fall back to the base value, so the parameter is safe to use on any property. Only abilities are affected.

== Parameters ==
<templatedata>
{
	"params": {
		"1": {
			"label": "Entity name",
			"description": "Name of the ability, hero, or item. Pass the literal value Convar to look up a console variable instead.",
			"type": "string",
			"required": true,
			"example": "Singularity, Drifter, Grit, Convar"
		},
		"2": {
			"label": "Property",
			"description": "Property key to retrieve. Supports dot notation for nested values. When the first parameter is Convar, this is the console variable name instead.",
			"type": "string",
			"required": true,
			"example": "DPS, BaseHealthRegen, citadel_camera_fov"
		},
		"3": {
			"label": "Variant",
			"description": "Optional game mode variant. Accepts Street Brawl, ignoring case and spacing, and returns the value changed for Street Brawl. Properties that Street Brawl does not change fall back to the base value. Applies to abilities only.",
			"type": "string",
			"required": false,
			"example": "Street Brawl"
		}
	},
	"format": "inline",
	"paramOrder": ["1", "2", "3"],
	"description": "Retrieves a raw data value from abilities, heroes, items, or console variables."
}
</templatedata>

== Examples ==

=== Hero ===
<code>Drifter regenerates &#123;&#123;DataProp|Drifter|BaseHealthRegen&#125;&#125; HP each second.</code>

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

=== Weapon ===
<code>Mo &amp; Krill fires &#123;&#123;DataProp|Mo & Krill|Weapon.BulletsPerShot&#125;&#125; bullets per shot.</code>

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

=== Ability ===
<code>Singularity deals &#123;&#123;DataProp|Singularity|DPS&#125;&#125; damage per second.</code>

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

=== Item ===
<code>Grit's barrier lasts &#123;&#123;DataProp|Grit|BarrierDuration&#125;&#125;s.</code>

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

=== Convar ===
<code>The default camera field of view is &#123;&#123;DataProp|Convar|citadel_camera_fov&#125;&#125;.</code>

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

=== Street Brawl ===
<code>Essence Bomb has a radius of &#123;&#123;DataProp|Essence Bomb|Radius&#125;&#125;m, or &#123;&#123;DataProp|Essence Bomb|Radius|Street Brawl&#125;&#125;m in Street Brawl.</code>

Essence Bomb has a radius of {{DataProp|Essence Bomb|Radius}}m, or {{DataProp|Essence Bomb|Radius|Street Brawl}}m in Street Brawl.

Street Brawl does not change Essence Bomb's damage, so the base value is returned:

<code>&#123;&#123;DataProp|Essence Bomb|Damage|Street Brawl&#125;&#125;</code>

{{DataProp|Essence Bomb|Damage|Street Brawl}}

=== Errors ===
If the entity does not exist:

<code>&#123;&#123;DataProp|Nonexistent Thing|Whatever&#125;&#125;</code>

{{DataProp|Nonexistent Thing|Whatever}}

If the entity exists but the property does not:

<code>&#123;&#123;DataProp|Abrams|FakeProp&#125;&#125;</code>

{{DataProp|Abrams|FakeProp}}

If the convar does not exist:

<code>&#123;&#123;DataProp|Convar|fake_convar&#125;&#125;</code>

{{DataProp|Convar|fake_convar}}

If the variant is not recognised:

<code>&#123;&#123;DataProp|Essence Bomb|Radius|Deathmatch&#125;&#125;</code>

{{DataProp|Essence Bomb|Radius|Deathmatch}}

<includeonly>[[Category:Data templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>