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}}
Aucun héros trouvé pour la faction : Necropolis


{{#invoke:HeroList|display|faction=Grove|language=ja}}
Aucun héros trouvé pour la faction : Grove

local p = {}

-- Fonction de débogage qui affiche ce qui se passe
local function debug_msg(msg)
    return '<div style="color:red; border:1px solid red; padding:5px;">' .. msg .. '</div>'
end

function p.display(frame)
    local faction = frame.args.faction
    local lang = frame.args.lang or mw.language.getContentLanguage():getCode()
    
    -- 1. Test de la requête héros
    local heroes = mw.ext.cargo.query("Hero", "id, name_sid, class_id, specialization_id, start_skills, start_magics", {
        where = string.format("faction = '%s'", faction), orderBy = "id"
    })
    
    if not heroes or #heroes == 0 then return debug_msg("Aucun héros trouvé pour la faction : " .. (faction or "nil")) end
    
    local html = {'{| class="wikitable sortable"', '! Portrait !! Nom !! Classe !! Icône !! Spécialisation'}
    
    for _, h in ipairs(heroes) do
        -- On tente de récupérer le nom anglais pour l'image
        local name_en_query = mw.ext.cargo.query("Translation", "name", {
            where = string.format("target_id = '%s' AND language = 'en'", h.name_sid), limit = 1
        })
        
        local file_name = (name_en_query and name_en_query[1]) and name_en_query[1].name or "File_Not_Found"
        
        table.insert(html, "|-")
        table.insert(html, string.format('| [[File:%s.png|70px]]', file_name))
        table.insert(html, string.format('| %s', h.name_sid))
        table.insert(html, string.format('| %s', h.class_id))
        table.insert(html, string.format('| [[File:%s Specialization Icon.png|64px]]', h.id))
        table.insert(html, string.format('| %s', h.specialization_id))
    end
    
    table.insert(html, "|}")
    return table.concat(html, "\n")
end

return p