Module:Mods/doc

Mods retrieves and stores mod data of WARFRAME.

On this Wiki, Mods is used in:

• Template:ModBox
• Mod

Usage

Direct Invocation

{{#invoke:Mod|function|input1|input2|...}}

Template

In template: {{#invoke:Mods|function|input1|input2|...}}
In articles: {{template|function|input1|input2|...}}

Module

local Mod = require('Module:Mods')

local function func(input)
    return Mod.getMod(input)
end

Documentation

Package items

mods.getValue(modName, valName) (function)

Gets a specific piece of data about a mod formatted for display on wiki as wikitext.

Parameters:

• modName Mod name (string)
• valName Mod attribute to fetch (e.g. "Tradable") (string)

Returns: Mod data (table)

mods.buildModTableByRarity() (function)

Builds a mod table that sorts mods by rarity. Currently unused on articles due to sheer number of images needed to be loaded. May be useful for debugging purposes.

Returns: Mod table in wikitext (string)

mods.buildModTableByPolarity() (function)

Builds a mod table that sorts mods by polarity. Currently unused on articles due to sheer number of images needed to be loaded. May be useful for debugging purposes.

Returns: Mod table in wikitext (string)

mods.getModCount(rarity, polarity, transmutable) (function)

Gets the total mod count.

Parameters:

• rarity Mod rarity to filter by; defaults to 'All' (string; optional)
• polarity Mod polarity to filter by using full name of polarity (e.g. 'Madurai') or 'All; defaults to 'All' (string; optional)
• transmutable Mod transmutability to filter by; either 'true' or 'false', or 'All'; defaults to 'All' (string; optional)

Returns: Mod data (table)

mods.simpleModNameList() (function)

Builds a simple sorted list of all mod names in alphabetical order.

Returns: Mod names separated by breaks (string)

mods.transmutableModsList() (function)

Builds a list of transmutable mods.

Returns: Resultant wikitext of list (string)

---

Created with Docbunto