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

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 nil
end

function p.display(frame)
    local args = frame.args
    local input = args["id"] or args[1]
    local pagename = mw.title.getCurrentTitle().text
    local lang = args["language"] or mw.ustring.match(pagename, "/([a-z_]+)$") or "en"
    
    -- 1. Identification
    local obj_id = nil
    if input then
        local res = mw.ext.cargo.query("Translation", "target_id", {
            where = "type = 'map_object' AND language = 'en' AND name = '" .. input .. "'",
            limit = 1
        })
        if res and #res > 0 then obj_id = res[1].target_id else obj_id = input end
    else
        local baseName = mw.text.trim(mw.ustring.gsub(mw.ustring.gsub(pagename, "/.*", ""), "%s*%([^%)]*%)", ""))
        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 '<span style="color:red;">Erreur : Objet introuvable pour ce titre de page.</span>' end
    
    -- 2. Récupération
    local fields = "id,category,tier,fraction,guard_units,goods_value"
    local data = mw.ext.cargo.query("MapObject", fields, {
        where = string.format("id = '%s'", obj_id),
        limit = 1
    })
    
    if not data or #data == 0 then 
        return '<span style="color:red;">Erreur : Pas de ligne dans MapObject pour l\'ID : ' .. obj_id .. '</span>' 
    end
    
    local obj = data[1]
    
    -- 3. Fonction locale pour valider les données
    local function val(field_value, label)
        if field_value == nil or field_value == "" then
            return '<span style="color:orange;">' .. label .. ' manquant</span>'
        end
        return field_value
    end
    
    -- Construction
    local name = getTrans(obj_id, "map_object", lang, "name") or '<span style="color:red;">Nom manquant</span>'
    local desc = getTrans(obj_id, "map_object", lang, "description") or '<span style="color:red;">Description manquante</span>'
    
    local html = {'{| class="wikitable"'}
    table.insert(html, '! colspan=2 | ' .. name)
    table.insert(html, '|- | \'\'\'Description\'\'\' || ' .. desc)
    table.insert(html, '|- | \'\'\'Tier\'\'\' || ' .. val(obj.tier, "Tier"))
    table.insert(html, '|- | \'\'\'Fraction\'\'\' || ' .. val(obj.fraction, "Fraction"))
    table.insert(html, '|- | \'\'\'Guard Units\'\'\' || ' .. val(obj.guard_units, "Guard Units"))
    table.insert(html, '|- | \'\'\'Value\'\'\' || ' .. val(obj.goods_value, "Value"))
    table.insert(html, "|}")
    
    return table.concat(html, "\n")
end

return p