Template:DataProp/doc: Difference between revisionsGive feedback
Create documentation for Template:DataProp (with help from vergir-bot LLM) |
Document the optional Street Brawl variant parameter (with help from vergir-bot LLM) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
== Usage == | == Usage == | ||
A shorthand template to retrieve raw technical values from datamined game data. Searches across abilities, heroes, and items automatically. | 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]]. | 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> | <templatedata> | ||
{ | { | ||
| Line 31: | Line 14: | ||
"1": { | "1": { | ||
"label": "Entity name", | "label": "Entity name", | ||
"description": "Name of the ability, hero, or item.", | "description": "Name of the ability, hero, or item. Pass the literal value Convar to look up a console variable instead.", | ||
"type": "string", | "type": "string", | ||
"required": true, | "required": true, | ||
"example": "Singularity, Drifter, Grit" | "example": "Singularity, Drifter, Grit, Convar" | ||
}, | }, | ||
"2": { | "2": { | ||
"label": "Property", | "label": "Property", | ||
"description": "Property key to retrieve. Supports dot notation for nested values.", | "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", | "type": "string", | ||
"required": true, | "required": true, | ||
"example": "DPS, BaseHealthRegen, | "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", | "format": "inline", | ||
"paramOrder": ["1", "2"], | "paramOrder": ["1", "2", "3"], | ||
"description": "Retrieves a raw data value from abilities, heroes, or | "description": "Retrieves a raw data value from abilities, heroes, items, or console variables." | ||
} | } | ||
</templatedata><includeonly>[[Category:Data templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude> | </templatedata> | ||
== Examples == | |||
=== Hero === | |||
<code>Drifter regenerates {{DataProp|Drifter|BaseHealthRegen}} HP each second.</code> | |||
Drifter regenerates {{DataProp|Drifter|BaseHealthRegen}} HP each second. | |||
=== Weapon === | |||
<code>Mo & Krill fires {{DataProp|Mo & Krill|Weapon.BulletsPerShot}} bullets per shot.</code> | |||
Mo & Krill fires {{DataProp|Mo & Krill|Weapon.BulletsPerShot}} bullets per shot. | |||
=== Ability === | |||
<code>Singularity deals {{DataProp|Singularity|DPS}} damage per second.</code> | |||
Singularity deals {{DataProp|Singularity|DPS}} damage per second. | |||
=== Item === | |||
<code>Grit's barrier lasts {{DataProp|Grit|BarrierDuration}}s.</code> | |||
Grit's barrier lasts {{DataProp|Grit|BarrierDuration}}s. | |||
=== Convar === | |||
<code>The default camera field of view is {{DataProp|Convar|citadel_camera_fov}}.</code> | |||
The default camera field of view is {{DataProp|Convar|citadel_camera_fov}}. | |||
=== 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.</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>{{DataProp|Essence Bomb|Damage|Street Brawl}}</code> | |||
{{DataProp|Essence Bomb|Damage|Street Brawl}} | |||
=== Errors === | |||
If the entity does not exist: | |||
<code>{{DataProp|Nonexistent Thing|Whatever}}</code> | |||
{{DataProp|Nonexistent Thing|Whatever}} | |||
If the entity exists but the property does not: | |||
<code>{{DataProp|Abrams|FakeProp}}</code> | |||
{{DataProp|Abrams|FakeProp}} | |||
If the convar does not exist: | |||
<code>{{DataProp|Convar|fake_convar}}</code> | |||
{{DataProp|Convar|fake_convar}} | |||
If the variant is not recognised: | |||
<code>{{DataProp|Essence Bomb|Radius|Deathmatch}}</code> | |||
{{DataProp|Essence Bomb|Radius|Deathmatch}} | |||
<includeonly>[[Category:Data templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude> | |||
Latest revision as of 14:39, 28 July 2026
Usage
[edit source]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.
An optional third parameter selects a game mode variant. Passing Street Brawl 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
[edit source]Retrieves a raw data value from abilities, heroes, items, or console variables.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Entity name | 1 | Name of the ability, hero, or item. Pass the literal value Convar to look up a console variable instead.
| String | required |
| Property | 2 | Property key to retrieve. Supports dot notation for nested values. When the first parameter is Convar, this is the console variable name instead.
| String | required |
| Variant | 3 | 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.
| String | optional |
Examples
[edit source]Hero
[edit source]Drifter regenerates {{DataProp|Drifter|BaseHealthRegen}} HP each second.
Drifter regenerates 3.5 HP each second.
Weapon
[edit source]Mo & Krill fires {{DataProp|Mo & Krill|Weapon.BulletsPerShot}} bullets per shot.
Mo & Krill fires 4 bullets per shot.
Ability
[edit source]Singularity deals {{DataProp|Singularity|DPS}} damage per second.
Singularity deals 75 damage per second.
Item
[edit source]Grit's barrier lasts {{DataProp|Grit|BarrierDuration}}s.
Grit's barrier lasts 4s.
Convar
[edit source]The default camera field of view is {{DataProp|Convar|citadel_camera_fov}}.
The default camera field of view is 75.
Street Brawl
[edit source]Essence Bomb has a radius of {{DataProp|Essence Bomb|Radius}}m, or {{DataProp|Essence Bomb|Radius|Street Brawl}}m in Street Brawl.
Essence Bomb has a radius of 7m, or 6m in Street Brawl.
Street Brawl does not change Essence Bomb's damage, so the base value is returned:
{{DataProp|Essence Bomb|Damage|Street Brawl}}
90
Errors
[edit source]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
If the variant is not recognised:
{{DataProp|Essence Bomb|Radius|Deathmatch}}
Unknown variant: Deathmatch