Module:Items/ComparisonTables: Difference between revisions
From Melvor Idle
m (Fix for Bob's Rake) |
(Update for v0.21) |
||
Line 31: | Line 31: | ||
if(Shared.tableCount(itemList) == 0) then | if(Shared.tableCount(itemList) == 0) then | ||
return 'ERROR: you must select at least one item to get stats for' | return 'ERROR: you must select at least one item to get stats for[[Category:Pages with script errors]]' | ||
end | end | ||
local isWeaponType = Shared.contains(weaponTypes, itemList[1].type) | local isWeaponType = itemList[1].validSlots ~= nil and Shared.contains(itemList[1].validSlots, 'Weapon') and Shared.contains(weaponTypes, itemList[1].type) | ||
--Now that we have a preliminary list, let's figure out which columns are irrelevant (IE are zero for all items in the selection) | --Now that we have a preliminary list, let's figure out which columns are irrelevant (IE are zero for all items in the selection) | ||
Line 67: | Line 67: | ||
end | end | ||
end | end | ||
--Alright, let's start the table by building the shared header | --Alright, let's start the table by building the shared header | ||
local result = '{| class="wikitable sortable stickyHeader"\r\n|-class="headerRow-0"' | local result = '{| class="wikitable sortable stickyHeader"\r\n|-class="headerRow-0"' | ||
Line 174: | Line 174: | ||
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|Sources' | result = result..'\r\n!style="padding:0 1em 0 0.5em;"|Sources' | ||
local getStatValue = function(item, statName, equipStats, levelReqs) | |||
if string.find(statName, '^(.+)LevelRequired$') ~= nil then | |||
-- Level requirement | |||
local skillName = Shared.titleCase(string.match(statName, '^(.+)LevelRequired$')) | |||
return levelReqs[skillName] or 0 | |||
elseif Shared.contains(ItemData.EquipmentStatKeys, statName) then | |||
-- Equipment stat | |||
return equipStats[statName] or 0 | |||
else | |||
-- Something else that we'll assume _getItemStat() will handle | |||
return Items._getItemStat(item, statName, true) | |||
end | |||
end | |||
table.sort(itemList, function(a, b) return a.id < b.id end) | table.sort(itemList, function(a, b) return a.id < b.id end) | ||
for i, item in pairs(itemList) do | for i, item in pairs(itemList) do | ||
local equipStats = Items._processEquipmentStats(item.equipmentStats) | |||
local levelReqs = Items._processEquipmentLevelReqs(item.equipRequirements) | |||
if isWeaponType then | if isWeaponType then | ||
--Building rows for weapons | --Building rows for weapons | ||
Line 181: | Line 196: | ||
result = result..'\r\n|style ="text-align: left;padding: 0 0 0 0;"|'..Icons.Icon({item.name, type='item', size=50, notext=true}) | result = result..'\r\n|style ="text-align: left;padding: 0 0 0 0;"|'..Icons.Icon({item.name, type='item', size=50, notext=true}) | ||
result = result..'\r\n|style ="text-align: left;padding: 0 0.5em 0 0.5em;"|[['..item.name..']]' | result = result..'\r\n|style ="text-align: left;padding: 0 0.5em 0 0.5em;"|[['..item.name..']]' | ||
result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0;" |'..Shared.formatnum( | result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0;" |'..Shared.formatnum(equipStats.attackSpeed) | ||
--That's the first list out of the way, now for 2-Handed | --That's the first list out of the way, now for 2-Handed | ||
result = result..'\r\n| style ="text-align: right;"|' | result = result..'\r\n| style ="text-align: right;"|' | ||
if item | if Items._getItemStat(item, 'isTwoHanded') then result = result..'Yes' else result = result..'No' end | ||
for j, statName in pairs(statColumns) do | for j, statName in pairs(statColumns) do | ||
local statValue = | local statValue = getStatValue(item, statName, equipStats, levelReqs) | ||
result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0;' | result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0;' | ||
if | if string.find(StatName, '^(.+)LevelRequired$') == nil then | ||
if statValue > 0 then | if statValue > 0 then | ||
result = result..'background-color:lightgreen;' | result = result..'background-color:lightgreen;' | ||
Line 217: | Line 232: | ||
result = result..'\r\n|style ="text-align: left;padding: 0 0.5em 0 0.5em;"|[['..item.name..']]' | result = result..'\r\n|style ="text-align: left;padding: 0 0.5em 0 0.5em;"|[['..item.name..']]' | ||
for j, statName in pairs(statColumns) do | for j, statName in pairs(statColumns) do | ||
local statValue = | local statValue = getStatValue(item, statName, equipStats, levelReqs) | ||
result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0;' | result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0;' | ||
if statValue > 0 then | if statValue > 0 then | ||
Line 251: | Line 266: | ||
local type = args.type | local type = args.type | ||
local tier = args.tier | local tier = args.tier | ||
local | local slot = args.slot | ||
local ammoTypeStr = args.ammoType | local ammoTypeStr = args.ammoType | ||
local category = args.category ~= nil and args.category or 'Combat' | local category = args.category ~= nil and args.category or 'Combat' | ||
Line 269: | Line 284: | ||
end | end | ||
local isWeaponType = Shared.contains(weaponTypes, type) | local isWeaponType = Shared.contains(weaponTypes, type) | ||
Line 288: | Line 297: | ||
else | else | ||
--Now for handling armour | --Now for handling armour | ||
local levelReqs = Items._processEquipmentLevelReqs(item.equipRequirements) | |||
if type == "Armour" or type == "Melee" then | if type == "Armour" or type == "Melee" then | ||
listItem = | listItem = levelReqs['Defence'] ~= nil or (item.category == 'Combat' and item.type == 'Armour') | ||
elseif type == "Ranged Armour" or type == "Ranged" then | elseif type == "Ranged Armour" or type == "Ranged" then | ||
listItem = | listItem = levelReqs['Ranged'] ~= nil or (item.category == 'Combat' and item.type == 'Ranged Armour') | ||
elseif type == "Magic Armour" or type == "Magic" then | elseif type == "Magic Armour" or type == "Magic" then | ||
listItem = | listItem = levelReqs['Magic'] or (item.category == 'Combat' and item.type == 'Magic Armour') | ||
else | else | ||
listItem = item.type == type and item.category ~= 'Combat' | listItem = item.type == type and item.category ~= 'Combat' | ||
end | end | ||
if ammoType ~= nil then listItem = listItem and item.ammoType == ammoType end | if ammoType ~= nil then listItem = listItem and item.ammoType == ammoType end | ||
if slot ~= nil then listItem = listItem and item. | if slot ~= nil then listItem = listItem and Shared.contains(item.validSlots, slot) end | ||
end | end | ||
if listItem then | if listItem then | ||
Line 309: | Line 319: | ||
function p._getCategoryTable(style, slot, other, includeModifiers, includeDescription) | function p._getCategoryTable(style, slot, other, includeModifiers, includeDescription) | ||
if type(slot) == ' | if type(slot) == 'number' then | ||
slot = Constants. | slot = Constants.getEquipmentSlotName(slot) | ||
end | end | ||
local itemList = Items.getItems(function(item) | local itemList = Items.getItems(function(item) | ||
local isMatch = true | local isMatch = true | ||
local levelReqs = Items._processEquipmentLevelReqs(item.equipRequirements) | |||
if style == 'Melee' then | if style == 'Melee' then | ||
if ( | if (levelReqs['Defence'] == nil and levelReqs['Attack'] == nil) and not Shared.contains(styleOverrides.Melee, item.name) then isMatch = false end | ||
elseif style == 'Ranged' then | elseif style == 'Ranged' then | ||
if | if levelReqs['Ranged'] == nil and not Shared.contains(styleOverrides.Ranged, item.name) then isMatch = false end | ||
elseif style == 'Magic' then | elseif style == 'Magic' then | ||
if | if levelReqs['Magic'] == nil and not Shared.contains(styleOverrides.Magic, item.name) then isMatch = false end | ||
elseif style == 'None' then | elseif style == 'None' then | ||
if ( | if (levelReqs['Defence'] ~= nil or levelReqs['Ranged'] ~= nil or levelReqs['Magic'] ~= nil or | ||
Shared.contains(styleOverrides.Melee, item.name) or Shared.contains(styleOverrides.Ranged, item.name) or Shared.contains(styleOverrides.Magic, item.name)) and | Shared.contains(styleOverrides.Melee, item.name) or Shared.contains(styleOverrides.Ranged, item.name) or Shared.contains(styleOverrides.Magic, item.name)) and | ||
not Shared.contains(styleOverrides.None, item.name) then | not Shared.contains(styleOverrides.None, item.name) then | ||
Line 328: | Line 339: | ||
end | end | ||
end | end | ||
if slot == nil or not Shared.contains(item.validSlots, slot) then isMatch = false end | |||
if slot == nil or | |||
if isMatch and other ~= nil then | if isMatch and other ~= nil then | ||
if slot == | if slot == 'Weapon' then --For quiver slot or weapon slot, 'other' is the ammo type | ||
if other == 'Arrows' then | if other == 'Arrows' then | ||
if item.ammoTypeRequired ~= 0 then isMatch = false end | if item.ammoTypeRequired ~= 0 then isMatch = false end | ||
Line 338: | Line 348: | ||
if item.ammoTypeRequired ~= 1 then isMatch = false end | if item.ammoTypeRequired ~= 1 then isMatch = false end | ||
end | end | ||
elseif slot == | elseif slot == 'Quiver' then | ||
if other == 'Arrows' then | if other == 'Arrows' then | ||
if item.ammoType ~= 0 then isMatch = false end | if item.ammoType ~= 0 then isMatch = false end | ||
Line 380: | Line 390: | ||
local itemList = {} | local itemList = {} | ||
local errMsg = 'ERROR: Some items not found in database: ' | local errMsg = 'ERROR: Some items not found in database: [[Category:Pages with script errors]]' | ||
local hasErr = false | local hasErr = false | ||
for i, name in Shared.skpairs(itemNames) do | for i, name in Shared.skpairs(itemNames) do | ||
Line 400: | Line 410: | ||
function p.getDoubleLootTable(frame) | function p.getDoubleLootTable(frame) | ||
local itemList = Items.getItems(function(item) | local modsDL = { | ||
'increasedChanceToDoubleLootCombat', | |||
'decreasedChanceToDoubleLootCombat', | |||
'increasedChanceToDoubleLootThieving', | |||
'decreasedChanceToDoubleLootThieving', | |||
'increasedChanceToDoubleItemsGlobal', | |||
'decreasedChanceToDoubleItemsGlobal' | |||
} | |||
local modDetail = {} | |||
for i, modName in pairs(modsDL) do | |||
local mName, mText, mSign, mIsNeg, mValUnsigned = Constants.getModifierDetails(modName) | |||
modDetail[modName] = { mult = (mSign == "+" and 1 or -1) } | |||
end | |||
local itemList = Items.getItems(function(item) | |||
if item.modifiers ~= nil then | |||
for modName, val in pairs(item.modifiers) do | |||
if Shared.contains(modsDL, modName) then return true end | |||
end | |||
return false | |||
end | |||
end) | |||
table.sort(itemList, function(a, b) return a.id < b.id end) | table.sort(itemList, function(a, b) return a.id < b.id end) | ||
local result = '{| class="wikitable sortable stickyHeader"\r\n|-class="headerRow-0"' | local result = '{| class="wikitable sortable stickyHeader"\r\n|-class="headerRow-0"' | ||
result = result..'\r\n!colspan="2"|Name!!Bonus!!Description!!Sources' | result = result..'\r\n!colspan="2"|Name!!Bonus!!Description!!Sources' | ||
for i, item in Shared.skpairs(itemList) do | for i, item in Shared.skpairs(itemList) do | ||
local lootValue = 0 | |||
for modName, modDet in pairs(modDetail) do | |||
lootValue = lootValue + (item.modifiers[modName] or 0) * modDet.mult | |||
end | |||
result = result..'\r\n|-' | result = result..'\r\n|-' | ||
result = result..'\r\n|data-sort-value="'..item.name..'"|'..Icons.Icon({item.name, type='item', size=50, notext=true}) | result = result..'\r\n|data-sort-value="'..item.name..'"|'..Icons.Icon({item.name, type='item', size=50, notext=true}) | ||
result = result..'||[['..item.name..']]' | result = result..'||[['..item.name..']]' | ||
result = result..'||style ="text-align: right;" data-sort-value="'.. | result = result..'||style ="text-align: right;" data-sort-value="'..lootValue..'"|'..lootValue..'%' | ||
result = result..'||'..item.description | result = result..'||'..item.description | ||
result = result..'\r\n| style ="text-align: right;white-space: nowrap;padding: 0 0.5em 0 0.5em;" |' | result = result..'\r\n| style ="text-align: right;white-space: nowrap;padding: 0 0.5em 0 0.5em;" |' | ||
Line 424: | Line 459: | ||
if rowCount == nil then rowCount = 200 end | if rowCount == nil then rowCount = 200 end | ||
if type(rowCount) == 'string' then rowCount = tonumber(rowCount) end | if type(rowCount) == 'string' then rowCount = tonumber(rowCount) end | ||
local rowResult = {} | local rowResult = {} | ||
for i = startID, startID + rowCount - 1, 1 do | for i = startID, startID + rowCount - 1, 1 do | ||
Line 455: | Line 490: | ||
--Unfortunately just gonna have to manually check all the changes I think... | --Unfortunately just gonna have to manually check all the changes I think... | ||
local itemStats = { | |||
{ Stat = Items._processEquipmentStats(item1.equipmentStats), Level = Items._processEquipmentLevelReqs(item1.equipRequirements), SlayBon = Items._getItemModifier(item1, 'increasedSkillXP', 'Slayer') }, | |||
{ Stat = Items._processEquipmentStats(item2.equipmentStats), Level = Items._processEquipmentLevelReqs(item2.equipRequirements), SlayBon = Items._getItemModifier(item2, 'increasedSkillXP', 'Slayer') }, | |||
} | |||
local attBon1 = item1.attackBonus ~= nil and item1.attackBonus or {0, 0, 0} | local attBon1 = item1.attackBonus ~= nil and item1.attackBonus or {0, 0, 0} | ||
local attBon2 = item2.attackBonus ~= nil and item2.attackBonus or {0, 0, 0} | local attBon2 = item2.attackBonus ~= nil and item2.attackBonus or {0, 0, 0} | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Stat']['stabAttackBonus'], itemStats[2]['Stat']['stabAttackBonus'], '{V} '..Icons.Icon({'Melee', notext=true})..' Stab Bonus') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Stat']['slashAttackBonus'], itemStats[2]['Stat']['slashAttackBonus'], '{V} '..Icons.Icon({'Melee', notext=true})..' Slash Bonus') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Stat']['blockAttackBonus'], itemStats[2]['Stat']['blockAttackBonus'], '{V} '..Icons.Icon({'Melee', notext=true})..' Block Bonus') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Stat']['meleeStrengthBonus'], itemStats[2]['Stat']['meleeStrengthBonus'], '{V} '..Icons.Icon({'Strength', type='skill', notext=true})..' Strength Bonus') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Stat']['rangedStrengthBonus'], itemStats[2]['Stat']['rangedStrengthBonus'], '{V} '..Icons.Icon({'Ranged', type='skill', notext=true})..' Strength Bonus') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Stat']['magicStrengthBonus'], itemStats[2]['Stat']['magicStrengthBonus'], '{V}% '..Icons.Icon({'Magic', type='skill', notext=true})..' Damage Bonus') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Stat']['meleeDefenceBonus'], itemStats[2]['Stat']['meleeDefenceBonus'], '{V} '..Icons.Icon({'Defence', type='skill', notext=true})..' Defence Bonus') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Stat']['rangedDefenceBonus'], itemStats[2]['Stat']['rangeDefenceBonus'], '{V} '..Icons.Icon({'Ranged', type='skill', notext=true})..' Defence Bonus') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Stat']['magicDefenceBonus'], itemStats[2]['Stat']['magicDefenceBonus'], '{V} '..Icons.Icon({'Magic', type='skill', notext=true})..' Defence Bonus') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Stat']['damageReduction'], itemStats[2]['Stat']['damageReduction'], '{V}% Damage Reduction') | ||
getSpecificStatString(itemStats[1]['SlayBon'], itemStats[2]['SlayBon'], '{V}% '..Icons.Icon({'Slayer', type='skill', notext=true})..' Bonus XP') | |||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Level']['Attack'], itemStats[2]['Level']['Attack'], '{V} '..Icons.Icon({'Attack', type='skill', notext=true})..' Level Required') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Level']['Defence'], itemStats[2]['Level']['Defence'], '{V} '..Icons.Icon({'Defence', type='skill', notext=true})..' Level Required') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Level']['Ranged'], itemStats[2]['Level']['Ranged'], '{V} '..Icons.Icon({'Ranged', type='skill', notext=true})..' Level Required') | ||
getSpecificStatString( | getSpecificStatString(itemStats[1]['Level']['Magic'], itemStats[2]['Level']['Magic'], '{V} '..Icons.Icon({'Magic', type='skill', notext=true})..' Level Required') | ||
return table.concat(changeArray, '<br/>') | return table.concat(changeArray, '<br/>') | ||
Line 490: | Line 527: | ||
itemArray = Items.getItems(function(item) return Shared.contains(item.name, 'Potion') and item.itemsRequired ~= nil end) | itemArray = Items.getItems(function(item) return Shared.contains(item.name, 'Potion') and item.itemsRequired ~= nil end) | ||
elseif string.upper(category) == 'OTHER' then | elseif string.upper(category) == 'OTHER' then | ||
itemArray = Items.getItems(function(item) | itemArray = Items.getItems(function(item) | ||
return not Shared.contains(item.name, 'Potion') and item.itemsRequired ~= nil and item. | return not Shared.contains(item.name, 'Potion') and item.itemsRequired ~= nil and item.validSlots == nil | ||
end) | end) | ||
else | else | ||
if Constants.getEquipmentSlotID(category) == nil then | |||
return 'ERROR: Invalid option. Choose either an equipment slot, Potion, or Other[[Category:Pages with script errors]]' | return 'ERROR: Invalid option. Choose either an equipment slot, Potion, or Other[[Category:Pages with script errors]]' | ||
end | end | ||
isEquipment = true | isEquipment = true | ||
itemArray = Items.getItems(function(item) | itemArray = Items.getItems(function(item) | ||
return item.itemsRequired ~= nil and item. | return item.itemsRequired ~= nil and Shared.contains(item.validSlots, category) | ||
end) | end) | ||
end | end | ||
Line 520: | Line 556: | ||
table.insert(matArray, Icons.Icon({mat.name, type='item', qty=row[2]})) | table.insert(matArray, Icons.Icon({mat.name, type='item', qty=row[2]})) | ||
if item. | if item.validSlots ~= nil and mat.validSlots ~= nil and statChangeString == '' then | ||
statChangeString = p.getStatChangeString(item, mat) | statChangeString = p.getStatChangeString(item, mat) | ||
end | end |
Revision as of 20:04, 21 August 2021
Documentation for this module may be created at Module:Items/ComparisonTables/doc
local p = {}
local MonsterData = mw.loadData('Module:Monsters/data')
local ItemData = mw.loadData('Module:Items/data')
local SkillData = mw.loadData('Module:Skills/data')
local Constants = require('Module:Constants')
local Shared = require('Module:Shared')
local Magic = require('Module:Magic')
local Areas = require('Module:CombatAreas')
local Icons = require('Module:Icons')
local Items = require('Module:Items')
local ItemSourceTables = require('Module:Items/SourceTables')
local ItemUseTables = require('Module:Items/UseTables')
local weaponTypes = {'Magic Staff', 'Magic Wand', 'Ranged Weapon', 'Weapon'}
local styleOverrides = {
Melee = {'Slayer Helmet (Basic)', 'Slayer Platebody (Basic)', 'Paladin Gloves', 'Desert Wrappings', 'Almighty Lute', 'Candy Cane', 'Bob's Rake'},
Ranged = {'Slayer Cowl (Basic)', 'Slayer Leather Body (Basic)'},
Magic = {'Slayer Wizard Hat (Basic)', 'Slayer Wizard Robes (Basic)', 'Enchanted Shield', 'Elementalist Gloves'},
None = {},
}
function p._getEquipmentTable(itemList, includeModifiers, includeDescription)
if includeModifiers == nil then includeModifiers = false end
--Getting some lists set up here that will be used later
--First, the list of columns used by both weapons & armour
local statColumns = {'stabAttackBonus', 'slashAttackBonus','blockAttackBonus','rangedAttackBonus', 'magicAttackBonus', 'strengthBonus', 'rangedStrengthBonus', 'magicDamageBonus', 'defenceBonus', 'rangedDefenceBonus', 'magicDefenceBonus', 'damageReduction', 'attackLevelRequired', 'defenceLevelRequired', 'rangedLevelRequired', 'magicLevelRequired'}
if(Shared.tableCount(itemList) == 0) then
return 'ERROR: you must select at least one item to get stats for[[Category:Pages with script errors]]'
end
local isWeaponType = itemList[1].validSlots ~= nil and Shared.contains(itemList[1].validSlots, 'Weapon') and Shared.contains(weaponTypes, itemList[1].type)
--Now that we have a preliminary list, let's figure out which columns are irrelevant (IE are zero for all items in the selection)
local ignoreColumns = Shared.clone(statColumns)
for i, item in pairs(itemList) do
local ndx = 1
while Shared.tableCount(ignoreColumns) >= ndx do
if Items._getItemStat(item, ignoreColumns[ndx], true) ~= 0 then
table.remove(ignoreColumns, ndx)
else
ndx = ndx + 1
end
end
end
--Now to remove the ignored columns (and also we need to track groups like defence bonuses to see how many remain)
local attBonusCols = 5
local strBonusCols = 2
local defBonusCols = 3
local lvlReqCols = 4
local ndx = 1
while Shared.tableCount(statColumns) >= ndx do
local colName = statColumns[ndx]
if Shared.contains(ignoreColumns, colName) then
if Shared.contains(colName, 'AttackBonus') then attBonusCols = attBonusCols - 1 end
if Shared.contains(colName, 'trengthBonus') then strBonusCols = strBonusCols - 1 end
if Shared.contains(colName, 'efenceBonus') then defBonusCols = defBonusCols - 1 end
if Shared.contains(colName, 'LevelRequired') then lvlReqCols = lvlReqCols - 1 end
table.remove(statColumns, ndx)
else
ndx = ndx + 1
end
end
--Alright, let's start the table by building the shared header
local result = '{| class="wikitable sortable stickyHeader"\r\n|-class="headerRow-0"'
if isWeaponType then
--Weapons have extra columns here for Attack Speed and "Two Handed?"
result = result..'\r\n!colspan="4"|'
else
result = result..'\r\n!colspan="2"|'
end
if attBonusCols > 0 then
result = result..'\r\n!colspan="'..attBonusCols..'"style="padding:0 0.5em 0 0.5em;"|Attack Bonus'
end
if strBonusCols > 0 then
result = result..'\r\n!colspan="'..strBonusCols..'"style="padding:0 0.5em 0 0.5em;"|Str. Bonus'
end
if Shared.contains(statColumns, 'magicDamageBonus') then
result = result..'\r\n!colspan="1"style="padding:0 0.5em 0 0.5em;"|% Dmg Bonus'
end
if defBonusCols > 0 then
result = result..'\r\n!colspan="'..defBonusCols..'"style="padding:0 0.5em 0 0.5em;"|Defence Bonus'
end
if Shared.contains(statColumns, 'damageReduction') then
result = result..'\r\n!colspan="1"style="padding:0 0.5em 0 0.5em;"|DR'
end
if lvlReqCols > 0 then
result = result..'\r\n!colspan="'..lvlReqCols..'"style="padding:0 0.5em 0 0.5em;"|Lvl Req'
end
if includeModifiers and includeDescription then
result = result..'\r\n!colspan="3"|'
elseif includeModifiers or includeDescription then
result = result..'\r\n!colspan="2"|'
else
result = result..'\r\n!colspan="1"|'
end
--One header row down, one to go
result = result..'\r\n|-class="headerRow-1"'
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|Item'
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|Name'
--Weapons have Attack Speed here
if isWeaponType then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|Attack Speed'
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|Two Handed?'
end
--Attack bonuses
if Shared.contains(statColumns, 'slashAttackBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Attack', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'stabAttackBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Strength', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'blockAttackBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Defence', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'rangedAttackBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Ranged', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'magicAttackBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Magic', type='skill', notext='true'})
end
--Strength bonuses
if Shared.contains(statColumns, 'strengthBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Strength', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'rangedStrengthBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Ranged', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'magicDamageBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Magic', type='skill', notext='true'})
end
--Defence bonuses
if Shared.contains(statColumns, 'defenceBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Defence', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'rangedDefenceBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Ranged', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'magicDefenceBonus') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Magic', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'damageReduction') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Defence', type='skill', notext='true'})
end
--Level requirements
if Shared.contains(statColumns, 'attackLevelRequired') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Attack', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'defenceLevelRequired') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Defence', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'rangedLevelRequired') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Ranged', type='skill', notext='true'})
end
if Shared.contains(statColumns, 'magicLevelRequired') then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|'..Icons.Icon({'Magic', type='skill', notext='true'})
end
--If includeModifiers is set to 'true', add the Modifiers column
if includeModifiers then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|Modifiers'
end
--If includeDescription is set to 'true', add the Description column
if includeDescription then
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|Description'
end
--And finally Sources
result = result..'\r\n!style="padding:0 1em 0 0.5em;"|Sources'
local getStatValue = function(item, statName, equipStats, levelReqs)
if string.find(statName, '^(.+)LevelRequired$') ~= nil then
-- Level requirement
local skillName = Shared.titleCase(string.match(statName, '^(.+)LevelRequired$'))
return levelReqs[skillName] or 0
elseif Shared.contains(ItemData.EquipmentStatKeys, statName) then
-- Equipment stat
return equipStats[statName] or 0
else
-- Something else that we'll assume _getItemStat() will handle
return Items._getItemStat(item, statName, true)
end
end
table.sort(itemList, function(a, b) return a.id < b.id end)
for i, item in pairs(itemList) do
local equipStats = Items._processEquipmentStats(item.equipmentStats)
local levelReqs = Items._processEquipmentLevelReqs(item.equipRequirements)
if isWeaponType then
--Building rows for weapons
result = result..'\r\n|-'
result = result..'\r\n|style ="text-align: left;padding: 0 0 0 0;"|'..Icons.Icon({item.name, type='item', size=50, notext=true})
result = result..'\r\n|style ="text-align: left;padding: 0 0.5em 0 0.5em;"|[['..item.name..']]'
result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0;" |'..Shared.formatnum(equipStats.attackSpeed)
--That's the first list out of the way, now for 2-Handed
result = result..'\r\n| style ="text-align: right;"|'
if Items._getItemStat(item, 'isTwoHanded') then result = result..'Yes' else result = result..'No' end
for j, statName in pairs(statColumns) do
local statValue = getStatValue(item, statName, equipStats, levelReqs)
result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0;'
if string.find(StatName, '^(.+)LevelRequired$') == nil then
if statValue > 0 then
result = result..'background-color:lightgreen;'
elseif statValue < 0 then
result = result..'background-color:lightpink;'
end
end
result = result..'"|'..Shared.formatnum(statValue)
if statName == 'magicDamageBonus' or statName == 'damageReduction' then result = result..'%' end
end
--If requested, add the item Modifiers
if includeModifiers then
result = result..'\r\n|style="text-align:left;white-space:nowrap;padding:0 0.5em 0 0.5em;"|'
result = result..Constants.getModifiersText(item.modifiers, true)
end
--If requested, add description
if includeDescription then
result = result..'\r\n|style="text-align:left;padding:0 0.5em 0 0.5em;"|'
result = result..(item.description ~= nil and item.description or '')
end
--Finally, the Sources
result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0.5em;" |'
result = result..ItemSourceTables._getItemSources(item)
else
--Building rows for armour
result = result..'\r\n|-'
result = result..'\r\n|style ="text-align: left;padding: 0 0 0 0;"|'..Icons.Icon({item.name, type='item', size=50, notext=true})
result = result..'\r\n|style ="text-align: left;padding: 0 0.5em 0 0.5em;"|[['..item.name..']]'
for j, statName in pairs(statColumns) do
local statValue = getStatValue(item, statName, equipStats, levelReqs)
result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0;'
if statValue > 0 then
result = result..'background-color:lightgreen;'
elseif statValue < 0 then
result = result..'background-color:lightpink;'
end
result = result..'"|'..Shared.formatnum(statValue)
if statName == 'magicDamageBonus' or statName == 'damageReduction' then result = result..'%' end
end
--If requested, add the item Modifiers
if includeModifiers then
result = result..'\r\n|style="text-align:left;white-space:nowrap;padding:0 0.5em 0 0.5em;"|'
result = result..Constants.getModifiersText(item.modifiers, true)
end
--If requested, add description
if includeDescription then
result = result..'\r\n|style="text-align:left;padding:0 0.5em 0 0.5em;"|'
result = result..(item.description ~= nil and item.description or '')
end
--Finally, the Sources
result = result..'\r\n| style ="text-align: right;padding: 0 0.5em 0 0.5em;" |'
result = result..ItemSourceTables._getItemSources(item)
end
end
result = result..'\r\n|}'
return result
end
function p.getEquipmentTable(frame)
local args = frame.args ~= nil and frame.args or frame
local type = args.type
local tier = args.tier
local slot = args.slot
local ammoTypeStr = args.ammoType
local category = args.category ~= nil and args.category or 'Combat'
--Find out what Ammo Type we're working with
local ammoType = nil
if ammoTypeStr ~= nil then
if ammoTypeStr == "Arrows" then
ammoType = 0
elseif ammoTypeStr == 'Bolts' then
ammoType = 1
elseif ammoTypeStr == 'Javelins' then
ammoType = 2
elseif ammoTypeStr == 'Throwing Knives' then
ammoType = 3
end
end
local isWeaponType = Shared.contains(weaponTypes, type)
--Now we need to figure out which items are in this list
local itemList = {}
for i, itemBase in pairs(ItemData.Items) do
local item = Shared.clone(itemBase)
item.id = i - 1
local listItem = false
if isWeaponType then
listItem = item.type == type and item.category == category
if ammoType ~= nil then listItem = listItem and item.ammoTypeRequired == ammoType end
else
--Now for handling armour
local levelReqs = Items._processEquipmentLevelReqs(item.equipRequirements)
if type == "Armour" or type == "Melee" then
listItem = levelReqs['Defence'] ~= nil or (item.category == 'Combat' and item.type == 'Armour')
elseif type == "Ranged Armour" or type == "Ranged" then
listItem = levelReqs['Ranged'] ~= nil or (item.category == 'Combat' and item.type == 'Ranged Armour')
elseif type == "Magic Armour" or type == "Magic" then
listItem = levelReqs['Magic'] or (item.category == 'Combat' and item.type == 'Magic Armour')
else
listItem = item.type == type and item.category ~= 'Combat'
end
if ammoType ~= nil then listItem = listItem and item.ammoType == ammoType end
if slot ~= nil then listItem = listItem and Shared.contains(item.validSlots, slot) end
end
if listItem then
table.insert(itemList, item)
end
end
return p._getEquipmentTable(itemList).."[[Category:getEquipmentTable]]"
end
function p._getCategoryTable(style, slot, other, includeModifiers, includeDescription)
if type(slot) == 'number' then
slot = Constants.getEquipmentSlotName(slot)
end
local itemList = Items.getItems(function(item)
local isMatch = true
local levelReqs = Items._processEquipmentLevelReqs(item.equipRequirements)
if style == 'Melee' then
if (levelReqs['Defence'] == nil and levelReqs['Attack'] == nil) and not Shared.contains(styleOverrides.Melee, item.name) then isMatch = false end
elseif style == 'Ranged' then
if levelReqs['Ranged'] == nil and not Shared.contains(styleOverrides.Ranged, item.name) then isMatch = false end
elseif style == 'Magic' then
if levelReqs['Magic'] == nil and not Shared.contains(styleOverrides.Magic, item.name) then isMatch = false end
elseif style == 'None' then
if (levelReqs['Defence'] ~= nil or levelReqs['Ranged'] ~= nil or levelReqs['Magic'] ~= nil or
Shared.contains(styleOverrides.Melee, item.name) or Shared.contains(styleOverrides.Ranged, item.name) or Shared.contains(styleOverrides.Magic, item.name)) and
not Shared.contains(styleOverrides.None, item.name) then
isMatch = false
end
end
if slot == nil or not Shared.contains(item.validSlots, slot) then isMatch = false end
if isMatch and other ~= nil then
if slot == 'Weapon' then --For quiver slot or weapon slot, 'other' is the ammo type
if other == 'Arrows' then
if item.ammoTypeRequired ~= 0 then isMatch = false end
elseif other == 'Bolts' then
if item.ammoTypeRequired ~= 1 then isMatch = false end
end
elseif slot == 'Quiver' then
if other == 'Arrows' then
if item.ammoType ~= 0 then isMatch = false end
elseif other == 'Bolts' then
if item.ammoType ~= 1 then isMatch = false end
elseif other == 'Javelins' then
if item.ammoType ~= 2 then isMatch = false end
elseif other == 'Throwing Knives' then
if item.ammoType ~= 3 then isMatch = false end
elseif other == 'Thrown' then
if item.ammoType ~= 2 and item.ammoType ~= 3 then isMatch = false end
end
end
end
return isMatch
end)
return p._getEquipmentTable(itemList, includeModifiers, includeDescription)
end
function p.getCategoryTable(frame)
local style = frame.args ~= nil and frame.args[1] or frame[1]
local slot = frame.args ~= nil and frame.args[2] or frame[2]
local other = frame.args ~= nil and frame.args[3] or frame[3]
local includeModifiers = frame.args ~= nil and frame.args.includeModifiers or frame.includeModifiers
local includeDescription = frame.args ~= nil and frame.args.includeDescription or frame.includeDescription
includeModifiers = includeModifiers ~= nil and string.upper(includeModifiers) == 'TRUE' or false
includeDescription = includeDescription ~= nil and string.upper(includeDescription) == 'TRUE' or false
return p._getCategoryTable(style, slot, other, includeModifiers, includeDescription)
end
function p.getTableForList(frame)
local stuffString = frame.args ~= nil and frame.args[1] or frame[1]
local itemNames = Shared.splitString(stuffString, ',')
local includeModifiers = frame.args ~= nil and frame.args[2] or frame[2]
includeModifiers = includeModifiers ~= nil and string.upper(includeModifiers) == 'TRUE' or false
local itemList = {}
local errMsg = 'ERROR: Some items not found in database: [[Category:Pages with script errors]]'
local hasErr = false
for i, name in Shared.skpairs(itemNames) do
local nextItem = Items.getItem(Shared.trim(name))
if nextItem == nil then
errMsg = errMsg.." '"..name.."'"
hasErr = true
else
table.insert(itemList, nextItem)
end
end
if hasErr then
return errMsg
else
return p._getEquipmentTable(itemList, includeModifiers)
end
end
function p.getDoubleLootTable(frame)
local modsDL = {
'increasedChanceToDoubleLootCombat',
'decreasedChanceToDoubleLootCombat',
'increasedChanceToDoubleLootThieving',
'decreasedChanceToDoubleLootThieving',
'increasedChanceToDoubleItemsGlobal',
'decreasedChanceToDoubleItemsGlobal'
}
local modDetail = {}
for i, modName in pairs(modsDL) do
local mName, mText, mSign, mIsNeg, mValUnsigned = Constants.getModifierDetails(modName)
modDetail[modName] = { mult = (mSign == "+" and 1 or -1) }
end
local itemList = Items.getItems(function(item)
if item.modifiers ~= nil then
for modName, val in pairs(item.modifiers) do
if Shared.contains(modsDL, modName) then return true end
end
return false
end
end)
table.sort(itemList, function(a, b) return a.id < b.id end)
local result = '{| class="wikitable sortable stickyHeader"\r\n|-class="headerRow-0"'
result = result..'\r\n!colspan="2"|Name!!Bonus!!Description!!Sources'
for i, item in Shared.skpairs(itemList) do
local lootValue = 0
for modName, modDet in pairs(modDetail) do
lootValue = lootValue + (item.modifiers[modName] or 0) * modDet.mult
end
result = result..'\r\n|-'
result = result..'\r\n|data-sort-value="'..item.name..'"|'..Icons.Icon({item.name, type='item', size=50, notext=true})
result = result..'||[['..item.name..']]'
result = result..'||style ="text-align: right;" data-sort-value="'..lootValue..'"|'..lootValue..'%'
result = result..'||'..item.description
result = result..'\r\n| style ="text-align: right;white-space: nowrap;padding: 0 0.5em 0 0.5em;" |'
result = result..ItemSourceTables._getItemSources(item)
end
result = result..'\r\n|}'
return result
end
function p.getItemTableRows(frame)
local startID = frame.args ~= nil and frame.args[1] or frame[1]
local rowCount = frame.args ~= nil and frame.args[2] or frame[2]
if type(startID ) == 'string' then startID = tonumber(startID) end
if rowCount == nil then rowCount = 200 end
if type(rowCount) == 'string' then rowCount = tonumber(rowCount) end
local rowResult = {}
for i = startID, startID + rowCount - 1, 1 do
local item = Items.getItemByID(i)
if item == nil then break end
local rowTxt = '|-\r\n|'..Icons.Icon({item.name, type='item', size='50', notext=true})..'||[['..item.name..']]'
rowTxt = rowTxt..'||style="text-align:right;"|'..i..'||'..item.category..'||'..item.type
rowTxt = rowTxt..'||style="text-align:right;" data-sort-value="'..item.sellsFor..'"|'..Icons.GP(item.sellsFor)
rowTxt = rowTxt..'||style="text-align:right;"|'..ItemSourceTables._getItemSources(item, false, 'false')
rowTxt = rowTxt..'||style="text-align:right;"|'..ItemUseTables._getItemUses(item, false, 'false')
table.insert(rowResult, rowTxt)
end
return table.concat(rowResult, '\r\n')
end
function p.getStatChangeString(item1, item2)
--Used by getItemUpgradeTable to get the stat change between two items
local changeArray = {}
local getSpecificStatString = function(val1, val2, subStr)
if val1 == nil then val1 = 0 end
if val2 == nil then val2 = 0 end
if val1 ~= val2 then
local txt = string.gsub(subStr, '{V}', Shared.numStrWithSign(val1 - val2))
table.insert(changeArray, txt)
end
end
--Unfortunately just gonna have to manually check all the changes I think...
local itemStats = {
{ Stat = Items._processEquipmentStats(item1.equipmentStats), Level = Items._processEquipmentLevelReqs(item1.equipRequirements), SlayBon = Items._getItemModifier(item1, 'increasedSkillXP', 'Slayer') },
{ Stat = Items._processEquipmentStats(item2.equipmentStats), Level = Items._processEquipmentLevelReqs(item2.equipRequirements), SlayBon = Items._getItemModifier(item2, 'increasedSkillXP', 'Slayer') },
}
local attBon1 = item1.attackBonus ~= nil and item1.attackBonus or {0, 0, 0}
local attBon2 = item2.attackBonus ~= nil and item2.attackBonus or {0, 0, 0}
getSpecificStatString(itemStats[1]['Stat']['stabAttackBonus'], itemStats[2]['Stat']['stabAttackBonus'], '{V} '..Icons.Icon({'Melee', notext=true})..' Stab Bonus')
getSpecificStatString(itemStats[1]['Stat']['slashAttackBonus'], itemStats[2]['Stat']['slashAttackBonus'], '{V} '..Icons.Icon({'Melee', notext=true})..' Slash Bonus')
getSpecificStatString(itemStats[1]['Stat']['blockAttackBonus'], itemStats[2]['Stat']['blockAttackBonus'], '{V} '..Icons.Icon({'Melee', notext=true})..' Block Bonus')
getSpecificStatString(itemStats[1]['Stat']['meleeStrengthBonus'], itemStats[2]['Stat']['meleeStrengthBonus'], '{V} '..Icons.Icon({'Strength', type='skill', notext=true})..' Strength Bonus')
getSpecificStatString(itemStats[1]['Stat']['rangedStrengthBonus'], itemStats[2]['Stat']['rangedStrengthBonus'], '{V} '..Icons.Icon({'Ranged', type='skill', notext=true})..' Strength Bonus')
getSpecificStatString(itemStats[1]['Stat']['magicStrengthBonus'], itemStats[2]['Stat']['magicStrengthBonus'], '{V}% '..Icons.Icon({'Magic', type='skill', notext=true})..' Damage Bonus')
getSpecificStatString(itemStats[1]['Stat']['meleeDefenceBonus'], itemStats[2]['Stat']['meleeDefenceBonus'], '{V} '..Icons.Icon({'Defence', type='skill', notext=true})..' Defence Bonus')
getSpecificStatString(itemStats[1]['Stat']['rangedDefenceBonus'], itemStats[2]['Stat']['rangeDefenceBonus'], '{V} '..Icons.Icon({'Ranged', type='skill', notext=true})..' Defence Bonus')
getSpecificStatString(itemStats[1]['Stat']['magicDefenceBonus'], itemStats[2]['Stat']['magicDefenceBonus'], '{V} '..Icons.Icon({'Magic', type='skill', notext=true})..' Defence Bonus')
getSpecificStatString(itemStats[1]['Stat']['damageReduction'], itemStats[2]['Stat']['damageReduction'], '{V}% Damage Reduction')
getSpecificStatString(itemStats[1]['SlayBon'], itemStats[2]['SlayBon'], '{V}% '..Icons.Icon({'Slayer', type='skill', notext=true})..' Bonus XP')
getSpecificStatString(itemStats[1]['Level']['Attack'], itemStats[2]['Level']['Attack'], '{V} '..Icons.Icon({'Attack', type='skill', notext=true})..' Level Required')
getSpecificStatString(itemStats[1]['Level']['Defence'], itemStats[2]['Level']['Defence'], '{V} '..Icons.Icon({'Defence', type='skill', notext=true})..' Level Required')
getSpecificStatString(itemStats[1]['Level']['Ranged'], itemStats[2]['Level']['Ranged'], '{V} '..Icons.Icon({'Ranged', type='skill', notext=true})..' Level Required')
getSpecificStatString(itemStats[1]['Level']['Magic'], itemStats[2]['Level']['Magic'], '{V} '..Icons.Icon({'Magic', type='skill', notext=true})..' Level Required')
return table.concat(changeArray, '<br/>')
end
function p.getItemUpgradeTable(frame)
local category = frame.args ~= nil and frame.args[1] or frame
local itemArray = {}
local isEquipment = false
if string.upper(category) == 'POTION' then
itemArray = Items.getItems(function(item) return Shared.contains(item.name, 'Potion') and item.itemsRequired ~= nil end)
elseif string.upper(category) == 'OTHER' then
itemArray = Items.getItems(function(item)
return not Shared.contains(item.name, 'Potion') and item.itemsRequired ~= nil and item.validSlots == nil
end)
else
if Constants.getEquipmentSlotID(category) == nil then
return 'ERROR: Invalid option. Choose either an equipment slot, Potion, or Other[[Category:Pages with script errors]]'
end
isEquipment = true
itemArray = Items.getItems(function(item)
return item.itemsRequired ~= nil and Shared.contains(item.validSlots, category)
end)
end
table.sort(itemArray, function(a, b) return a.id < b.id end)
local result = '{| class="wikitable sortable stickyHeader"'
result = result..'\r\n|- class="headerRow-0"'
result = result..'\r\n!colspan="2"|Upgraded Item!!Ingredients'
if isEquipment then result = result..'!!Stat Change' end
for i, item in Shared.skpairs(itemArray) do
result = result..'\r\n|-'
result = result..'\r\n|'..Icons.Icon({item.name, type='item', size='50', notext=true})..'||[['..item.name..']]'
local matArray = {}
local statChangeString = ''
for i, row in Shared.skpairs(item.itemsRequired) do
local mat = Items.getItemByID(row[1])
table.insert(matArray, Icons.Icon({mat.name, type='item', qty=row[2]}))
if item.validSlots ~= nil and mat.validSlots ~= nil and statChangeString == '' then
statChangeString = p.getStatChangeString(item, mat)
end
end
if item.trimmedGPCost ~= nil and item.trimmedGPCost > 0 then
table.insert(matArray, Icons.GP(item.trimmedGPCost))
end
result = result..'||'..table.concat(matArray, '<br/>')
if isEquipment then
result = result..'||'..statChangeString
end
end
result = result..'\r\n|}'
return result
end
return p