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: Manoir boursouflé

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

• Result: À moitié immergé dans les émanations abyssales, ce manoir vibre de vie.

Manual Mode

To fetch specific data regardless of the current page:

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

• Result: 6

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 interroger Cargo
local function queryCargo(table, fields, where)
    local res = mw.ext.cargo.query(table, fields, { where = where, limit = 1 })
    return (res and #res > 0) and res[1] or nil
end

-- Fonction pour chercher l'ID (par ID ou nom anglais)
local function resolveId(input)
    if not input then return nil end
    local checkId = queryCargo("MapObject", "id", "id = '" .. input .. "'")
    if checkId then return input end
    local res = mw.ext.cargo.query("Translation", "target_id", {
        where = "type = 'map_object' AND language = 'en' AND name = '" .. input .. "'",
        limit = 1
    })
    return (res and #res > 0) and res[1].target_id or nil
end

-- Fonction utilitaire pour nettoyer le nom de la page
local function getObjId(pagename)
    local cleanName = 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 = '" .. cleanName .. "'",
        limit = 1
    })
    return (res and #res > 0) and res[1].target_id or nil
end

function p.get(frame)
    local args = frame.args
    local pagename = mw.title.getCurrentTitle().text
    local rawId = args["id"] or args[1]
    local id = resolveId(rawId) or getObjId(pagename)
    local lang = args["language"] or mw.ustring.match(pagename, "/([a-z_]+)$") or "en"
    -- On récupère le champ, et si c'est "faction", on le transforme en "fraction" pour la suite
    local field = args["field"] or args[2]
    local queryField = (field == "faction") and "fraction" or field
    
    if not id then return "Erreur : ID introuvable." end
    
    -- 1. Cas : Nom et Description
    if queryField == "name" or queryField == "description" then
        local res = queryCargo("Translation", queryField, string.format("target_id='%s' AND type='map_object' AND language='%s'", id, lang))
        return res and res[queryField] or ""
    end
    
    -- 2. Cas : Narration
    if queryField == "narrative" then
        local res = queryCargo("Translation", "description", string.format("target_id='%s' AND type='map_object_narrative' AND language='%s'", id, lang))
        return res and res.description or ""
    end
    
    -- 3. Cas : Traduction spéciale pour Faction (si field était "faction")
    if field == "faction" then
        local data = queryCargo("MapObject", "fraction", "id='" .. id .. "'")
        if not data then return "" end
        local res = queryCargo("Translation", "name", string.format("target_id='%s' AND type='faction' AND language='%s'", data.fraction, lang))
        return res and res.name or data.fraction
    end
    
    -- 4. Cas : Données techniques (on utilise queryField qui est soit le field normal, soit "fraction")
    local tech_fields = "category,goods_value,ai_value,custom_guard_value,view_radius,guard_units,fraction,tier,resource_name,resource_value,source_path"
    if string.find(tech_fields, queryField) then
        local res = queryCargo("MapObject", queryField, "id='" .. id .. "'")
        return res and res[queryField] or ""
    end
    
    return "Erreur : Champ '" .. field .. "' invalide."
end

return p