Module:AnimalData/doc: Difference between revisions

From Eco - English Wiki
[checked revision][checked revision]
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
== Documentation ==
{{DataModule}}
{{DataModule}}
The data file is currently used in at least the following modules:
* [[Module:Infobox_Animal]]: see [[Template:Infobox_Animal]] for more details.


== Usage ==
== Usage ==
Line 22: Line 18:
end
end
</syntaxhighlight>
</syntaxhighlight>
<includeonly>[[Category:Eco data files]]</includeonly>

Latest revision as of 11:45, 16 April 2026

Warning about use

[edit source]

To prevent multiple call of data array, you must use the function: local AnimalData = mw.loadData("Module:AnimalData/doc")

-- Load data only once per page. (Do no use require())
local AnimalData = mw.loadData("Module:AnimalData")

-- Assert that some data was received, otherwise throw an error.
assert(AnimalData.animals, "Failed to load data from Module:AnimalData!")

-- You may then use data from this module in your script. For example:
local agoutiData = AnimalData.animals["Agouti"]

-- Or to iterate over the table, you can do this:
for animalName, data in pairs(AnimalData.animals) do
	-- animalName now contains the name of the animal in English.
	-- data is the data table for that animal.
end