Module:AnimalData/doc: Difference between revisions

From Eco - English Wiki
[unchecked revision][checked revision]
No edit summary
Tag: 2017 source edit
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==Documentation==
{{DataModule}}
<big style="color:red;">'''DO NOT manually change this page!'''</big>


This file is a Datafile that is used to Automate information throughout the Eco Wiki using various Modules.
The data file is currently used in at least the following modules:
* [[Module:Infobox_Animal]]: see [[Template:Infobox_Animal]] for more details.


The Module:AnimalData is currently used in:
== Usage ==
[[Module:Infobox_Animal]], See [[Template:Infobox_Animal]] for more details.
<syntaxhighlight lang="lua">
-- Load data only once per page. (Do no use require())
local AnimalData = mw.loadData("Module:AnimalData")


If you would like to see more information generated on a Data page request it on the ECO Contribution Wiki Discord, https://discord.gg/ynCVtN5.
-- 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
</syntaxhighlight>
<includeonly>[[Category:Eco data files]]</includeonly>

Latest revision as of 09:31, 25 June 2024

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