Module:HeroList

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}}

{{#invoke:HeroList|display|faction=Grove|language=ja}}

---

local p = {}

-- Fonction utilitaire pour récupérer une traduction via Cargo
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
    })
    
    -- Fallback sur l'anglais si rien trouvé
    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"
    
    -- 1. 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
    
    -- 2. Récupération des héros avec tri numérique
    -- On utilise CAST(SUBSTRING_INDEX(id, '_', -1) AS UNSIGNED) pour trier par la partie numérique de l'ID
    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
        ),
        orderBy = "CAST(SUBSTRING_INDEX(id, '_', -1) AS UNSIGNED) ASC"
    })
    
    -- 3. Construction du tableau
    local html = {'{| class="wikitable sortable"', '! Portrait !! ID Technique !! 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
        
        local class_name = getTrans(h.class_id, lang, 'class') or h.class_id
        local spec_name = getTrans(h.specialization_id, lang, 'specialization') or h.specialization_id
        
        table.insert(html, "|-")
        table.insert(html, string.format('| [[File:%s.png|70px]]', file_name))
        table.insert(html, "| " .. h.id)
        table.insert(html, string.format('| [[%s|%s]]', file_name, name))
        table.insert(html, "| " .. class_name)
        table.insert(html, "| " .. spec_name)
    end
    
    -- Fermeture unique du tableau
    table.insert(html, "|}")
    return table.concat(html, "\n")
end

return p