Module:AnimalData/doc: Difference between revisions

From Eco - English Wiki
[unchecked revision][checked revision]
m (Remove category Eco Data File, provided by template.)
m (Add to category "Eco data files".)
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:


The data file is currently used in at least the following modules:
The data file is currently used in at least the following modules:
* [[Module:Infobox_Animal]]: see [[Template:Infobox_Animal]] for more details.
* [[Module:Infobox_Animal]]: see [[Template:Infobox Animal]] for more details.
* [[Module:List_Animals]]: see [[Template:AnimalList]] for more details.
* [[Module:Table Animals]]: see [[Template:Animals Table]] for more details.
* [[Module:List_Fish]]: see [[Template:FishList]] for more details.
* [[Module:Table Fish]]: see [[Template:Fish Table]] for more details.


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

Latest revision as of 12:43, 26 February 2022

Documentation[edit source]


This module is a data file that is used to automate information throughout the Eco Wiki using various Lua Modules. If you would like to see more information generated on a data page request it on the Eco Contribution Wiki Discord server.


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

Usage[edit source]

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