Editing Module:AnimalData/doc

From Eco - English Wiki

Your changes will be displayed to readers once an authorized user accepts them. (help)

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
== Documentation ==
This file is a Datafile that is used to Automate information throughout the Eco Wiki using various Modules.
{{Data file module}}
DO NOT Manually change Data as this is directly taken from the game.


The data file is currently used in at least the following modules:
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.
* [[Module:Infobox_Animal]]: see [[Template:Infobox Animal]] for more details.
* [[Module:Table Animals]]: see [[Template:Animals Table]] for more details.
* [[Module:Table Fish]]: see [[Template:Fish Table]] for more details.
 
== Usage ==
<syntaxhighlight lang="lua">
-- 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
</syntaxhighlight>
<includeonly>[[Category:Eco data files]]</includeonly>
Please note that all contributions to Eco - English Wiki are considered to be released under the CC BY-NC-SA 4.0 (see Eco:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following hCaptcha:

Cancel Editing help (opens in new window)