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

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

function p.display(frame)
    local args = frame.args
    -- On tente de récupérer un argument (id ou nom) en premier, sinon le titre de la page
    local input_identifier = args["id"] or args[1]
    local pagename = mw.title.getCurrentTitle().text
    
    -- 1. Détection de la langue
    local lang = args["language"] or mw.ustring.match(pagename, "/([a-z_]+)$") or "en"
    
    -- 2. Détermination de l'ID technique
    local obj_id = nil
    
    if input_identifier then
        -- Si un argument est passé, on vérifie s'il s'agit d'un ID technique ou d'un nom anglais
        -- On tente d'abord de chercher par nom anglais
        local res = mw.ext.cargo.query("Translation", "target_id", {
            where = "type = 'map_object' AND language = 'en' AND name = '" .. input_identifier .. "'",
            limit = 1
        })
        if res and #res > 0 then
            obj_id = res[1].target_id
        else
            -- Sinon, on considère que c'est déjà un ID technique
            obj_id = input_identifier
        end
    else
        -- Sinon, détection automatique via le titre de la page
        local baseName = mw.ustring.gsub(pagename, "/.*", "")
        baseName = mw.ustring.gsub(baseName, "%s*%([^%)]*%)", "")
        baseName = mw.text.trim(baseName)
        
        local res = mw.ext.cargo.query("Translation", "target_id", {
            where = "type = 'map_object' AND language = 'en' AND name = '" .. baseName .. "'",
            limit = 1
        })
        if res and #res > 0 then
            obj_id = res[1].target_id
        end
    end
    
    if not obj_id then return "Objet non trouvé (vérifiez le nom ou l'ID)." end
    
    -- 3. Récupération des données techniques
    local data = mw.ext.cargo.query("MapObject", "*", {
        where = string.format("id = '%s'", obj_id),
        limit = 1
    })
    
    if not data or #data == 0 then return "Données techniques introuvables pour l'ID : " .. obj_id end
    local obj = data[1]
    
    -- 4. Construction du tableau
    local name = getTrans(obj_id, "map_object", lang, "name")
    local desc = getTrans(obj_id, "map_object", lang, "description")
    
    local html = {'{| class="wikitable" style="width:100%;"'}
    table.insert(html, '! colspan=2 | ' .. name)
    table.insert(html, '|- | \'\'\'Description\'\'\' || ' .. desc)
    table.insert(html, '|- | \'\'\'Tier\'\'\' || ' .. (obj.tier or '-'))
    table.insert(html, '|- | \'\'\'Fraction\'\'\' || ' .. (obj.fraction or '-'))
    table.insert(html, '|- | \'\'\'Guard Units\'\'\' || ' .. (obj.guard_units or '-'))
    table.insert(html, '|- | \'\'\'Value\'\'\' || ' .. (obj.goods_value or '-'))
    table.insert(html, "|}")
    
    return table.concat(html, "\n")
end

return p