Module:Item table

Display a table of items queried from the weapons or equipment Cargo tables.

File tree

• Module:Item table: Root module
  • Module:Item table/doc: Documentation page for module
  • Module:Item table/common columns: Defines columns that apply to both equipment and weapon tables
  • Module:Item table/weapon columns: Defines the columns unique to weapon tables
  • Module:Item table/equipment columns: Defines the columns unique to equipment tables

Usage

table (required)

Specify which Cargo table you are querying from. This is either weapons or equipment. Weapon and equipment tables have their own set of columns (see below).

where (required)

The SQL where clause to select items from the specified table.

columns (optional)

A comma-separated list of columns for the output table. The available options depend on whether this is an equipment table or weapon table.

For weapons tables

Default value: name_fancy, enchantment, damage, damage_type, weight, price, special

Available columns:

• name: Simple, no-frills name.
• name_fancy: Name and icon with a rarity colour-coded frame.
• enchantment: The weapon's enchantment level (+1/+2/+3).
• properties: The basic weapon properties like one-handed, finesse, reach, etc.
• damage: Simple damage type display with colour-coded damage text, but no fancy templates.
• damage_type: Damage type display with colour-coded text. Meant to be paired with damage.
• damage_combined: A fancier damage display that combines the damage value and type into a single column.
• damage_fancy: Like damage_combined, except it also shows damage dice and the total damage range of the weapon.
• weight: The weight of the weapon in both kg and lb.
• price: The base cost of the weapon (i.e. before any vendor price modifiers).
• special: Special properties of the weapon such as passives or unique weapon actions.
• where_to_find: Location(s) where this weapon can be found.
• bugs: List any bugs associated with the weapon. For use on bug list pages.

For equipment tables

Default value: name_fancy, type, weight, price, special

Available columns:

• name: Simple, no-frills name.
• name_fancy: Name and icon with a rarity colour-coded frame.
• type: The type of item (e.g. ring, medium armour, cloak, etc.). This also lists the required armour proficiency if it is not obvious from the item type.
• enchantment: The weapon's enchantment level (+1/+2/+3).
• armour_class: The AC of the item. This can be the base AC of an armour or the bonus AC from an item like a shield or magic robes.
• stealth_disadvantage: Whether the item imposes disadvantage on stealth checks. This is only relevant for armours.
• weight: The weight of the weapon in both kg and lb.
• price: The base cost of the weapon (i.e. before any vendor price modifiers).
• special: Special properties of the weapon such as passives or unique weapon actions.
• where_to_find: Location(s) where this item can be found.
• bugs: List any bugs associated with the item. For use on bug list pages.

order by (optional)

Default value: rarity_order, name

Set the default sort order of the table. This is a comma separated list of Cargo field names. The user is free to sort the table using the arrows on each column.

default (optional)

Default value: "No items found."

Text to insert in place of an empty table if the query returns no results.

limit (optional)

Set the max size of the table. If it exceeds this number, it will add a "View more" link to paginate the table.

offset (optional)

Default value: 0

Skip the first n results of the query. This is usually used with limit.

Weapon examples

Default table format

Markup

{{#invoke: Item table | main
| table = weapons
| where = name = "Nyrulna" OR name = "Voss' Silver Sword"
}}

Renders as

Item	Ench.	Damage	Damage type	Weight	Price	Special
Voss' Silver Sword	+2	1d8 + 2 1d4	Slashing Psychic	1.35 kg 2.7 lb	630	Interplanar Slayer This weapon grants a +1d4 bonus to damage and Attack rolls against githyanki, aberrations, fiends, and elementals.  Wrathful Smite ( + ) Cast as a level 1 spell ( Recharge: Long rest.)
Nyrulna	+3	1d6 + 3 1d6	Piercing Thunder	1.8 kg 3.6 lb	840	Zephyr Connection This weapon will return to your hand when thrown. You cannot be forced to drop the trident. When thrown, the weapon creates an explosion that deals 3d4Thunder damage in a 6 m / 20 ft blast centered on the target. Veil of the Wind You gain a + 3 m / 10 ft bonus to movement speed and jump distance. Equipping this weapon gives you Immunity to falling damage.  Nyrulna: Glowing This object shines with a glowing light in a radius of 6 m / 20 ft.  Zephyr Flash () Rush forward, creating an air vortex that blasts foes and possibly inflicts  Bleeding. ( Recharge: Short rest.)  Zephyr Break () Zephyr Break imitates the effects of the spell  Gust of Wind while dealing thunder damage. ( Recharge: Short rest.)

