| [unchecked revision] | [checked revision] |
→Documentation: Improve documentation, add usage example, add to new category "Eco Data File". |
Tag: 2017 source edit |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{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 == | |||
<syntaxhighlight lang="lua"> | |||
-- Load data only once per page. (Do no use require()) | -- Load data only once per page. (Do no use require()) | ||
local AnimalData = mw.loadData("Module:AnimalData") | local AnimalData = mw.loadData("Module:AnimalData") | ||
| Line 27: | Line 21: | ||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
[[Category:Eco | <includeonly>[[Category:Eco data files]]</includeonly> | ||
Latest revision as of 09:31, 25 June 2024
ATTENTION! Data files are generated using game data and are not intended for manual editing.
The data file is currently used in at least the following modules:
- Module:Infobox_Animal: see Template:Infobox_Animal for more details.
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
