Template:DataProp/doc: Difference between revisionsGive feedback
m minor doc fixes |
Document the optional Street Brawl variant parameter (with help from vergir-bot LLM) |
||
| (5 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 == | == Parameters == | ||
| Line 12: | 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> | </templatedata> | ||
| Line 34: | Line 43: | ||
=== Hero === | === Hero === | ||
<code>Drifter regenerates {{DataProp|Drifter|BaseHealthRegen}}HP each second.</code> | <code>Drifter regenerates {{DataProp|Drifter|BaseHealthRegen}} HP each second.</code> | ||
Drifter regenerates {{DataProp|Drifter|BaseHealthRegen}}HP each second. | Drifter regenerates {{DataProp|Drifter|BaseHealthRegen}} HP each second. | ||
=== Weapon === | === Weapon === | ||
<code>Mo & Krill fires {{DataProp|Mo & Krill|BulletsPerShot}} bullets per shot.</code> | <code>Mo & Krill fires {{DataProp|Mo & Krill|Weapon.BulletsPerShot}} bullets per shot.</code> | ||
Mo & Krill fires {{DataProp|Mo & Krill|BulletsPerShot}} bullets per shot. | Mo & Krill fires {{DataProp|Mo & Krill|Weapon.BulletsPerShot}} bullets per shot. | ||
=== Ability === | === Ability === | ||
| Line 53: | Line 62: | ||
Grit's barrier lasts {{DataProp|Grit|BarrierDuration}}s. | Grit's barrier lasts {{DataProp|Grit|BarrierDuration}}s. | ||
=== | === Convar === | ||
If the entity | <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| | <code>{{DataProp|Essence Bomb|Radius|Deathmatch}}</code> | ||
{{DataProp|Essence Bomb|Radius|Deathmatch}} | |||
<includeonly>[[Category:Data templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude> | <includeonly>[[Category:Data templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude> | ||