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

function p.get(frame)
    local args = frame.args
    local id = args["id"] or args[1]
    local field = args["field"] or args[2]
    local lang = args["language"] or "en"
    
    if not id or not field then return "Erreur : Paramètres 'id' et 'field' requis." end
    
    -- 1. Cas : Demande une donnée technique (colonnes de la table MapObject)
    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, field) then
        local data = getCargo("MapObject", field, "id = '" .. id .. "'")
        return data and data[field] or ""
    end
    
    -- 2. Cas : Demande une traduction (Nom, Description, Narrative)
    if field == "name" or field == "description" then
        local data = getCargo("Translation", field, string.format("target_id = '%s' AND type = 'map_object' AND language = '%s'", id, lang))
        return data and data[field] or ""
    end
    
    if field == "narrative" then
        local data = getCargo("Translation", "description", string.format("target_id = '%s' AND type = 'map_object_narrative' AND language = '%s'", id, lang))
        return data and data.description or ""
    end
    
    return "Erreur : Champ '" .. field .. "' inconnu."
end

return p