Editing Template:Infobox hero/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:
{{TS}}{{TS|Infobox hero/themes.css}}{{Infobox hero
{{Infobox hero
|key=hero_atlas
|key=hero_atlas
|card=Abrams card.png
|voice_actor=Samoa Joe
|voice_actor=Samoa Joe
|release_date=April 16, 2024
|release_date=April 16, 2024
|codenames=Atlas; Bull
|codenames=Atlas; Bull
}}
}}
== Summary ==
Template fills in most parameters in infobox automatically with data from [[Data:HeroData.json]], including base stats and scaling from Levels (Boons) or Spirit Power.
This template fills in most parameters for an Infobox automatically with data from [[Data:HeroData.json]], including base stats and scaling from Levels (Boons) or Spirit Power. Rendering is handled by [[Module:InfoboxHero]], where the row layout is defined as a configuration table at the top of the module. Per-hero colors, backgrounds and logo sizes come from [[Data:Infobox hero.json]].


The hero's code name or their capitalized English name ''must'' be entered in the "key" parameter first. Code name is preferable because it loads faster.
You need to put hero's code name or their capitalized name in English in the "key" parameter first. Code name is preferable because it loads faster.


For example, this "key" fills the Infobox with data for {{HeroIcon|Ivy}}:
For example this "key" fills infobox with data for {{HeroIcon|Ivy}}
<pre>|key = hero_tengu</pre>
<pre>|key = hero_tengu</pre>
or
or
<pre>|key = Ivy</pre>
<pre>|key = Ivy</pre>


Certain rows, such as Bullet Resist, Spirit Resist, Melee Resist, Debuff Resist, and Lifesteal, will automatically hide themselves if the hero has 0 base value (and no scaling) for that row's statistic. The "Information" section hides itself entirely unless at least one of its parameters is provided.
Rows for Bullet Resist, Spirit Resist, Melee Resist, and Lifesteal will automatically hide themselves if the hero has 0 base value and no scaling for that stat.


