76561198256426587: 76561198256426587 moved page Module:BuildingsData/doc to Module:MapObjectsData/doc

2026-06-13T15:16:35Z

76561198256426587 moved page Module:BuildingsData/doc to Module:MapObjectsData/doc

← Older revision		Revision as of 15:16, 13 June 2026
(No difference)

76561198256426587: /* Parameters */

2026-06-13T14:52:46Z

Parameters

← Older revision		Revision as of 14:52, 13 June 2026
Line 11:		Line 11:

	== Parameters ==		== Parameters ==
	* <code>id</code> (optional): The unique object ID (e.g., <code>barracks_unfrozen_6</code>). If omitted, the module attempts to detect it from the current page title.		* <code>id</code> (optional): The unique object ID (e.g., <code>barracks_unfrozen_6</code>) or english building name (e.g., <code>Bloated Mansion</code>). If omitted, the module attempts to detect it from the current page title.
	* <code>field</code> (required): The specific data field to retrieve.		* <code>field</code> (required): The specific data field to retrieve.
	* <code>language</code> (optional): The language code (e.g., <code>fr</code>, <code>de</code>). If omitted, the module attempts to detect it from the page title suffix (e.g., <code>/fr</code>).		* <code>language</code> (optional): The language code (e.g., <code>fr</code>, <code>de</code>). If omitted, the module attempts to detect it from the page title suffix (e.g., <code>/fr</code>).

76561198256426587 at 09:48, 12 June 2026

2026-06-12T09:48:18Z

← Older revision		Revision as of 09:48, 12 June 2026
Line 1:		Line 1:
	<noinclude>		<noinclude>
	~~{{Documentation subpage}}~~
	</noinclude>		</noinclude>

76561198256426587: Created page with " {{Documentation subpage}} == 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 suff..."

2026-06-12T09:47:22Z

Created page with "<noinclude> {{Documentation subpage}} </noinclude> == Description == The '''BuildingsData''' module provides a centralized interface to retrieve adventure map object data from the <code>MapObject</code> Cargo table and their localized strings from the <code>Translation</code> 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 suff..."

New page

<noinclude>
{{Documentation subpage}}
</noinclude>

== Description ==
The '''BuildingsData''' module provides a centralized interface to retrieve adventure map object data from the <code>MapObject</code> Cargo table and their localized strings from the <code>Translation</code> 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 ==
<pre>{{#invoke:BuildingsData|get|id=|field=|language=}}</pre>

== Parameters ==
* <code>id</code> (optional): The unique object ID (e.g., <code>barracks_unfrozen_6</code>). If omitted, the module attempts to detect it from the current page title.
* <code>field</code> (required): The specific data field to retrieve.
* <code>language</code> (optional): The language code (e.g., <code>fr</code>, <code>de</code>). If omitted, the module attempts to detect it from the page title suffix (e.g., <code>/fr</code>).

== Available Fields ==
=== Localization (from Translation table) ===
* <code>name</code>, <code>description</code> (using type <code>map_object</code>)
* <code>narrative</code> (using type <code>map_object_narrative</code>)

=== Technical (from MapObject table) ===
* <code>category</code>, <code>goods_value</code>, <code>ai_value</code>, <code>custom_guard_value</code>, <code>view_radius</code>, <code>guard_units</code>, <code>fraction</code>, <code>tier</code>, <code>resource_name</code>, <code>resource_value</code>, <code>source_path</code>

== Examples ==

=== Automatic Mode ===
If you are currently viewing the page <code>Bloated Mansion/fr</code>, the module automatically identifies the object and the language:

<pre>{{#invoke:BuildingsData|get|field=name}}</pre>
*Result: {{#invoke:BuildingsData|get|id=barracks_unfrozen_6|field=name|language=fr}}

<pre>{{#invoke:BuildingsData|get|field=narrative}}</pre>
*Result: {{#invoke:BuildingsData|get|id=barracks_unfrozen_6|field=narrative|language=fr}}

=== Manual Mode ===
To fetch specific data regardless of the current page:

<pre>{{#invoke:BuildingsData|get|id=barracks_unfrozen_6|field=tier}}</pre>
*Result: {{#invoke:BuildingsData|get|id=barracks_unfrozen_6|field=tier}}

== Technical Notes ==
* '''ID Detection:''' The module cleans the page title by removing subpages (text after <code>/</code>) and parenthetical text to match the entity name in the database.
* '''Fallback:''' If a <code>name</code> request returns no data, the system relies on the object's <code>category</code> field for identification.

<includeonly>
[[Category:Lua modules]]
</includeonly>

Module:MapObjectsData/doc - Revision history

76561198256426587: 76561198256426587 moved page Module:BuildingsData/doc to Module:MapObjectsData/doc

76561198256426587: /* Parameters */

76561198256426587 at 09:48, 12 June 2026