Alternative table format

Markup

{{#invoke: Item table | main
| table = weapons
| where = name = "Nyrulna" OR name = "Voss' Silver Sword"
| columns = name_fancy, properties, enchantment, damage_combined, weight, price, special 
}}

Renders as

Item	Properties	Ench.	Damage	Weight	Price	Special
Voss' Silver Sword	Martial Versatile	+2	1d8 + 2Slashing + 1d4Psychic	1.35 kg 2.7 lb	630	Interplanar Slayer This weapon grants a +1d4 bonus to damage and Attack rolls against githyanki, aberrations, fiends, and elementals.  Wrathful Smite ( + ) Cast as a level 1 spell ( Recharge: Long rest.)
Nyrulna	Martial Versatile Thrown	+3	1d6 + 3Piercing + 1d6Thunder	1.8 kg 3.6 lb	840	Zephyr Connection This weapon will return to your hand when thrown. You cannot be forced to drop the trident. When thrown, the weapon creates an explosion that deals 3d4Thunder damage in a 6 m / 20 ft blast centered on the target. Veil of the Wind You gain a + 3 m / 10 ft bonus to movement speed and jump distance. Equipping this weapon gives you Immunity to falling damage.  Nyrulna: Glowing This object shines with a glowing light in a radius of 6 m / 20 ft.  Zephyr Flash () Rush forward, creating an air vortex that blasts foes and possibly inflicts  Bleeding. ( Recharge: Short rest.)  Zephyr Break () Zephyr Break imitates the effects of the spell  Gust of Wind while dealing thunder damage. ( Recharge: Short rest.)

Comparison of different damage column options

Markup

{{#invoke: Item table | main
| table = weapons
| where = name = "Nyrulna" OR name = "Voss' Silver Sword"
| columns = name_fancy, damage, damage_type, damage_combined, damage_fancy
}}

Renders as

Item	Damage	Damage type	Damage	Damage
Voss' Silver Sword	1d8 + 2 1d4	Slashing Psychic	1d8 + 2Slashing + 1d4Psychic	Damage: 4~14 1d8 + 2Slashing + 1d4Psychic
Nyrulna	1d6 + 3 1d6	Piercing Thunder	1d6 + 3Piercing + 1d6Thunder	Damage: 5~15 1d6 + 3Piercing + 1d6Thunder

Bug list example

Markup

{{#invoke: Item table | main
| table = weapons
| where = bugs IS NOT NULL AND (rarity = "legendary")
| columns = name_fancy, bugs
}}

Renders as

Item	Bugs
Bloodthirst	When looting Netherstone-Pomelled Bloodthirst from Orin's corpse, if opting to equip the dagger directly from Orin's corpse, the separation of the Netherstone and the Dagger still occurs without removing the Netherstone-Pomelled Bloodthirst from the player character's equipped item slot, granting two identical versions of the dagger.
Crimson Mischief	Prey Upon the Weak is non-functional in Honour mode. The Crimson Weapon passive also applies to attacks made with an off-hand hand crossbow.
Shar's Spear of Evening	Shar's Blessing adds its bonus damage to any weapon attacks against obscured creatures, not just attacks with this spear. The advantage to saving throws only applies to Dexterity, not all. Although not stated in the description, Blind Immunity also allows the wielder to see through magical darkness.

Equipment examples

Default table format

Markup

{{#invoke: Item table | main
| table = equipment
| where = rarity = "legendary" AND legacy IS NULL
}}

Renders as

