Module:List/doc

From Outward Wiki
Jump to navigation Jump to search

This is the documentation page for Module:List

Template-info.png Documentation

Module used to list Items.

Arguments

There are three different functions you can invoke with this module. All can use the main arguments:

Filter arguments:

  • category - either "Item", "Equipment", "Armor", "Weapon" or "Consumable". Defaults to "Item".
  • class - the class of the Item, valid for Equipment, Armor and Weapons.
  • type - the type of the item, valid for Weapons.
  • set - the item set

Output control arguments:

  • default - if true, will show default text when no results are found, otherwise will show nothing.
  • showClass - if true it will show the class as a column in the table, defaults to false
  • showDurability - if true it will show durability as a column in the table, defaults to true

Main function

The function items will return a list of all items which match the provided filter.

It has no extra arguments other than the main arguments.

  • Example: {{#invoke:List|items|category=Weapon|class=Axe|type=One-Handed}}

Manual function

The function manual will list a manually supplied list of items through the argument itemsToList.

  • Example: {{#invoke:List|manual|category=Weapon|itemsToList=Iron Sword,Tsar Axe,Lexicon}}

Element function

The function element will list all items which have damage, damage bonus or damage resistance for the provided element argument.

  • Example: {{#invoke:List|element|element=Fire}}

Test

{{#invoke:List|items|category=Armor|set=Tsar Set}}

IconNameResistancesImpact.pngProtectionHotWeather.pngStamina CostMana CostMovementDurabilityWeight
Tsar Armor.pngTsar Armor28% Physical
40% Fire
23% Impact.pngProtection10 HotWeather.png6% Stamina Cost-11% Movement23.0
Tsar Boots.pngTsar Boots20% Physical
20% Fire
13% Impact.pngProtectionHotWeather.png4% Stamina Cost-9% Movement17.0
Tsar Helm.pngTsar Helm20% Physical
20% Fire
13% Impact.pngProtectionHotWeather.png4% Stamina Cost15% Mana Cost-9% Movement13.0

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.