Module:MapObjectsData

Description

The BuildingsData module provides a centralized interface to retrieve adventure map object data from the MapObject Cargo table and their localized strings from the Translation Cargo table.

It is designed to be "page-aware," meaning it can automatically identify the correct object ID and language based on the current page title (e.g., handling subpages and language suffixes).

Syntax

{{#invoke:BuildingsData|get|id=|field=|language=}}

Parameters

• id (optional): The unique object ID (e.g., barracks_unfrozen_6) or english building name (e.g., Bloated Mansion). If omitted, the module attempts to detect it from the current page title.
• field (required): The specific data field to retrieve.
• language (optional): The language code (e.g., fr, de). If omitted, the module attempts to detect it from the page title suffix (e.g., /fr).

Available Fields

Localization (from Translation table)

• name, description (using type map_object)
• narrative (using type map_object_narrative)

Technical (from MapObject table)

• category, goods_value, ai_value, custom_guard_value, view_radius, guard_units, fraction, tier, resource_name, resource_value, source_path

Examples

Automatic Mode

If you are currently viewing the page Bloated Mansion/fr, the module automatically identifies the object and the language:

{{#invoke:BuildingsData|get|field=name}}

• Result:

{{#invoke:BuildingsData|get|field=narrative}}

• Result:

Manual Mode

To fetch specific data regardless of the current page:

{{#invoke:BuildingsData|get|id=barracks_unfrozen_6|field=tier}}

• Result:

Technical Notes

• ID Detection: The module cleans the page title by removing subpages (text after /) and parenthetical text to match the entity name in the database.
• Fallback: If a name request returns no data, the system relies on the object's category field for identification.

---

local p = {}

-- 1. Fonction utilitaire pour récupérer des traductions (Translation)
local function getTrans(target_id, type, lang, field, variant, default)
    local query_where = string.format("target_id = '%s' AND type = '%s' AND language = '%s'", target_id, type, lang)
    if variant then query_where = query_where .. string.format(" AND variant = '%s'", variant) end
    
    local res = mw.ext.cargo.query("Translation", field, { where = query_where, limit = 1 })
    local result = (res and #res > 0) and res[1][field] or ""
    
    return (result ~= "") and result or (default or "")
end

-- 2. Création de la carte des liens (Nom -> ID)
local function getSkillLinkMap(lang)
    -- 1. On récupère les IDs valides depuis la table Skill
    local skillIdsRes = mw.ext.cargo.query('Skill', 'id', { 
        where = "variant = 'production'"
    })
    
    -- On crée une liste propre des IDs
    local validIds = {}
    for _, row in ipairs(skillIdsRes) do
        table.insert(validIds, "'" .. row.id .. "'")
    end
    local idList = table.concat(validIds, ",")
    
    -- 2. On récupère les traductions pour ces IDs seulement
    local results = mw.ext.cargo.query('Translation', 'target_id, name', {
        where = "type = 'skill' AND language = '" .. lang .. "' AND target_id IN (" .. idList .. ")",
        limit = 500
    })
    
    local map = {}
    for _, row in ipairs(results) do
        map[row.name] = row.target_id
    end
    return map
end

-- Fonction utilitaire pour échapper les caractères spéciaux des noms de skills
local function escapePattern(str)
    return str:gsub("([%^%$%(%)%%%.%[%]%*%+%-%?])", "%%%1")
end

-- Remplacement des noms de skills par des liens wiki
local function linkSkillsInText(text, lang, linkMap)
    if not text or text == "" then return "" end
    
    local sortedNames = {}
    for name, id in pairs(linkMap) do table.insert(sortedNames, name) end
    table.sort(sortedNames, function(a, b) return #a > #b end)
    
    for _, name in ipairs(sortedNames) do
        local id = linkMap[name]
        local replacement = "[[" .. id .. "/" .. lang .. "|" .. name .. "]]"
        
        -- On utilise notre fonction locale d'échappement à la place de mw.ustring.escapePattern
        local pattern = escapePattern(name)
        
        -- Remplacement global
        text = mw.ustring.gsub(text, pattern, replacement)
    end
    
    return text
end

-- 4. Fonction pour récupérer les infos d'un SubSkill
local function getSubSkillInfo(sub_id, lang, linkMap)
    local sub_def = mw.ext.cargo.query("SubSkill", "icon", { where = string.format("id = '%s'", sub_id), limit = 1 })
    local icon = (sub_def and #sub_def > 0) and sub_def[1].icon or "Placeholder"
    local name = getTrans(sub_id, "sub_skill", lang, "name")
    local desc = getTrans(sub_id, "sub_skill", lang, "description")
    
    -- Application des liens sur la description
    desc = linkSkillsInText(desc, lang, linkMap)
    return { name = name, desc = desc, icon = icon }
end

-- 5. Fonction principale d'affichage
function p.display(frame)
    local args = frame.args
    local skill_id = args["id"] or args[1]
    local lang = args["language"] or "en"
    
    if not skill_id then return "ID requis (utilisez |id=...)" end
    
    -- Préparation de la carte
    local linkMap = getSkillLinkMap(lang)
    
    local hSkill = getTrans("wiki_skills", "wiki", lang, "name", nil, "Skills")
    local hSub = getTrans("wiki_sub_skills", "wiki", lang, "name", nil, "Subskills")
    
    local levels = mw.ext.cargo.query("SkillLevel", "level, icon, offered_sub_skills", {
        where = string.format("skill_id = '%s'", skill_id),
        orderBy = "level ASC"
    })
    
    if not levels or #levels == 0 then return "Aucun niveau trouvé pour cet ID : " .. skill_id end
    
    local html = {'{| class="wikitable" style="width:100%; border-collapse:collapse;"'}
    table.insert(html, '! colspan=2 | ' .. hSkill .. ' !! colspan=6 | ' .. hSub)

    for _, lvl in ipairs(levels) do
        local name = getTrans(skill_id, "skill_level", lang, "name", lvl.level)
        local desc = getTrans(skill_id, "skill_level", lang, "description", lvl.level)
        desc = linkSkillsInText(desc, lang, linkMap)
        
        local icon = (lvl.icon and lvl.icon ~= "") and lvl.icon or "Placeholder"
        
        table.insert(html, '|- style="vertical-align:top;"')
        table.insert(html, '| style="width:70px; border-right:0px;" | [[File:' .. icon .. '.png|70px]]')
        table.insert(html, '| style="border-left:0px; width:200px;" | \'\'\'' .. name .. '\'\'\' <br /><br />' .. desc .. '')
        
        local subs = {}
        if lvl.offered_sub_skills then
            for s in string.gmatch(lvl.offered_sub_skills, "([^,]+)") do table.insert(subs, s) end
        end
        
        for i = 1, 3 do
            if subs[i] then
                local info = getSubSkillInfo(subs[i], lang, linkMap)
                table.insert(html, '| style="width:30px; border-right:0px; padding-left:10px;" | [[File:' .. info.icon .. '.png|30px]]')
                table.insert(html, '| style="width:180px; border-left:0px;" | \'\'\'' .. info.name .. '\'\'\'<br /><br />' .. info.desc .. '')
            else
                table.insert(html, '| colspan=2 style="border-left:1px solid #ccc;" | &nbsp;')
            end
        end
    end
    
    table.insert(html, "|}")
    
    return table.concat(html, "\n")
end
function p.debugMap(frame)
    local lang = frame.args["language"] or "en"
    local linkMap = getSkillLinkMap(lang)
    
    local output = {"=== Contenu de la LinkMap (" .. lang .. ") ==="}
    for name, id in pairs(linkMap) do
        table.insert(output, "* " .. name .. " -> " .. id)
    end
    return table.concat(output, "\n")
end
return p