Item	Type	Weight	Price	Special
Gloves of Soul Catching	Gloves	0.5 kg 1 lb	960	Constitution +2, up to 20. Soul Fist Your unarmed attacks deal an additional 1d10Force damage. Soul Catching Once per turn, on an unarmed hit, you regain 10hit points. Alternatively, you may forego healing to gain a +5 bonus on an Attack roll or Saving throw until the end of your next turn.[See: Bugs]
Helldusk Armour	Heavy Armour	20 kg 40 lb	8000	Fly () Cast as a level 3 spell ( Recharge: Long rest.) Helldusk Armour You are considered Proficient with this armour while wearing it. Infernal Retribution When you succeed a Saving throw, the caster receives  Burning (Orthonic) for 3 turns. Prime Aegis of Fire You have Resistance to Fire damage and cannot be  Burned. You take 3 less damage from all sources.
Helm of Balduran	Helmets (Medium Armour)	2 kg 4 lb	760	Attackers can't land Critical Hits on the wearer. Balduran's Vitality The helmet heals you 2hit points at the beginning of every turn. Balduran's Favour You have a +1 bonus to  Armour Class and Saving throws. Stun Immunity You can't be  Stunned.
Mask of the Shapeshifter	Helmets	0.5 kg 1 lb	1	Disguise Self () Cast as a level 1 spell at will.
Viconia's Walking Fortress	Shields	2.7 kg 5.4 lb	760	Bulwark Rebuke () When a foe hits you with a melee attack, deal it 2d4Force and possibly knock it  Prone.  Reflective Shell () A protective shell envelops you. It reflects any projectiles targeted at you back to their point of origin. ( Recharge: Short rest.)  Warding Bond () Cast as a level 2 spell ( Recharge: Long rest.) Spellguard You gain Advantage on Saving throws against spells. Spell Attack Rolls against you have Disadvantage.

Armour example

Markup

{{#invoke: Item table | main
| table = equipment
| where = type LIKE "%Armour" AND legacy IS NULL and rarity = "very rare"
| columns = name_fancy, armour_class, stealth_disadvantage, weight, price, special
}}

Renders as

Item	Armour Class	Stealth disadvantage	Weight	Price	Special
Adamantine Scale Mail	16	Yes	12 kg 24 lb	1300	Attackers can't land Critical Hits on the wearer. Magical Plate All incoming damage is reduced by 1 Adamantine Backlash When a melee attack hits you, the attacker is sent  Reeling for 2 turns.
Adamantine Splint Armour	18	Yes	19 kg 38 lb	3800	Attackers can't land Critical Hits on the wearer. Magical Plate All incoming damage is reduced by 2. Intense Adamantine Backlash When a melee attack hits you, the Attacker is sent  Reeling for 3 turns.
Armour of Agility	17	No	12 kg 24 lb	2900	Saving throws +2. Exotic Material Add your full Dexterity Modifier to your  Armour Class. Additionally, this armour does not impose Disadvantage on Stealth Ability Checks.
Armour of Landfall	13	No	4.5 kg 9 lb	1700	Advantage on Constitution Saving throws.  Plant Growth () Cast as a level 3 spell ( Recharge: Short rest.) High Spellcasting You gain a +1 bonus to Spell Save DC. Green Bed Regeneration When starting your turn on  Plant Growth or  Vines regain 1d4hit points hit points.
Armour of Moonbasking	11	No	4.5 kg 9 lb	1400	Lunar Bestial Vitality You gain 22 temporary hit points after casting  Wild Shape. While those temporary hit points are active reduce all incoming damage by 1. Lunar Bestial Fortitude You have a +2 bonus to  Armour Class. You also have Advantage on Saving throws against spells. This effect persists while using your druidic  Wild Shape ability.
Armour of Persistence	20	Yes	20 kg 40 lb	6400	Magical Plate All incoming damage is reduced by 2. Legendary Persistence You gain  Resistance and  Blade Ward.
Armour of the Sporekeeper	13	No	4.5 kg 9 lb	1050	Malefic Funghi The wearer gains a +1 bonus to Spell Save DC and when dealing Necrotic damage, they deal an additional 1Necrotic Damage. Spore Sacks While imbued with  Symbiotic Entity, you can spread  Bibberbang Spores,  Timmask Spores, and  Haste Spores.
Bhaalist Armour	14	No	5.85 kg 11.7 lb	2000	Aura of Murder Enemies within 3 m / 10 ft become Vulnerable to Piercing damage, unless they are Immune to it. Ambusher Gain a +2 bonus to  Initiative Rolls.
Blackguard's Plate	19	Yes	20 kg 40 lb	6400	Advantage on Wisdom Saving throws. Magical Plate All incoming damage is reduced by 1
Dark Justiciar Half-Plate (Very Rare)	17	No	12 kg 24 lb	2900	Advantage on Constitution Saving throws.  Shar's Aegis () Cast as a level 1 spell ( Recharge: Long rest.) Shar's Umbrae While obscured, the wearer has Advantage on Stealth Checks. Shar's Protection While the wearer has  Shield of Faith active, reduce all incoming damage by 2 and reflect damage received back at the attacker, who takes 1d4Necrotic.
Elegant Studded Leather	14	No	5.85 kg 11.7 lb	2000	Advantage on Stealth checks.  Shield () Cast as a level 1 spell ( Recharge: Short rest.) Ambusher Gain a +2 bonus to  Initiative Rolls.
Emblazoned Plate of the Marshal	19	Yes	20 kg 40 lb	6400	Fire Shield () Cast as a level 4 spell ( Recharge: Long rest.) Magical Plate All incoming damage is reduced by 2. Endurance by Fire You have Resistance to Fire damage and a +2 bonus to Saving throws.
Flame Enamelled Armour	16	Yes	12 kg 24 lb	2900	Fire Shield: Warm () Cast as a level 4 spell ( Recharge: Long rest.) Seldom Caught Unawares You gain a +2 bonus to  Initiative rolls. Endurance by Fire You have Resistance to Fire damage and a +2 bonus to Saving throws.
Reaper's Embrace	19	Yes	20 kg 40 lb	6400	Howl of the Dead () Cast as a cantrip ( Recharge: Short rest.) Magical Plate All incoming damage is reduced by 2.  Reaper's Rigidity When activated, you can't be moved against your will by any spell or action, but have Disadvantage on Dexterity Saving throws.
Sharpened Snare Cuirass	14	No	5.4 kg 10.8 lb	830	Exotic Material Add your full Dexterity Modifier to your  Armour Class. Additionally, this armour does not impose Disadvantage on Stealth Ability Checks. Sharpened Snare Creatures have Disadvantage on Saving throws when resisting your attacks and spells that inflict  Restrained.

