The Deadlock Wiki

Template:Infobox hero/doc: Difference between revisions

Browse history interactively
← Older editNewer edit →

Vergir (talk | contribs)

2 user groups
1,631 edits
undo
VisualWikitext
mNo edit summary
Vergir (talk | contribs)
Contributors, Interface administrators
1,631 edits
m update doc
Line 6: Line 6:
}}
}}
== Summary ==
== Summary ==
This template fills in most parameters for an Infobox automatically with data from [[Data:HeroData.json]], including base stats, scaling from Levels (Boons) or Spirit Power, associated images/themes, and weapon names. It also uses [[Template:Infobox_hero_tags]] for creating roster tags.
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.
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.
Line 15: Line 15:
<pre>|key = Ivy</pre>
<pre>|key = Ivy</pre>


Certain rows, such as Bullet Resist, Spirit Resist, Melee Resist, and Lifesteal, will automatically hide themselves if the hero has 0 base value (and no scaling) for that row's statistic.
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.


All base values can be overwritten for rare situations that cannot be immediately automated, but should otherwise be left alone.
All base values can be overwritten for rare situations that cannot be immediately automated, but should otherwise be left alone.
Line 28: Line 28:
"params": {
"params": {
"key": {
"key": {
"label": "key",
"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.",
"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",
"type": "string",
"suggestedvalues": [
"example": "hero_atlas",
"hero_airheart",
"hero_astro",
"hero_atlas",
"hero_bebop",
"hero_boho",
"hero_bomber",
"hero_bookworm",
"hero_cadence",
"hero_chrono",
"hero_doorman",
"hero_drifter",
"hero_druid",
"hero_dynamo",
"hero_familiar",
"hero_fencer",
"hero_forge",
"hero_fortuna",
"hero_frank",
"hero_genericperson",
"hero_ghost",
"hero_gigawatt",
"hero_graf",
"hero_gunslinger",
"hero_haze",
"hero_hornet",
"hero_inferno",
"hero_kali",
"hero_kelvin",
"hero_krill",
"hero_lash",
"hero_magician",
"hero_mirage",
"hero_nano",
"hero_necro",
"hero_opera",
"hero_operative",
"hero_orion",
"hero_priest",
"hero_punkgoat",
"hero_rutger",
"hero_shieldguy",
"hero_shiv",
"hero_skyrunner",
"hero_slork",
"hero_swan",
"hero_synth",
"hero_targetdummy",
"hero_tengu",
"hero_testhero",
"hero_thumper",
"hero_tokamak",
"hero_trapper",
"hero_unicorn",
"hero_vampirebat",
"hero_vandal",
"hero_viper",
"hero_viscous",
"hero_warden",
"hero_werewolf",
"hero_werewolf_transformed",
"hero_wraith",
"hero_wrecker",
"hero_yakuza",
"hero_yamato"
],
"required": true,
"required": true,
"default": "hero_targetdummy"
"default": "hero_targetdummy"
},
},
"card": {
"description": "A file name that will be linked as the hero's portrait. NOTE: Only use for overriding automatic data.",
"example": "Abrams card.png",
"type": "string",
"aliases": [
"portrait"
],
"default": "Abrams card.png"
},
"weapon_name": {
"description": "Name of hero's weapon. NOTE: Only use for overriding automatic data.",
"type": "string",
"example": "Case Closed"
},
"icon": {
"description": "A file name that will be linked as the hero's map mini-icon. NOTE: Only use for overriding automatic data.",
"example": "Abrams.png",
"type": "string"
},
"name": {
"aliases": [
"logo"
],
"description": "A file name that will be linked as the hero's name logo. NOTE: Only use for overriding automatic data.",
"example": "Abrams_name.png",
"type": "string"
},
"dps": {},
"bullet_damage": {},
"ammo": {},
"bullets_per_sec": {},
"reload_time": {},
"bullet_velocity": {},
"light_melee": {},
"heavy_melee": {},
"range": {},
"max_range": {
"description": "Maximum distance the bullet can reach. (Bebop)",
"example": "32{{PI|2}}"
},
"crit_scale": {
"description": "Percentage (+ or -) that is multiplied to the critical damage (ex. headshots), increasing/reducing the critical damage inflicted to other heroes. (Mo & Krill, Rem, Seven)",
"example": "-25%"
},
"max_health": {},
"health_regen": {},
"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)"
},
"bullet_resist": {},
"spirit_resist": {},
"melee_resist": {},
"bullet_lifesteal": {
"description": "Healing gained from bullet damage inflicted to other heroes."
},
"spirit_lifesteal": {
"description": "Healing gained from spirit damage inflicted to other heroes."
},
"move_speed": {},
"sprint_speed": {},
"stamina": {},
"stamina_cooldown": {},
"voice_actor": {
"voice_actor": {
"description": "Voice actor(s) for the hero. Footnotes providing sources can (and should) be added when possible.",
"description": "Voice actor(s) for the hero. Footnotes providing sources can (and should) be added when possible.",
Line 173: Line 45:
},
},
"codenames": {
"codenames": {
"aliases": [
"codename"
],
"description": "Alternative names used for this hero, found inside of game files.",
"description": "Alternative names used for this hero, found inside of game files.",
"example": "Atlas; Bull",
"example": "Atlas; Bull",
Line 183: Line 52:
"description": "Character pronouns assumed from in-game text/voice-lines or other official information.",
"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"
"example": "He/Him, She/Her, They/Them, He/Them, She/Them"
},
"spirit_power": {
"description": "Base spirit power and scaling."
},
"no_summary": {
"description": "Deprecated version of \"show_hero_tags\".",
"deprecated": "Use \"show_hero_tags\" instead.",
"type": "boolean",
"default": "false"
},
},
"show_hero_tags": {
"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)",
"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_logo": {
"aliases": [
"show_name"
],
"description": "Shows (true) or hides (false) the name logo displayed above the hero's portrait, if any. Hiding the logo replaces it with a normal text version.",
"type": "boolean",
"type": "boolean",
"default": "true"
"default": "true"
Line 211: Line 63:
"default": "true"
"default": "true"
},
},
"no_spirit_resist": {
"no_ammo": {
"description": "If set to true, disables the \"Ammo\" and \"Reload Time\" statistics.",
"type": "boolean",
"type": "boolean",
"deprecated": "Now handled automatically by the module.",
"description": "Deprecated toggle to hide spirit resist. Is now handled automatically by the module.",
"default": "false"
"default": "false"
},
},
"no_falloff": {
"nocat": {
"description": "If set to true, disables the \"Falloff Range\" statistic. (Celeste)",
"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",
"type": "boolean",
"default": "false"
"default": "false"
},
},
"no_ammo": {
"name_font_size": {
"description": "If set to true, disables the \"Ammo\" and \"Reload time\" statistics. (Silver)",
"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.",
"type": "boolean",
"example": "25px",
"default": "false"
"default": "25px"
},
"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.",
"example": "Abrams card.png",
"type": "string",
"default": "<Hero name> card.png"
},
"icon": {
"description": "The hero's map mini-icon, given WITHOUT the \".png\" extension. NOTE: Only use for overriding automatic data.",
"example": "Abrams",
"type": "string",
"default": "<Hero name>"
},
},
"no_name": {
"name": {
"description": "Deprecated version of \"show_logo\".",
"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.)",
"deprecated": "Use \"show_logo\" instead.",
"example": "Silver",
"type": "boolean",
"type": "string"
"default": "false"
},
},
"no_icon": {
"dps": {},
"description": "Deprecated version of \"show_icon\".",
"bullet_damage": {},
"deprecated": "Use \"show_icon\" instead.",
"pellets_per_shot": {
"type": "boolean",
"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."
"default": "false"
},
},
"bullets_per_burst": {
"bullets_per_burst": {
"description": "For heroes with weapons that fire multiple bullets in longer bursts, instead of all at once. (Seven, Paradox, Sinclair, Lash)",
"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."
"type": "unknown"
},
"ammo": {},
"bullets_per_sec": {},
"reload_time": {},
"bullet_velocity": {},
"light_melee": {},
"heavy_melee": {},
"max_range": {
"description": "Maximum distance the bullet can reach. The row only appears when this is provided. (Bebop)",
"example": "32{{PI|2}}"
},
},
"bullets_per_shot": {
"max_health": {},
"description": "For heroes with shotgun-type weapons that fire multiple bullets all at once, at the same time. (Silver, Abrams, Shiv, etc.)"
"health_regen": {},
"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)"
},
"bullet_resist": {},
"spirit_resist": {},
"melee_resist": {},
"debuff_resist": {
"description": "Base debuff resistance, as a percentage. (Mina)"
},
"bullet_lifesteal": {
"description": "Healing gained from bullet damage inflicted to other heroes."
},
},
"no_bullet_resist": {
"spirit_lifesteal": {
"description": "Deprecated toggle to hide bullet resist. Is now handled automatically by the module.",
"description": "Healing gained from spirit damage inflicted to other heroes."
"type": "boolean",
"deprecated": true,
"default": "false"
},
},
"name_font_size": {
"move_speed": {},
"aliases": [
"sprint_speed": {},
"font-size",
"stamina": {},
"font_size"
"stamina_cooldown": {},
],
"spirit_power": {
"description": "Sets the size of the font for hero names that do not have a logo image.",
"description": "Base spirit power and scaling."
"example": "25px"
}
}
},
},
Line 270: Line 147:
"show_hero_tags",
"show_hero_tags",
"show_icon",
"show_icon",
"show_logo",
"no_falloff",
"no_ammo",
"no_ammo",
"nocat",
"name_font_size",
"name_font_size",
"card",
"card",
"icon",
"icon",
"name",
"name",
"weapon_name",
"dps",
"dps",
"bullet_damage",
"bullet_damage",
"pellets_per_shot",
"bullets_per_burst",
"ammo",
"ammo",
"bullets_per_sec",
"bullets_per_sec",
Line 286: Line 163:
"light_melee",
"light_melee",
"heavy_melee",
"heavy_melee",
"range",
"max_range",
"max_range",
"crit_scale",
"max_health",
"max_health",
"health_regen",
"health_regen",
"crit_reduction",
"crit_reduction",
"bullets_per_burst",
"bullets_per_shot",
"bullet_resist",
"bullet_resist",
"spirit_resist",
"spirit_resist",
"melee_resist",
"melee_resist",
"debuff_resist",
"bullet_lifesteal",
"bullet_lifesteal",
"spirit_lifesteal",
"spirit_lifesteal",
Line 303: Line 177:
"stamina",
"stamina",
"stamina_cooldown",
"stamina_cooldown",
"spirit_power",
"spirit_power"
"no_summary",
"no_name",
"no_icon",
"no_bullet_resist",
"no_spirit_resist"
],
],
"description": "Automated infobox for Deadlock heroes."
"description": "Automated infobox for Deadlock heroes."
Retrieved from "https://deadlock.wiki/Template:Infobox_hero/doc"