Template:DataProp/doc: Difference between revisions

Vergir (talk | contribs)
Create documentation for Template:DataProp (with help from vergir-bot LLM)
 
Vergir (talk | contribs)
Restructure documentation: params above examples, contextual examples, add not-found case (with help from vergir-bot LLM)
Line 3: Line 3:


Powered by [[Module:GameData|Module:GameData]].
Powered by [[Module:GameData|Module:GameData]].
== Examples ==
<pre style="width:50%">
{{DataProp|Drifter|BaseHealthRegen}}
{{DataProp|Mo & Krill|BulletsPerShot}}
{{DataProp|Singularity|DPS}}
{{DataProp|Grit|BarrierDuration}}
</pre>
;Hero property (base health regen for Drifter)
: {{DataProp|Drifter|BaseHealthRegen}}
;Weapon property (bullets per shot for Mo & Krill)
: {{DataProp|Mo & Krill|BulletsPerShot}}
;Ability property (DPS for Singularity)
: {{DataProp|Singularity|DPS}}
;Item property (barrier duration for Grit)
: {{DataProp|Grit|BarrierDuration}}


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


== Parameters ==
<templatedata>
<templatedata>
{
{
Line 48: Line 29:
"description": "Retrieves a raw data value from abilities, heroes, or items."
"description": "Retrieves a raw data value from abilities, heroes, or items."
}
}
</templatedata><includeonly>[[Category:Data templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
</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|BulletsPerShot&#125;&#125; bullets per shot.</code>
 
Mo & Krill fires {{DataProp|Mo & Krill|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.
 
=== Not found ===
If the entity or property does not exist, the template returns an empty string.
 
<code>&#123;&#123;DataProp|Nonexistent Item|FakeProperty&#125;&#125;</code>
 
Result: "{{DataProp|Nonexistent Item|FakeProperty}}"
 
<includeonly>[[Category:Data templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>