An item set example

Markup

{{#invoke: Item table | main
| table = equipment
| where = name LIKE "%Bonespike%"
| columns = name_fancy, type, special
}}

Renders as

Item	Type	Special
Bonespike Boots	Boots	Brutal Leap ( + ) Leap at a target and possibly knock it  Prone. ( Recharge: Per turn.) Evasive Instinct You have a +1 bonus to  Armour Class and Saving throws as long as you are not wearing armour or holding a shield. Refined Vaulting  Jump distance is increased by 1.5 m / 5 ft.
Bonespike Garb	Clothing	Slabjaw Determination You gain 15 temporary hit points whenever you  Rage. Exoskeletal Endurance Reduce all incoming damage by 2. When the wearer is struck by a melee attack, the attacker takes Constitution modifierPiercing damage.
Bonespike Gloves	Gloves	Exoskeletal Reinforcement Your attacks ignore Resistance to Slashing, Piercing, and Bludgeoning damage.
Bonespike Helmet	Helmets	Intimidation +2  Menacing Attack (Melee) () Possibly  Frighten your target. They'll have Disadvantage on ability checks and Attack rolls and be unable to move. ( Recharge: Per turn.) Fury In The Marrow When you  Rage, hostile creatures in a 3 m / 10 ft radius must succeed a Weapon action DC  Wisdom saving throw or take 2d4Psychic damage. The targets receive half damage on a save.

Bug list example

Markup

{{#invoke: Item table | main
| table = equipment
| where = bugs IS NOT NULL AND (rarity = "legendary")
| columns = name_fancy, bugs
}}

Renders as