All base values can be overwritten for rare situations that cannot be immediately automated, but should otherwise be left alone.
If no valid hero is provided, the template will default on '''TargetDummy''' (the default character used in Sandbox modes).
== Documentation ==
'''Description:'''
<templatedata>
<templatedata>
{
{
"params": {
"params": {
"key": {
"name": {},
"description": "The hero's key word, used to auto-fill table contents from \"Data:HeroData.json\". Can be the hero's capitalized name in English or the hero's in-game code name.",
"type": "string",
"example": "hero_atlas",
"required": true,
"default": "hero_targetdummy"
},
"voice_actor": {
"description": "Voice actor(s) for the hero. Footnotes providing sources can (and should) be added when possible.",
"example": "Samoa Joe <ref>[https://www.imdb.com/title/tt33268153/fullcredits/Deadlock] on [https://www.imdb.com/IMDb]</ref>",
"suggested": true
},
"release_date": {
"description": "Date of the official release of the hero.",
"example": "April 24, 2024",
"suggested": true
},
"codenames": {
"description": "Alternative names used for this hero, found inside of game files.",
"example": "Atlas; Bull",
"suggested": true
},
"pronouns": {
"description": "Character pronouns assumed from in-game text/voice-lines or other official information.",
"example": "He/Him, She/Her, They/Them, He/Them, She/Them"
},
"show_hero_tags": {
"description": "Shows (true) or hides (false) the three-word hero tags shown in the roster screen. (ex. \"Tank, Brawler, Bull-Headed\" for Abrams). Heroes without tags omit the row automatically.",
"type": "boolean",
"default": "true"
},
"show_icon": {
"description": "Shows (true) or hides (false) the icon used by the hero in the in-game chat.",
"type": "boolean",
"default": "true"
},
"no_ammo": {
"description": "If set to true, disables the \"Ammo\" and \"Reload Time\" statistics.",
"type": "boolean",
"default": "false"
},
"nocat": {
"description": "If set to true, suppresses all automatic categories. Categories are only ever added in the main namespace, and never for disabled heroes.",
"type": "boolean",
"default": "false"
},
"name_font_size": {
"description": "Sets the size of the font for hero names that do not have a logo image. Only has an effect when \"<Name>_name.svg\" is missing, which includes every hero on languages that have no localized logos.",
"example": "25px",
"default": "25px"
},
"card": {
"card": {
"description": "A file name, including the extension, used as the hero's portrait. Falls back to \"Dummy card.png\" if the file does not exist. NOTE: Only use for overriding automatic data.",
"description": "Adds hero's portrait",
"example": "Abrams card.png",
"example": "Abrams card.png"
"type": "string",
"default": "<Hero name> card.png"
},
"icon": {
"description": "The hero's chat icon, given WITHOUT the \".png\" extension. NOTE: Only use for overriding automatic data.",
"example": "Abrams",
"type": "string",
"default": "<Hero name>"
},
"name": {
"description": "Overrides the hero's name. Used both for the displayed title and to locate the name logo at \"<name>_name.svg\", so give a hero name, NOT a file name. (Silver (Transformed) uses \"Silver\" to reuse Silver's logo.)",
"example": "Silver",
"type": "string"
},
},
"weapon_name": {},
"dps": {},
"dps": {},
"bullet_damage": {},
"bullet_damage": {},
"pellets_per_shot": {
"description": "For heroes with shotgun-type weapons that fire multiple bullets all at once, at the same time. (Silver, Abrams, Shiv, etc.) The row is hidden when the value is 1 or less."
},
"bullets_per_burst": {
"description": "For heroes with weapons that fire multiple bullets in longer bursts, instead of all at once. (Seven, Paradox, Sinclair, Lash) The row is hidden when the value is 1 or less."
},
"ammo": {},
"ammo": {},
"bullets_per_sec": {},
"bullets_per_sec": {},
Line 109: Line 34:
"light_melee": {},
"light_melee": {},
"heavy_melee": {},
"heavy_melee": {},
"range": {},
"max_range": {
"max_range": {
"description": "Maximum distance the bullet can reach. The row only appears when this is provided. (Bebop)",
"description": "For Bebop"
"example": "32{{PI|2}}"
},
"crit_scale": {
"description": "If the hero has crit scale (Kelvin and Vyper)"
},
},
"max_health": {},
"max_health": {},
"health_regen": {},
"health_regen": {},
"crit_reduction": {
"crit_reduction": {
"description": "Percentage (+ or -) that is multiplied to the critical damage (ex. headshots) received from other heroes, increasing/reducing critical damage intake. (Mo & Krill, Rem, Seven)"
"description": "If the hero has crit reduction (Seven and Mo & Krill)"
},
},
"bullet_resist": {},
"bullet_resist": {},
"spirit_resist": {},
"spirit_resist": {},
"melee_resist": {},
"melee_resist": {
"debuff_resist": {
"description": "Melee damage resistance percentage"
"description": "Base debuff resistance, as a percentage. (Mina)"
},
},
"bullet_lifesteal": {
"bullet_lifesteal": {
"description": "Healing gained from bullet damage inflicted to other heroes."
"description": "Healing gained from bullet damage"
},
},
"spirit_lifesteal": {
"spirit_lifesteal": {
"description": "Healing gained from spirit damage inflicted to other heroes."
"description": "Healing gained from spirit damage"
},
},
"move_speed": {},
"move_speed": {},
Line 134: Line 61:
"stamina": {},
"stamina": {},
"stamina_cooldown": {},
"stamina_cooldown": {},
"spirit_power": {
"voice_actor": {},
"description": "Base spirit power and scaling."
"release_date": {
"suggestedvalues": [
"Unreleased"
]
},
"codenames": {
"description": "Alternative names used for this hero in the files"
},
"no_icon": {
"suggestedvalues": [
"true"
],
"description": "Disables the small hero icon in the header",
"type": "boolean",
"default": "true"
},
"no_spirit_resist": {
"suggestedvalues": [
"true"
],
"description": "Manual toggle to hide spirit resist. Now handled automatically by the module.",
"type": "boolean"
},
"no_bullet_resist": {
"suggestedvalues": [
"true"
],
"description": "Manual toggle to hide bullet resist. Now handled automatically by the module.",
"type": "boolean"
},
"key": {
"description": "Autofills table contents from HeroData.json",
"suggestedvalues": [
"hero_atlas",
"hero_bebop",
"hero_dynamo",
"hero_orion",
"hero_haze",
"hero_inferno",
"hero_tengu",
"hero_kelvin",
"hero_ghost",
"hero_lash",
"hero_forge",
"hero_mirage",
"hero_krill",
"hero_chrono",
"hero_synth",
"hero_gigawatt",
"hero_shiv",
"hero_hornet",
"hero_viscous",
"hero_warden",
"hero_wraith",
"hero_yamato",
"hero_astro",
"hero_nano",
"hero_wrecker",
"hero_kali",
"hero_cadence"
],
"required": true,
"type": "string"
},
"icon": {},
"no_summary": {
"type": "boolean",
"autovalue": "true",
"description": "Disables the Role/Playstyle summary tags at the bottom"
},
"pronouns": {
"description": "Character pronouns (e.g. He/Him, They/Them)"
},
"no_name": {
"description": "Uses standard text name instead of the hero logo image",
"type": "string",
"suggestedvalues": [
"true"
]
},
"font-size": {
"description": "Override for hero name font size if wrapping occurs (default 25px)"
},
"weapon-font-size": {
"description": "Override for weapon name font size if wrapping occurs (default 19px)"
}
}
},
},
"description": "Automated infobox for Deadlock heroes.",
"format": "block",
"format": "block",
"paramOrder": [
"paramOrder": [
"key",
"key",
"voice_actor",
"release_date",
"codenames",
"pronouns",
"show_hero_tags",
"show_icon",
"no_ammo",
"nocat",
"name_font_size",
"card",
"card",
"weapon_name",
"icon",
"icon",
"name",
"name",
"dps",
"dps",
"bullet_damage",
"bullet_damage",
"pellets_per_shot",
"bullets_per_burst",
"ammo",
"ammo",
"bullets_per_sec",
"bullets_per_sec",
Line 163: Line 165:
"light_melee",
"light_melee",
"heavy_melee",
"heavy_melee",
"range",
"max_range",
"max_range",
"crit_scale",
"max_health",
"max_health",
"health_regen",
"health_regen",
Line 170: Line 174:
"spirit_resist",
"spirit_resist",
"melee_resist",
"melee_resist",
"debuff_resist",
"bullet_lifesteal",
"bullet_lifesteal",
"spirit_lifesteal",
"spirit_lifesteal",
Line 177: Line 180:
"stamina",
"stamina",
"stamina_cooldown",
"stamina_cooldown",
"spirit_power"
"voice_actor",
],
"release_date",
"description": "Automated infobox for Deadlock heroes."
"codenames",
"pronouns",
"font-size",
"weapon-font-size",
"no_summary",
"no_name",
"no_icon",
"no_spirit_resist",
"no_bullet_resist"
]
}
}
</templatedata>
</templatedata>


<includeonly>[[Category:Infobox templates|Hero]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
<includeonly>[[Category:Infobox templates|Hero]]</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:Infobox_hero/doc"