Module:HeroData/nav: Difference between revisionsGive feedback
Gammaton32 (talk | contribs) added gallery function |
Gammaton32 (talk | contribs) No edit summary |
||
| Line 169: | Line 169: | ||
local heroes = get_heroes(in_herolabs) | local heroes = get_heroes(in_herolabs) | ||
local parts = {} | local parts = {} | ||
for _, hero in ipairs(heroes) do | for _, hero in ipairs(heroes) do | ||
local start_gallery = '<gallery>' | |||
local end_gallery = '</gallery>' | |||
-- Skip redlinks entirely when enabled | -- Skip redlinks entirely when enabled | ||
Revision as of 03:47, 1 June 2026
Overview
Generates hero navigation cards
Functions
get_hero_nav_cards
For Template:Hero Navbox on Heroes, individual hero pages like Abrams, and the home page.
Examples
First with debug_mode on, to help visualize what the output's source looks like.
{{#invoke:HeroData/nav|get_hero_nav_cards
|text_size=13
|card_size=88
|in_herolabs=false
|debug_mode=true
}}
{{Hero card2|heroName=Abrams|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Apollo|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Bebop|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Billy|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Calico|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Celeste|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=The Doorman|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Drifter|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Dynamo|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Graves|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Grey Talon|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Haze|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Holliday|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Infernus|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Ivy|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Kelvin|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Lady Geist|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Lash|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=McGinnis|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Mina|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Mirage|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Mo & Krill|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Paige|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Paradox|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Pocket|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Rem|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Seven|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Shiv|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Silver|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Sinclair|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Venator|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Victor|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Vindicta|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Viscous|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Vyper|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Warden|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Wraith|cardSize=88|textSize=13|isHeroLabs=false}}{{Hero card2|heroName=Yamato|cardSize=88|textSize=13|isHeroLabs=false}}
Now with debug_mode defaulted to false (off) to see actual visual output.
{{#invoke:HeroData/nav|get_hero_nav_cards
|text_size=13
|card_size=88
|in_herolabs=false
}}
Parameters
- text_size - Font size of the hero name
- card_size - Size of the hero card
- in_herolabs - Get hero labs heroes (there are none at the moment)
- debug_mode - (OPTIONAL) Defaults to false. With true, the output is raw wikitext source that isn't processed, allowing to see more clearly what is ran.
debug_mode is the only optional parameter. All other parameters are required. Template:Hero card2 utilizes this with some default values, see there for suggested values.
get_hero_roster
For Template:Roster on Heroes, generate a list using Template:HeroRosterCard.
get_hero_bulletpoints
For navboxes such as Template:Quotes Navbox, generate a bulletpoint list of heroes.
Add the name of a subpage to link to specific subpages. It will still display only the hero name but link to the subpage instead.
Add variable "no_redlinks=true" to hide red links (non-existent pages).
Examples
{{#invoke:HeroData/nav|get_hero_bulletpoints}}
Abrams • 
Apollo • 
Bebop • 
Billy • 
Calico • 
Celeste • 
The Doorman • 
Drifter • 
Dynamo • 
Graves • 
Grey Talon • 
Haze • 
Holliday • 
Infernus • 
Ivy • 
Kelvin • 
Lady Geist • 
Lash • 
McGinnis • 
Mina • 
Mirage • 
Mo & Krill • 
Paige • 
Paradox • 
Pocket • 
Rem • 
Seven • 
Shiv • 
Silver • 
Sinclair • 
Venator • 
Victor • 
Vindicta • 
Viscous • 
Vyper • 
Warden • 
Wraith • 
Yamato
To link to "/Movement" subpages:
{{#invoke:HeroData/nav|get_hero_bulletpoints|Movement}}
Abrams • Apollo • Bebop • Billy • Calico • Celeste • The Doorman • Drifter • Dynamo • Graves • Grey Talon • Haze • Holliday • Infernus • Ivy • Kelvin • Lady Geist • Lash • McGinnis • Mina • Mirage • Mo & Krill • Paige • Paradox • Pocket • Rem • Seven • Shiv • Silver • Sinclair • Venator • Victor • Vindicta • Viscous • Vyper • Warden • Wraith • Yamato
Hide redlinks:
{{#invoke:HeroData/nav|get_hero_bulletpoints|Movement|no_redlinks=true}}
Abrams • The Doorman • Drifter • Dynamo • Haze • Holliday • Infernus • Ivy • Lash • Mo & Krill • Paradox • Pocket • Seven • Shiv • Sinclair • Vindicta • Viscous • Wraith • Yamato
local p = {}
local heroes_data = mw.loadJsonData("Data:HeroData.json")
local hero_release_module = require('Module:HeroData/release')
local lang_module = require('Module:Lang')
local utilities = require('Module:Utilities')
-- Shared helper function
local function get_heroes(in_herolabs, include_key)
local heroes = {}
for hero_key, hero_data in pairs(heroes_data) do
-- hero_werewolf_transformed is consolidated in Silver's page
if hero_data["Name"] ~= nil and hero_key ~= 'hero_werewolf_transformed' then
local this_hero_status = hero_release_module.get_hero_release_status(hero_key)
if ((in_herolabs == 'true' and this_hero_status == 'HeroLabs') or
(in_herolabs == 'false' and this_hero_status == 'Released')) then
local is_recommended = hero_data['IsRecommended'] or false
--- Create a sort key for each hero to ensure correct alphabetical ordering.
-- This logic handles special cases like "The Doorman" by looking for a "_sort" version of the hero's key in the language files.
local hero_name = lang_module.get_string(hero_key, nil, 'en')
local sort_key_to_find = hero_key .. '_sort'
local potential_sort_key = lang_module.get_string(sort_key_to_find, nil, 'en')
local sort_key
-- The lang_module returns the requested key (wrapped in HTML) if a translation is not found.
-- We detect this failure by checking if the returned string contains the key we originally searched for.
if string.find(potential_sort_key, sort_key_to_find, 1, true) then
-- If the key is found in the result, it means the translation failed. Fall back to the hero's display name for sorting.
sort_key = hero_name
else
-- If the key is NOT found, it means we received a valid sort key (e.g., "Doorman"). Use it.
sort_key = potential_sort_key
end
-- Store reusable hero data
local hero = {
key = hero_key,
name = hero_name,
sort_key = sort_key,
link = lang_module.get_string(hero_key, 'en'),
recommended = tostring(is_recommended)
}
table.insert(heroes, hero)
end
end
end
-- Sort heroes
table.sort(heroes, function(a, b)
return a.sort_key < b.sort_key
end)
return heroes
end
-- for [[Template:Deadlock_Wiki/Heroes]]
function p.get_hero_nav_cards(frame)
local text_size = frame.args['text_size']
local card_size = frame.args['card_size']
local in_herolabs = frame.args['in_herolabs'] or 'false'
local debug_mode = frame.args['debug_mode'] == 'true'
local heroes = get_heroes(in_herolabs)
local ret = ''
for _, hero in ipairs(heroes) do
ret = ret .. '{{Hero card2'
ret = ret .. '|heroName=' .. hero.link
ret = ret .. '|cardSize=' .. card_size
ret = ret .. '|textSize=' .. text_size
ret = ret .. '|isHeroLabs=' .. in_herolabs
ret = ret .. '}}'
end
if debug_mode then
return ret
else
return frame:preprocess(ret)
end
end
-- for [[Template:Roster]]
function p.get_hero_roster(frame)
local in_herolabs = frame.args['in_herolabs'] or 'false'
local debug_mode = frame.args['debug_mode'] == 'true'
local lang_code = lang_module.get_lang_code()
local subpage_str = ''
if lang_code ~= 'en' then
subpage_str = '/' .. lang_code
end
local heroes = get_heroes(in_herolabs)
local ret = ''
for _, hero in ipairs(heroes) do
ret = ret .. '{{HeroRosterCard'
ret = ret .. '|name=' .. hero.name
ret = ret .. '|key=' .. hero.key
ret = ret .. '}}'
end
if debug_mode then
return ret
else
return frame:preprocess(ret)
end
end
-- for [[Template:Quotes Navbox]] etc.
local utilities = require('Module:Utilities')
p.get_hero_bulletpoints = function(frame)
local subpage = frame.args['1']
local in_herolabs = frame.args['in_herolabs'] or 'false'
local debug_mode = frame.args['debug_mode'] == 'true'
local no_redlinks = frame.args['no_redlinks'] == 'true' -- default: false
local heroes = get_heroes(in_herolabs)
local parts = {}
for _, hero in ipairs(heroes) do
local page_title = hero.name
if subpage then
page_title = hero.name .. '/' .. subpage
end
-- Skip redlinks entirely when enabled
if not (no_redlinks and not utilities.page_exists(page_title)) then
local item
if subpage then
item = '{{PageRef|' .. hero.name .. '|alt_link=' .. page_title .. '}}'
else
item = '{{HeroIcon|' .. hero.name .. '}}'
end
table.insert(parts, item)
end
end
local ret = table.concat(parts, ' • ')
if debug_mode then
return ret
else
return frame:preprocess(ret)
end
end
-- for image galleries
local utilities = require('Module:Utilities')
p.get_hero_gallery = function(frame)
local file_name = frame.args['1']
local description = frame.args['2']
local in_herolabs = frame.args['in_herolabs'] or 'false'
local debug_mode = frame.args['debug_mode'] == 'true'
local no_redlinks = frame.args['no_redlinks'] == 'true' -- default: false
local heroes = get_heroes(in_herolabs)
local parts = {}
for _, hero in ipairs(heroes) do
local start_gallery = '<gallery>'
local end_gallery = '</gallery>'
-- Skip redlinks entirely when enabled
if not (no_redlinks and not utilities.page_exists(page_title)) then
local item
item = 'File:' .. hero.name .. file_name .. '|'.. hero.name .. description ..
table.insert(parts, item)
end
end
local ret = table.concat(start_gallery, parts, end_gallery)
if debug_mode then
return ret
else
return frame:preprocess(ret)
end
end
return p