Item	Bugs
Gloves of Soul Catching	Soul Catching has numerous errors: It states it requires an "unarmed hit" while the  Grasp Essence condition states "hit a creature with an unarmed attack". Functionally, any damaging unarmed attack triggers the effect, even against world items. It states the wielder regains 10hit points, but instead it grants an ability which, when used, provides the healing. It states the wielder may gain Advantage on Attack Rolls and Saving Throws until the end of their next turn, while the Grasp Essence condition states the wielder may gain Advantage on Attack Rolls or Saving Throws before the end of their next turn. Advantage is not actually gained, but rather an Interrupt is granted that provides the wielder with a choice of either adding a +5 bonus to a single attack roll or to a single saving throw, at which time the Grasp Essence condition is removed. Due to a coding error, Grasp Essence is removed from the wielder if they take damage and do not have any temporary HP.
Helldusk Armour	As stated above, this item does not have a Proficiency Group (in order for all classes to be 'proficient' with it). However, as a result, items such as Bracers of Defence, Bonespike Boots, and Corellon's Grace that are not supposed to give their bonuses while wearing armour still provide their benefits with the Helldusk Armour equipped. The extra movement speed granted to monks by  Unarmoured Movement is also not lost when wearing this armour. The  Defence fighting style can grant up to +2 AC when used with this armour. For the same reason as above, Defence does not normally work with the Helldusk Armour as it is not considered armour proper. To work around this, the armour has a hidden passive that grants +1 AC if the wearer has Defence. While this property is not a bug, if the wearer also has another piece of armour equipped (e.g. a helmet), the normal +1 AC from Defence is additionally applied for a total of +2 AC, and this likely is a bug.
Helm of Balduran	Stun Immunity does not protect against  Stunning Gaze (as cast by the Bhaal cultists) but does protect against  Mind Blast,  Stunning Strike (Melee) and  Stunning Strike (Unarmed).

Item location example

Markup

{{#invoke: Item table | main
| table = equipment
| where = name = "Amulet of Restoration"
| columns = name_fancy, where_to_find
}}

Renders as

Item	Where to find
Amulet of Restoration	The Counting HouseX: -85 Y: -185: In a chest titled 'Private Stash', in the eastern room down the very first flight of stairs Ebonlake GrottoX: -55 Y: -93: Sold by Derryth Bonecloak in the Underdark

Source code

---

local p = {}

-- Strip leading/trailing whitespace
local function strip(s)
	return string.match(s, "^%s*(.-)%s*$")
end

-- Prepare the HTML element for the table ready to be filled with rows
local function prepare_table(columns, table_data)
	local table_outer = mw.html.create("table")
		:addClass("wikitable")
		:addClass("sortable")
	local table_header = table_outer:tag("tr")
	for _, column in ipairs(columns) do
		local column_name = table_data.columns[column].name
		table_header:tag("th"):wikitext(column_name)
	end
	return table_outer
end

-- Produce the comma separated list of the cargo fields that need to be queried to
-- fill out the specified columns. This is passed into the query function.
local function field_string(columns, table_data)
	local query_fields = {}
	-- Produce a set from potentially overlapping lists of cargo fields
	for _, column_name in ipairs(columns) do
		local column = table_data.columns[column_name]
		for _, field in ipairs(column.cargo_fields) do
			query_fields[field] = true
		end
	end
	local query_str = {}
	for field, _ in pairs(query_fields) do
		table.insert(query_str, field) 
	end
	return table.concat(query_str, ', ')	
end

function p.main(frame)
	local args = frame.args

	local table_definitions = nil
	if args["table"] == "weapons" then
		table_definitions = require("Module:Item table/weapon columns")
	elseif args["table"] == "equipment" then
		table_definitions = require("Module:Item table/equipment columns")
	else
		mw.addWarning("Invalid table specified. Expected 'weapons' or 'equipment'.")
		return ""
	end

	-- Use either user-defined set of columns (specified as a comma-separated list)
	-- or the default set of columns defined for that type of table.
	local columns = {}
	for column in string.gmatch(args.columns or "", "[^,]+") do
		column = strip(column)
		if table_definitions.columns[column] then
			table.insert(columns, column)
		else
			mw.addWarning(string.format("Unknown column %s; skipping", column))
		end
	end
	if #columns == 0 then
		columns = table_definitions.default
	end
	
	-- Arguments passed into the mw.ext.cargo.query function.
	-- They have a different name convention (camelcase vs lowercase with spaces)
	local query_args = {
		where = args["where"],
		limit = args["limit"],
		offset = args["offset"],
		orderBy = args["order by"] or "rarity_order, name"
	}
	
	local results = mw.ext.cargo.query(
		args["table"],
		field_string(columns, table_definitions),
		query_args
	)
	
	if #results > 0 then
		local output_table = prepare_table(columns, table_definitions)
		for _, item in ipairs(results) do
			local row = output_table:tag('tr')
			for _, column_name in ipairs(columns) do
				local column = table_definitions.columns[column_name]
				row:node(column.formatter(item))
			end
		end
		return output_table
	else
		return args["default"] or "<div><i>No items found.</i></div>"
	end
end

return p