Module:HeroClass

From Heroes of Might and Magic: Olden Era Official Wiki

Description

This module is a comprehensive utility for generating hero class profiles. It integrates statistical data, secondary skill probabilities, and subclass information into a unified, styled infobox layout. It handles multi-language support and automatic data linking via Cargo.

Usage

You can invoke specific sections or the entire main box:

{{#invoke:HeroList|getMainBox|class=...|language=...}}
{{#invoke:HeroList|getStatsTable|class=...}}
{{#invoke:HeroList|getSkillsTable|class=...}}
{{#invoke:HeroList|getSubclassesBlock|class=...}}

Parameters

Parameter Description Example
class The identifier or common name of the hero class (e.g., knight, herald, warlock). class=Knight
language Forces the Wiki language (if omitted, it detects the page suffix). language=fr

Key Features

  • Main Infobox (getMainBox): Combines class crests, base stats, skill probabilities, and subclasses into a cohesive, responsive container.
  • Dynamic Statistics (getStatsTable): Displays base hero attributes along with growth rates at levels 1-12 and 13+. Features automatic icon rendering.
  • Skill Probabilities (getSkillsTable): Retrieves "Skill Roll Weights" from Cargo to generate a comparison table showing the likelihood of learning specific secondary skills.
  • Subclass Integration (getSubclassesBlock): Dynamically fetches subclass data, including localization for names and descriptions, and lists activation skills with icons.
  • Smart Localization: Automatically detects page language (e.g., /fr) and falls back to English if translations are missing in the Translation table.

Implementation Example

To display the full infobox for the "Knight" class:

{{#invoke:HeroList|getMainBox|class=Knight}}

Technical Notes

  • The module uses several Cargo tables: HeroClass, SkillRollWeight, HeroSubClass, and Translation.
  • The class_mapping table within the script translates user-friendly names (e.g., "knight") into technical Cargo IDs (e.g., "might_human").
  • CSS is embedded inline to ensure the infobox maintains a consistent look across different Wiki skins, using a dark-theme style (#1a1f26 background).

local p = {}

-- =========================================================================
-- CONFIGURATION & TABLES DE CORRESPONDANCE
-- =========================================================================

-- Associe le nom d'usage de la classe à son identifiant Cargo (class_id)
local class_mapping = {
    ["herald"]       = "magic_demon",
    ["warlock"]      = "magic_dungeon",
    ["cleric"]       = "magic_human",
    ["druid"]        = "magic_nature",
    ["necromancer"]  = "magic_undead",
    ["riftspeaker"]  = "magic_unfrozen",
    ["enforcer"]     = "might_demon",
    ["overlord"]     = "dungeon_might",
    ["knight"]       = "might_human", 
    ["warden"]       = "might_nature",
    ["death knight"] = "might_undead",
    ["oathkeeper"]   = "might_unfrozen"
}

-- Ta structure de compétences (Matrice 12x2 complète)
local skills_structure = {
    { {"Offence", "", "skill_assault"}, {"Defence", "", "skill_protection"} },
    { {"Resistance", "", "skill_resistance"}, {"Battlecraft", "", "skill_formation"} },
    { {"Sorcery", "", "skill_sorcery"}, {"Intelligence", "", "skill_mastery"} },
    { {"Summon Avatar", "", "skill_summoner"}, {"Battle Magic", "", "skill_battlemage"} },
    { {"Daylight Magic", "", "skill_magic_day"}, {"Nightshade Magic", "", "skill_magic_night"} },
    { {"Arcane Magic", "", "skill_magic_space"}, {"Primal Magic", "", "skill_magic_primal"} },
    { {"Leadership", "", "skill_leadership"}, {"Luck", "", "skill_luck"} },
    { {"Insight", "", "skill_enlightenment"}, {"Diplomacy", "", "skill_diplomacy"} },
    { {"Logistics", "", "skill_logistic"}, {"Scouting", "", "skill_scouting"} },
    { {"Economy", "", "skill_economy"}, {"Tactics", "", "skill_tactics"} },
    { {"Siegecraft", "", "skill_siege"}, {"Recruitment", "", "skill_trainer"} },
    { {"Thaumaturgy", "", "skill_wisdom"}, {"Combat", "", "skill_battle_artistry"} }
}

-- Crée un dictionnaire inversé pour retrouver le nom d'image d'un skill à partir de son ID Cargo
local skill_ids_to_images = {}
for _, double_row in ipairs(skills_structure) do
    skill_ids_to_images[double_row[1][3]] = double_row[1][1]
    skill_ids_to_images[double_row[2][3]] = double_row[2][1]
end

-- =========================================================================
-- FONCTIONS UTILITAIRES INTERNES
-- =========================================================================

-- Détecte automatiquement la langue via le titre (ex: "Chevalier/fr" -> "fr")
local function getLanguageInfo()
    local currentTitle = mw.title.getCurrentTitle().text
    local lang_suffix = string.match(currentTitle, "/([a-z][a-z])$")
    
    if lang_suffix then
        return lang_suffix, "/" .. lang_suffix
    else
        return "en", "" 
    end
end

-- Sépare le type et la faction (ex: "might_human" -> type="might", faction="human")
local function parseClassId(classId)
    local type_part, faction_part = string.match(classId, "([a-z]+)_([a-z]+)")
    if not type_part or not faction_part then
        faction_part, type_part = string.match(classId, "([a-z]+)_([a-z]+)")
    end
    return type_part, faction_part
end

-- Génère automatiquement le nom de la table SQL à partir du class_id
local function generateTableId(classId)
    local type_part, faction_part = parseClassId(classId)
    
    if faction_part and type_part then
        if faction_part == "human" then faction_part = "humans"
        elseif faction_part == "demon" then faction_part = "demons"
        elseif faction_part == "dungeon" then faction_part = "dungeons"
        elseif faction_part == "nature" then faction_part = "natures"
        elseif faction_part == "undead" then faction_part = "undeads"
        elseif faction_part == "unfrozen" then faction_part = "unfrozens"
        end
        return string.format("%s_%s_skills_table", faction_part, type_part)
    end
    return nil
end

-- 1. RÉCUPÉRATION DES POIDS (Depuis Cargo SkillRollWeight)
local function fetchWeightsFromCargo(tableId)
    local weights = {}
    if not tableId then return weights end
    
    local res = mw.ext.cargo.query("SkillRollWeight", "skill_id, weight", {
        where = string.format("table_id = '%s' AND band_kind = 'default'", tableId),
        limit = 100
    })
    
    if res then
        for _, row in ipairs(res) do
            if row.skill_id and row.weight then
                weights[string.lower(mw.text.trim(row.skill_id))] = row.weight
            end
        end
    end
    return weights
end

-- 2. RÉCUPÉRATION DES TRADUCTIONS DES SKILLS (Depuis Cargo Translation)
local function fetchTranslationsFromCargo(lang)
    local translations = {}
    local tables = "Skill, Translation"
    local fields = "Skill.id=id, Translation.name=name"
    
    local query_opts = {
        join = "Skill.id = Translation.target_id",
        where = string.format("Translation.type = 'skill' AND Translation.language = '%s'", lang),
        limit = 300
    }
    
    local res = mw.ext.cargo.query(tables, fields, query_opts)
    if res then
        for _, row in ipairs(res) do
            if row.id and row.name then
                translations[string.lower(mw.text.trim(row.id))] = mw.text.trim(row.name)
            end
        end
    end
    
    if lang ~= "en" then
        query_opts.where = "Translation.type = 'skill' AND Translation.language = 'en'"
        local backup_res = mw.ext.cargo.query(tables, fields, query_opts)
        if backup_res then
            for _, row in ipairs(backup_res) do
                local id_clean = string.lower(mw.text.trim(row.id or ""))
                if id_clean ~= "" and not translations[id_clean] then
                    translations[id_clean] = mw.text.trim(row.name or "")
                end
            end
        end
    end
    
    return translations
end

-- =========================================================================
-- FONCTIONS PUBLIQUES
-- =========================================================================

-- 1. Génère le grand tableau des compétences secondaires
function p.getSkillsTable(frame)
    local args = frame.args[1] and frame.args or frame:getParent().args
    local lang, suffix = getLanguageInfo()
    
    local raw_class_name = string.lower(mw.text.trim(args.class or args[1] or ""))
    local class_id = class_mapping[raw_class_name]
    
    if not class_id then
        return ""
    end

    local table_id = generateTableId(class_id)
    local weight_dictionary = fetchWeightsFromCargo(table_id)
    local translation_dictionary = fetchTranslationsFromCargo(lang)
    
    local html = {}
    table.insert(html, '{| class="wikitable" style="width:100%; border-collapse:collapse;"')
    
    for _, double_row in ipairs(skills_structure) do
        local s1, s2 = double_row[1], double_row[2]
        
        local label1 = translation_dictionary[s1[3]] or s1[1]
        local label2 = translation_dictionary[s2[3]] or s2[1]
        
        local val1 = weight_dictionary[s1[3]] or "0"
        local val2 = weight_dictionary[s2[3]] or "0"
        
        table.insert(html, '|-')
        table.insert(html, string.format('| [[File:Skill_%s.png|32px|link=%s%s]] %s || %s || [[File:Skill_%s.png|32px|link=%s%s]] %s || %s', 
            s1[1], s1[1], suffix, label1, val1, 
            s2[1], s2[1], suffix, label2, val2
        ))
    end
    
    table.insert(html, '|}')
    return table.concat(html, "\n")
end

-- 2. Génère le bloc des sous-classes (Alignement HORIZONTAL corrigé pour MediaWiki)
function p.getSubclassesBlock(frame)
    local args = frame.args[1] and frame.args or frame:getParent().args
    local lang, suffix = getLanguageInfo()
    
    local raw_class_name = string.lower(mw.text.trim(args.class or args[1] or ""))
    local class_id = class_mapping[raw_class_name]
    
    if not class_id then return "" end
    
    local type_part, faction_part = parseClassId(class_id)
    if not type_part or not faction_part then return "" end

    local titles = { fr = "Sous-classes", de = "Unterklassen", es = "Subclases", it = "Sottoclassi", pl = "Podklasy", en = "Subclasses" }
    local title_text = titles[lang] or titles["en"]

    -- Liste précise des champs requis de HeroSubClass
    local fields = "id, icon, activation_skill_1_sid, activation_skill_2_sid, activation_skill_3_sid, activation_skill_4_sid, activation_skill_5_sid"

    -- Requête sécurisée
    local sub_classes = mw.ext.cargo.query("HeroSubClass", fields, {
        where = string.format("faction = '%s' AND class_type = '%s'", faction_part, type_part),
        limit = 10
    })
    
    if not sub_classes or #sub_classes == 0 then 
        return "" 
    end

    local html = {}
    -- En-tête "Sous-classes" centré
    table.insert(html, string.format('<div style="font-weight:bold; text-align:center; margin-top:16px; margin-bottom:12px; font-size:1.3em; color:white;">%s</div>', title_text))

    for _, sub in ipairs(sub_classes) do
        local sub_id = sub.id
        
        local name_trans = sub_id
        local desc_trans = ""
        
        -- Récupération du nom et de la description de la sous-classe
        local trans_res = mw.ext.cargo.query("Translation", "name, description", {
            where = string.format("target_id = '%s' AND type = 'hero_sub_class' AND language = '%s'", sub_id, lang),
            limit = 1
        })
        
        if (not trans_res or #trans_res == 0) and lang ~= "en" then
            trans_res = mw.ext.cargo.query("Translation", "name, description", {
                where = string.format("target_id = '%s' AND type = 'hero_sub_class' AND language = 'en'", sub_id),
                limit = 1
            })
        end
        
        if trans_res and trans_res[1] then
            name_trans = trans_res[1].name or sub_id
            desc_trans = trans_res[1].description or ""
        end

        -- Cadre global de la sous-classe
        table.insert(html, '<div style="margin:12px 0; border:1px solid rgba(255,255,255,0.1); border-radius:8px; padding:12px; background: rgba(0,0,0,0.15);">')
        
        -- Titre (Nom de la sous-classe)
        table.insert(html, string.format('  <div style="text-align:center; font-weight:bold; font-size:1.15em; color:#ddd; margin-bottom:6px;">%s</div>', name_trans))
        
        -- Description de l'effet
        if desc_trans ~= "" then
            table.insert(html, string.format('  <div style="text-align:center; margin-bottom:12px; font-style:italic; color:#aaa; font-size:1em; padding: 0 20px;">%s</div>', desc_trans))
        end
        
        -- Chaîne pour accumuler les images sur UNE SEULE ligne de code sans saut de ligne
        local images_row = {}
        
        for i = 1, 5 do
            local skill_id = sub["activation_skill_" .. i .. "_sid"]
            
            if skill_id and skill_id ~= "" then
                local img_name = skill_ids_to_images[string.lower(mw.text.trim(skill_id))] or "Unknown"
                -- On encapsule chaque image individuellement en mode "inline-block" pour couper l'herbe sous le pied du parser MediaWiki
                table.insert(images_row, string.format('<div style="display:inline-block; margin: 0 6px;">[[File:Skill_%s.png|50px|link=%s%s]]</div>', img_name, img_name, suffix))
            end
        end
        
        -- Conteneur Flex qui force l'alignement horizontal au centre
        table.insert(html, '<div style="display:block; text-align:center; width:100%; margin-top:8px;">' .. table.concat(images_row, "") .. '</div>')
        
        -- Fermeture du cadre global
        table.insert(html, '</div>')
    end

    return table.concat(html, "\n")
end
return p