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}}
ID Nom trouvé État du DEBUG


{{#invoke:HeroList|display|faction=Grove|language=ja}}
ID Nom trouvé État du DEBUG

local p = {}

local function getTrans(target_id, lang, type)
    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 faction = frame.args.faction
    local lang = frame.args.language or mw.title.getCurrentTitle().text:match("/(%a%a)$") or "en"
    
    local heroes = mw.ext.cargo.query("Hero", "id, name_sid", {
        where = string.format("faction = '%s'", faction), orderBy = "id"
    })
    
    local html = {'{| class="wikitable sortable"', '! ID !! Nom trouvé !! État du DEBUG'}
    
    for _, h in ipairs(heroes) do
        local name = getTrans(h.name_sid, lang, 'hero')
        local debug_info = "OK"
        if not name then 
            debug_info = "Échec pour ID: " .. h.name_sid .. " / Lang: " .. lang 
            name = h.name_sid
        end
        
        table.insert(html, "|-")
        table.insert(html, "| " .. h.id)
        table.insert(html, "| " .. name)
        table.insert(html, "| " .. debug_info)
    end
    
    table.insert(html, "|}")
    return table.concat(html, "\n")
end

return p