Editing Template:DataProp/doc

Jump to navigation Jump to search
Warning: You are not logged in. Once you make an edit, a temporary account will be created for you. Learn more. Log in or create an account to continue receiving notifications after this account expires, and to access other features.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision Your text
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, and can also look up [[Console commands|console variables]] (convars) on request.
A shorthand template to retrieve raw technical values from datamined game data. Searches across abilities, heroes, and items automatically.


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.
For nested properties use dot notation e.g. <code>LevelScaling.TechPower</code>. It also automatically unwraps things like <code>DPS.Value</code>.
 
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 14: Line 12:
"1": {
"1": {
"label": "Entity name",
"label": "Entity name",
"description": "Name of the ability, hero, or item. Pass the literal value Convar to look up a console variable instead.",
"description": "Name of the ability, hero, or item.",
"type": "string",
"type": "string",
"required": true,
"required": true,
"example": "Singularity, Drifter, Grit, Convar"
"example": "Singularity, Drifter, Grit"
},
},
"2": {
"2": {
"label": "Property",
"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.",
"description": "Property key to retrieve. Supports dot notation for nested values.",
"type": "string",
"type": "string",
"required": true,
"required": true,
"example": "DPS, BaseHealthRegen, citadel_camera_fov"
"example": "DPS, BaseHealthRegen, BarrierDuration"
},
"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", "3"],
"paramOrder": ["1", "2"],
"description": "Retrieves a raw data value from abilities, heroes, items, or console variables."
"description": "Retrieves a raw data value from abilities, heroes, or items."
}
}
</templatedata>
</templatedata>
Line 43: Line 34:


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


Drifter regenerates {{DataProp|Drifter|BaseHealthRegen}} HP each second.
=== Not found ===
If the entity or property does not exist, the template returns a visible error message.


=== Weapon ===
<code>&#123;&#123;DataProp|Nonexistent Item|FakeProperty&#125;&#125;</code>
<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.
{{DataProp|Nonexistent Item|FakeProperty}}
 
<includeonly>[[Category:Data templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>


=== Ability ===
=== Ability ===
Line 62: Line 57:
Grit's barrier lasts {{DataProp|Grit|BarrierDuration}}s.
Grit's barrier lasts {{DataProp|Grit|BarrierDuration}}s.


=== Convar ===
=== Not found ===
<code>The default camera field of view is &#123;&#123;DataProp|Convar|citadel_camera_fov&#125;&#125;.</code>
If the entity or property does not exist, the template returns an empty string.
 
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>
<code>&#123;&#123;DataProp|Nonexistent Item|FakeProperty&#125;&#125;</code>


{{DataProp|Essence Bomb|Radius|Deathmatch}}
Result: "{{DataProp|Nonexistent Item|FakeProperty}}"


<includeonly>[[Category:Data templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
<includeonly>[[Category:Data templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
Please note that all contributions to The Deadlock Wiki are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see Deadlock:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

Pages included on this page:

Retrieved from "https://deadlock.wiki/Template:DataProp/doc"