| [checked revision] | [checked revision] |
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
== Documentation == | == Documentation == | ||
{{ | {{DataModule}} | ||
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. | ||
== Usage == | == Usage == | ||
Revision as of 10:31, 25 June 2024
Documentation
ATTENTION! Data files are generated using game data and are not intended for manual editing.
Warning about use
To prevent multiple call of data array, you must use the function: local AnimalData = mw.loadData("Module:AnimalData/doc")
The data file is currently used in at least the following modules:
- Module:Infobox_Animal: see Template:Infobox_Animal for more details.
Usage
-- 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