Module:Items/ComparisonTables/Sandbox
Documentation for this module may be created at Module:Items/ComparisonTables/Sandbox/doc
local p = {}
local Shared = require('Module:Shared')
local GameData = require('Module:GameData')
local Common = require('Module:Common')
local Modifiers = require('Module:Modifiers')
local Icons = require('Module:Icons')
local Items = require('Module:Items')
local Num = require('Module:Number')
local Debug = require('Module:Debug')
local weaponTypes = {'Magic Staff', 'Magic Wand', 'Ranged Weapon', 'Weapon'}
local twoHandedWeaponID = '2hWeapons'
local function getAttackSpeed(item)
if item.equipmentStats ~= nil and item.equipmentStats['attackSpeed'] ~= nil then
return item.equipmentStats['attackSpeed'] or 4000
end
return 0
end
local function getSlotID(slot)
local slotID = Shared.getNamespacedID('melvorD', slot)
local slotData = GameData.getEntityByID('equipmentSlots', slotID)
if slotData == nil then
-- Special case for 2h weapons. Assume 1h weapons otherwise.
if slot == twoHandedWeaponID then
return 'melvorD:' .. twoHandedWeaponID
end
-- slotID invalid, check if user provided a slot name
slotData = GameData.getEntityByProperty('equipmentSlots', 'emptyName', slot)
if slotData == nil then
return nil
end
slotID = slotData.id
end
return slotID
end
local function getItems(slotID)
local _, slotLocalID = Shared.getLocalID(slotID)
local sortFunc = function(item)
-- Exclude the debug item
if item.id == 'melvorD:DEBUG_ITEM' then
return false
end
-- Exclude Golbin raid exclusives for now, such that they don't pollute various equipment tables
if item.golbinRaidExclusive ~= nil and item.golbinRaidExclusive then
return false
end
if not Shared.contains(item.validSlots, slotLocalID) or slotLocalID ~= twoHandedWeaponID then
return false
end
if slotLocalID == twoHandedWeaponID then
return Items._getItemStat(item, 'isTwoHanded')
end
if slotLocalID == 'Weapon' then --For quiver slot or weapon slot, 'other' is the ammo type
return other == item.ammoTypeRequired
elseif slotLocalID == 'Quiver' then
if other == 'Thrown' and Shared.contains({'Javelins', 'ThrowingKnives'}, item.ammoType) then
return true
else
return other == item.ammoType
end
end
return false
end
return Items.getItems(sortFunc)
end
--== Helper Functions for getCategoryTable ==--
local function createStatCell(row, statVal)
local cell = row:tag('td')
if statVal > 0 then
cell:addClass('table-positive')
elseif statVal < 0 then
cell:addClass('table-negative')
end
cell:css('text-align', 'right')
return cell
end
local function addStatCell(row, item, stat)
local statVal = 0
if item.equipmentStats ~= nil then
statVal = item.equipmentStats[stat] or 0
end
return createStatCell(row, statVal)
:wikitext(statVal)
end
local function addDRCell(row, item)
local dr = 0
local icon = nil
-- Grab damage reduction figure
if item.equipmentStats ~= nil then
if item.equipmentStats.damageReduction then
dr, icon = item.equipmentStats.damageReduction, 'Damage Reduction'
elseif item.equipmentStats.resistanceAbyssal then
dr, icon = item.equipmentStats.resistanceAbyssal, 'Abyssal Resistance'
elseif item.equipmentStats.resistanceEternal then
dr, icon = item.equipmentStats.resistanceEternal, 'Eternal Resistance'
end
end
local cell = createStatCell(row, dr)
-- Add DR icons, if there's any value
if dr ~= 0 then
cell:wikitext(Icons.Icon({icon, size=15, notext='true'}) .. ' ')
end
-- Add DR value
cell:wikitext(dr .. '%')
return cell
end
local function getRequirements(item)
if item.equipRequirements == nil then
return nil
end
local function getSkillName(skillID)
local _, localSkillID = GameData.getLocalID(skillID)
return localSkillID
end
local iconFuncs = {
['AbyssalLevel'] = function(x)
return Icons._SkillRealmIcon(getSkillName(x.skillID), 'melvorItA:Abyssal') .. ' ' .. x.level
end,
['SkillLevel'] = function(x)
return Icons._SkillRealmIcon(getSkillName(x.skillID)) .. ' ' .. x.level
end,
}
local reqs = {}
local abyssalSkills = {}
local highestLvReq = 0
-- Filter out all Abyssal Levels
for _, req in ipairs(item.equipRequirements) do
if req.type == 'AbyssalLevel' then abyssalSkills[req.skillID] = true end
end
-- If the req is a SkillLevel, but the skillID is already an AbyssalLevel, skip the entry
-- These are likely 99 Level requirements in addition to the AbyssalLevel requirement.
for _, req in ipairs(item.equipRequirements) do
if not (req.type == 'SkillLevel' and abyssalSkills[req.skillID] == true) then
-- Add requirement via factory function.
local func = iconFuncs[req.type]
if func then table.insert(reqs, func(req)) end
-- Track highest level for data sorting.
local lv = req.level or 0
if lv > highestLvReq then highestLvReq = lv end
end
end
if Shared.tableIsEmpty(abyssalSkills) == false then
highestLvReq = highestLvReq + 99
end
return {
['datasortvalue'] = highestLvReq,
['requirements'] = table.concat(reqs, '<br>')
}
end
function p._getCategoryTable(slot)
local iconSize = 20
local slotID = getSlotID(slot)
if slotID == nil then
return Shared.printError('Invalid slot ID: ' .. (slot or 'nil'))
end
-- Always sort by name.
local itemList = getItems(slotID)
table.sort(itemList, function(a, b) return a.name < b.name end)
local isWeapon = (slot == 'Weapon')
local itemColspan = 3
if isWeapon == true then itemColspan = 4 end
local html = mw.html.create('table')
:addClass('wikitable sortable stickyHeader')
:addClass('col-1-center col-3-center')
local header0 = html:tag('tr'):addClass('headerRow-0')
header0:tag('th'):attr('colspan', itemColspan)
header0:tag('th'):attr('colspan', 5)
:wikitext("Attack Bonus")
header0:tag('th'):attr('colspan', 3)
:wikitext("Strength Bonus")
header0:tag('th'):attr('colspan', 3)
:wikitext("Defence Bonus")
header0:tag('th'):wikitext("DR/AR")
local header1 = html:tag('tr'):addClass('headerRow-1')
header1:tag('th'):wikitext('Name')
:attr('colspan', 2)
header1:tag('th'):wikitext('DLC')
if isWeapon == true then
header1:tag('th'):wikitext('Attack<br>Speed')
end
-- Attack bonuses
header1:tag('th'):wikitext(Icons.Icon({'Attack', type='skill', size=iconSize, notext='true'}))
header1:tag('th'):wikitext(Icons.Icon({'Strength', type='skill', size=iconSize, notext='true'}))
header1:tag('th'):wikitext(Icons.Icon({'Defence', type='skill', size=iconSize, notext='true'}))
header1:tag('th'):wikitext(Icons.Icon({'Ranged', type='skill', size=iconSize, notext='true'}))
header1:tag('th'):wikitext(Icons.Icon({'Magic', type='skill', size=iconSize, notext='true'}))
--Strength bonuses
header1:tag('th'):wikitext(Icons.Icon({'Strength', type='skill', size=iconSize, notext='true'}))
header1:tag('th'):wikitext(Icons.Icon({'Ranged', type='skill', size=iconSize, notext='true'}))
header1:tag('th'):wikitext(Icons.Icon({'Magic', type='skill', size=iconSize, notext='true'}))
--Defence bonuses
header1:tag('th'):wikitext(Icons.Icon({'Strength', type='skill', size=iconSize, notext='true'}))
header1:tag('th'):wikitext(Icons.Icon({'Ranged', type='skill', size=iconSize, notext='true'}))
header1:tag('th'):wikitext(Icons.Icon({'Magic', type='skill', size=iconSize, notext='true'}))
-- Damage reduction
header1:tag('th'):wikitext(Icons.Icon({'Damage Reduction', size=iconSize, notext='true'}))
--Level requirements
header1:tag('th'):wikitext('Equip Req')
-- Fill the table with all items
for _, item in ipairs(itemList) do
local row = html:tag('tr')
row:tag('td'):wikitext(Icons.Icon({item.name, type='item', notext=true}))
:attr('data-sort-value', item.name)
row:tag('td'):wikitext(Icons.Icon({item.name, type='item', noicon=true}))
:attr('data-sort-value', item.name)
row:tag('td'):wikitext(Icons.getDLCColumnIcon(item.id))
:attr('data-sort-value', Icons.getExpansionID(item.id))
-- Add attack speed.
if isWeapon == true then
local atkSpeed = getAttackSpeed(item)
row:tag('td'):wikitext(Num.round(atkSpeed / 1000, 3, 1) .. 's')
:attr('data-sort-value', atkSpeed)
:css('text-align', 'right')
end
-- Attack bonuses
addStatCell(row, item, 'stabAttackBonus')
addStatCell(row, item, 'slashAttackBonus')
addStatCell(row, item, 'blockAttackBonus')
addStatCell(row, item, 'rangedAttackBonus')
addStatCell(row, item, 'magicAttackBonus')
-- Strength bonuses
addStatCell(row, item, 'meleeStrengthBonus')
addStatCell(row, item, 'rangedStrengthBonus')
addStatCell(row, item, 'magicDamageBonus'):wikitext('%')
-- Defence bonuses
addStatCell(row, item, 'meleeDefenceBonus')
addStatCell(row, item, 'rangedDefenceBonus')
addStatCell(row, item, 'magicDefenceBonus')
-- Add Damage Reduction / Abyssal Resistance
addDRCell(row, item)
-- TODO: Format requirements
local reqs = getRequirements(item)
if reqs == nil then
row:tag('td'):wikitext('None')
:attr('data-sort-value', 0)
else
row:tag('td'):wikitext(reqs.requirements)
:attr('data-sort-value', reqs.datasortvalue)
end
end
return tostring(html)
end
-- TODO:
--- Split 1h and 2h weapons
--- When the category is 'Weapon', include every wieldable items (incl knives, javs, etc)
function p.getCategoryTable(frame)
local slot = frame.args ~= nil and frame.args[1] or frame[1]
return p._getCategoryTable(slot)
end
return p