Module:AnimalData/doc

Documentation

This module is a data file that is used to automate information throughout the Eco Wiki using various Lua Modules.

The data file is currently used in at least the following modules:

• Module:Infobox_Animal: see Template:Infobox_Animal for more details.
• Module:List_Animals: see Template:AnimalList for more details.
• Module:List_Fish: see Template:FishList for more details.

If you would like to see more information generated on a data page request it on the Eco Contribution Wiki Discord.

To use this data (Lua table) in your module:‎

-- 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