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 sortable class, 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 Hero table and joins data with the Translation table.
  • It uses sortable tables; ensure the MediaWiki "Sortable" extension is active for full functionality.
  • Specialization icons are automatically inferred from the HeroSpecialization table and formatted to match faction naming conventions.

Examples

{{#invoke:HeroList|display|faction=Necropolis}}
Portrait Nom Classe Spécialisation
Bulwark Death Knight File:Built Different Icon.png Built Different
King-of-Kings Death Knight File:Charismatic Icon.png Charismatic
Onkos Death Knight File:Perfect Puppets Icon.png Perfect Puppets
Kel'Ghul Death Knight File:Dreadful War Icon.png Dreadful War
Natalida Death Knight File:Part of a Pack Icon.png Part of a Pack
Artorius Veritas Death Knight File:Drive 'em Crazy Icon.png Drive 'em Crazy
Marl Death Knight File:Languid Soil Icon.png Languid Soil
Tarius Death Knight File:Undead Legion Icon.png Undead Legion
Zam Death Knight File:Alchemist Icon.png Alchemist
Mag Necromancer File:Arcane Dominion Icon.png Arcane Dominion
Adahn Necromancer File:Amnesiac Icon.png Amnesiac
Ethric Necromancer File:Tomb-bound Will Icon.png Tomb-bound Will
Guildmaster Klastor Necromancer File:Bones Guild Icon.png Bones Guild
Shadespinner Oona Necromancer File:Shadowmastery Icon.png Shadowmastery
Laura Necromancer File:Moldering Icon.png Moldering
Lord Rufus Necromancer File:Wistful Nostalgia Icon.png Wistful Nostalgia
Funerella Necromancer File:Undead Legion Icon.png Undead Legion
Milossa the Golden Necromancer File:Wealthy Icon.png Wealthy


{{#invoke:HeroList|display|faction=Grove|language=ja}}
Portrait Nom Classe Spécialisation
イース ウォーデン File:Pathfinder Icon.png パスファインダー
槍頭のゴレル ウォーデン File:Shooter Icon.png 射手
ジンジャーテール ウォーデン File:Faunsong Icon.png フォーンソング
巡礼の老人 ウォーデン File:Natural Selection Icon.png 自然の選択
オクタヴィア ウォーデン File:Four-Leaf Horseshoe Icon.png 四葉の馬蹄
ニャオワ ウォーデン File:Charming Shine Icon.png 魅惑の輝き
ファレオール ウォーデン File:Hksmilla's Step Icon.png フクスミラの歩み
魅惑のシャー ウォーデン File:Charismatic Icon.png カリスマ
ダリアおばさん ウォーデン File:Wish to Learn Icon.png 学びの願い
ヴァトウナ ドルイド File:Spiritual Vigor Icon.png 魂の活力
老ツ=キッシュ ドルイド File:Oldest Known Tree Icon.png 最古の樹
エアリニエル ドルイド File:Tempered Embers Icon.png 穏やかな燃えさし
グレイシア ドルイド File:Ice Bolt Icon.png 氷撃
ヴィム ドルイド File:Rock It up! Icon.png ぶちかませ!
ハロン ドルイド File:Thunder and Lightning Icon.png 轟雷
エコリリー ドルイド File:Murmuring Copy Icon.png ざわめきの模倣
サリー ドルイド File:Murmurwood Native Icon.png ざわめきの森の原住民
吟遊詩人 ドルイド File:Wandering Musician Icon.png 放浪の音楽家

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"
    
    -- Récupération dynamique de l'ID de faction
    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
    
    -- Récupération des héros
    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)
    })
    
    -- Tri numérique personnalisé (1 à 18)
    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)
    
    -- Construction du tableau
    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 Icon.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