Module:MapObjectsData

From Heroes of Might and Magic: Olden Era Official Wiki


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: Script error: The function "get" does not exist.
{{#invoke:BuildingsData|get|field=narrative}}
  • Result: Script error: The function "get" does not exist.

Manual Mode

To fetch specific data regardless of the current page:

{{#invoke:BuildingsData|get|id=barracks_unfrozen_6|field=tier}}
  • Result: Script error: The function "get" does not exist.

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

function p.display(frame)
    local obj_id = "barracks_unfrozen_6" -- On force l'ID pour tester si ça marche
    
    -- On interroge Cargo sans filtrer les champs (en demandant tout)
    -- Si ça ne marche pas, on essaiera avec des noms de colonnes différents
    local data = mw.ext.cargo.query("MapObject", "id, category, tier, fraction, guard_units, goods_value", {
        where = "id = '" .. obj_id .. "'",
        limit = 1
    })
    
    if not data or #data == 0 then
        return "Erreur : Aucune donnée trouvée pour l'ID " .. obj_id .. ". La table MapObject est peut-être vide ou l'ID est incorrect."
    end
    
    -- On affiche le contenu brut reçu de Cargo pour voir la structure
    local output = "Contenu reçu : <pre>"
    for key, value in pairs(data[1]) do
        output = output .. key .. " = " .. tostring(value) .. "\n"
    end
    output = output .. "</pre>"
    
    return output
end

return p