Module:HeroList
From Heroes of Might and Magic: Olden Era Official Wiki
Description
This module generates an automated table of heroes belonging to a specific faction. It dynamically retrieves localization for hero names, classes, and specializations, and formats the starting skills and spells into a clean, sortable layout.
Usage
The module is invoked via the display function:
{{#invoke:HeroList|display|faction=...|language=...}}
Parameters
| Parameter | Description | Example |
|---|---|---|
faction |
The name of the faction (as stored in the Translation table). | faction=Necropolis
|
language |
Forces the Wiki language (if omitted, it detects the page suffix). | language=fr
|
Key Features
- Dynamic Localization: Translates headers (Name, Class, etc.) and hero-specific data (Names, Skills, Spells) based on the provided language.
- Automatic Formatting:
- Displays hero portraits and icons.
- Formats specializations with tooltips showing descriptions.
- Lists starting skills and spells as link-lists with icons.
- Sorting Support: The table uses the
sortableclass, allowing users to reorder heroes based on columns. - Data Cleanup: Automatically filters out campaign, tutorial, and internal testing heroes (e.g.,
cm_fun).
Implementation Example
To display all heroes of the "Necropolis" faction:
== Necropolis Heroes ==
{{#invoke:HeroList|display|faction=Necropolis}}
Technical Notes
- The module queries the
Herotable and joins data with theTranslationtable. - It uses
sortabletables; ensure the MediaWiki "Sortable" extension is active for full functionality. - Specialization icons are automatically inferred from the
HeroSpecializationtable and formatted to match faction naming conventions.
Examples
{{#invoke:HeroList|display|faction=Necropolis}}
{{#invoke:HeroList|display|faction=Grove|language=ja}}
local p = {}
-- Fonction utilitaire pour récupérer une traduction
local function getTrans(target_id, lang, type)
if not target_id or target_id == "" then return nil end
local query = mw.ext.cargo.query("Translation", "name", {
where = string.format("target_id = '%s' AND language = '%s' AND type = '%s'", target_id, lang, type),
limit = 1
})
if not query or #query == 0 then
query = mw.ext.cargo.query("Translation", "name", {
where = string.format("target_id = '%s' AND language = 'en' AND type = '%s'", target_id, type),
limit = 1
})
end
return (query and #query > 0) and query[1].name or nil
end
function p.display(frame)
local raw_faction = frame.args.faction
local lang = frame.args.language or mw.title.getCurrentTitle().text:match("/(%a%a)$") or "en"
local faction_query = mw.ext.cargo.query("Translation", "target_id", {
where = string.format("name = '%s' AND type = 'faction'", raw_faction),
limit = 1
})
local faction_id = (faction_query and #faction_query > 0) and faction_query[1].target_id or raw_faction
local heroes = mw.ext.cargo.query("Hero", "id, name_sid, class_id, specialization_id", {
where = string.format("faction = '%s' AND id NOT LIKE '%%campaign%%' AND id NOT LIKE '%%tutorial%%' AND id NOT LIKE '%%cm_fun%%'", faction_id)
})
table.sort(heroes, function(a, b)
local numA = tonumber(a.id:match("(%d+)$")) or 0
local numB = tonumber(b.id:match("(%d+)$")) or 0
return numA < numB
end)
local html = {'{| class="wikitable sortable"', '! Portrait !! Nom !! Classe !! Spécialisation'}
for _, h in ipairs(heroes) do
local name = getTrans(h.name_sid, lang, 'hero') or h.name_sid
local file_name = getTrans(h.name_sid, 'en', 'hero') or h.id
-- CLASSE
local class_name = getTrans(h.class_id, lang, 'hero_class') or h.class_id
local class_en = getTrans(h.class_id, 'en', 'hero_class') or h.class_id
local class_link = string.format("[[%s/%s|%s]]", class_en, lang, class_name)
local class_icon = string.format("[[File:%s.png|25px|link=]] ", class_en)
-- SPÉCIALISATION
local spec_name = getTrans(h.specialization_id, lang, 'hero_specialization') or h.specialization_id
local spec_en = getTrans(h.specialization_id, 'en', 'hero_specialization') or h.specialization_id
local spec_link = string.format("[[%s/%s|%s]]", spec_en, lang, spec_name)
local spec_icon = string.format("[[File:%s.png|25px|link=]] ", spec_en)
table.insert(html, "|-")
table.insert(html, string.format('| [[File:%s.png|70px]]', file_name))
table.insert(html, string.format('| [[%s|%s]]', file_name, name))
table.insert(html, "| " .. class_icon .. class_link)
table.insert(html, "| " .. spec_icon .. spec_link)
end
table.insert(html, "|}")
return table.concat(html, "\n")
end
return p
