Melvor Idle

Module:Items: Difference between revisions

Module Discussion

Module:Items (view source)

Revision as of 20:04, 21 August 2021

1,705 bytes added ,  21 August 2021
no edit summary
m (Add equipment slot to page categories)
No edit summary
Line 6: Line 6:
local p = {}
local p = {}


local MonsterData = mw.loadData('Module:Monsters/data')
local ItemData = mw.loadData('Module:Items/data')
local ItemData = mw.loadData('Module:Items/data')
local SkillData = mw.loadData('Module:Skills/data')


local Constants = require('Module:Constants')
local Constants = require('Module:Constants')
Line 14: Line 12:
local Icons = require('Module:Icons')
local Icons = require('Module:Icons')


p.EasterEggs = {'Amulet of Calculated Promotion', 'Clue Chasers Insignia', '8', 'Lemon', 'Easter Egg', 'Abnormal Log', 'Red Herring'}
p.EasterEggs = {'Amulet of Calculated Promotion', 'Clue Chasers Insignia', '8', 'Lemon', 'Easter Egg', 'Abnormal Log', 'Red Herring', 'Cool Glasses'}
p.OtherShopItems = {'Cooking Gloves', 'Mining Gloves', 'Gem Gloves', 'Smithing Gloves', 'Thieving Gloves'}
p.OtherShopItems = {'Cooking Gloves', 'Mining Gloves', 'Gem Gloves', 'Smithing Gloves', 'Thieving Gloves'}
--This is hardcoded, so there's no easy way to scrape it. Hopefully it doesn't change
--This is hardcoded, so there's no easy way to scrape it. Hopefully it doesn't change
p.GemTable = {["Topaz"] = {name = 'Topaz', id = 128, chance = 50},  
p.GemTable = {["Topaz"] = {name = 'Topaz', id = 128, chance = 50},
                   ["Sapphire"] = {name = "Sapphire", id = 129, chance = 17.5},  
                   ["Sapphire"] = {name = "Sapphire", id = 129, chance = 17.5},
                   ["Ruby"] = {name = "Ruby", id = 130, chance = 17.5},  
                   ["Ruby"] = {name = "Ruby", id = 130, chance = 17.5},
                   ["Emerald"] = {name = "Emerald", id = 131, chance = 10},  
                   ["Emerald"] = {name = "Emerald", id = 131, chance = 10},
                   ["Diamond"] = {name = "Diamond", id = 132, chance = 5}}
                   ["Diamond"] = {name = "Diamond", id = 132, chance = 5}}
--The base chance to receive a gem while mining
--The base chance to receive a gem while mining
Line 66: Line 64:
   return result
   return result
end
end


function p.getItemByID(ID)
function p.getItemByID(ID)
Line 102: Line 102:
   end
   end
   return result
   return result
end
-- Input: equipmentStats property of an item in the format { { ["key"] = "stabAttackBonus", ["value"] = 2 }, ... }
-- Output: Table in the format { ["stabAttackBonus"] = 2, ... }
function p._processEquipmentStats(equipStats)
  local out = {}
  if type(equipStats) == 'table' then
    for i, stat in pairs(equipStats) do
      local k, v = stat["key"], stat["value"]
      if out[k] == nil then
        out[k] = v
      else
        out[k] = out[k] + v
      end
    end
  end
  return out
end
-- Input: equipRequirements property of an item
-- Output: Table in the format { ["Attack"] = 80, ... }
function p._processEquipmentLevelReqs(equipReqs)
  local out = {}
  if type(equipReqs) == 'table' then
    for i, req in pairs(equipReqs) do
      if req.type == 'Level' then
        for j, levelReq in pairs(req.levels) do
          local skillName = Constants.getSkillName(levelReq.skill)
          if skillName ~= nil then out[skillName] = levelReq.level end
        end
      end
    end
  end
  return out
end
end


Line 107: Line 141:
   local result = item[StatName]
   local result = item[StatName]
   --Special Overrides:
   --Special Overrides:
   if StatName == 'stabAttackBonus' then
  -- Equipment stats first
     if item.attackBonus == nil then
   if Shared.contains(ItemData.EquipmentStatKeys, StatName) then
      result = nil
     local equipStats = p._processEquipmentStats(item.equipmentStats)
     else
     result = equipStats[StatName]
      result = item.attackBonus[1]
   elseif StatName == 'isTwoHanded' then
    end
     if item.validSlots ~= nil and item.occupiesSlots ~= nil then
   elseif StatName == 'slashAttackBonus' then
       return Shared.contains(item.validSlots, 'Weapon') and Shared.contains(item.occupiesSlots, 'Shield')
     if item.attackBonus == nil then  
       result = nil
     else
     else
       result = item.attackBonus[2]
       return false
     end
     end
   elseif StatName == 'blockAttackBonus' then
   elseif string.find(StatName, '^(.+)LevelRequired$') ~= nil then
     if item.attackBonus == nil then  
    local skillName = Shared.titleCase(string.match(StatName, '^(.+)LevelRequired$'))
       result = nil
     if skillName ~= nil then
    else
       local levelReqs = p._processEquipmentLevelReqs(item.equipRequirements)
       result = item.attackBonus[3]
       result = levelReqs[skillName]
     end
     end
   elseif StatName == 'attackType' then
   elseif StatName == 'attackType' then
Line 167: Line 199:
     skill = Constants.getSkillID(skill)
     skill = Constants.getSkillID(skill)
   end
   end
  mw.log(item.name..', '..modifier)


   local result = 0
   local result = 0
Line 197: Line 227:


function p.hasCombatStats(item)
function p.hasCombatStats(item)
   if item.equipmentSlot == nil then
   if not item.isEquipment or item.validSlots == nil and item.equipmentStats ~= nil then
     return false
     -- Ensure at least one stat has a non-zero value
  elseif item.equipmentSlot == Constants.getEquipmentSlotID('Weapon') then
    local equipStats = p._processEquipmentStats(item.equipmentStats)
     return true
     for statName, statVal in pairs(equipStats) do
  end
      if statVal ~= 0 then return true end
 
  local combatStatList = {'strengthBonus', 'defenceBonus', 'stabAttackBonus', 'slashAttackBonus', 'blockAttackBonus', 'damageReduction',
                          'rangedDefenceBonus', 'magicDefenceBonus', 'rangedAttackBonus', 'rangedStrengthBonus', 'magicAttackBonus', 'magicDamageBonus'}
 
  for i, stat in Shared.skpairs(combatStatList) do
    if p._getItemStat(item, stat, true) > 0 then
      return true
     end
     end
   end
   end
   return false
   return false
end
end
Line 237: Line 259:


function p._getWeaponAttackType(item)
function p._getWeaponAttackType(item)
   if item.type == 'Weapon' then
   if item.isEquipment == true and item.validSlots ~= nil and Shared.contains(item.validSlots, 'Weapon') then
    return Icons.Icon({'Melee', nolink='true'})
     if Shared.contains({'melee', 'ranged', 'magic'}, item.attackType) then
  elseif item.type == 'Ranged Weapon' then
      local iconType = item.attackType ~= 'melee' and 'skill' or nil
     return Icons.Icon({'Ranged', type='skill', nolink='true'})
      return Icons.Icon({Shared.titleCase(item.attackType), type=iconType, nolink='true'})
  elseif item.type == 'Magic Staff' or item.type == 'Magic Wand' then
     end
    return Icons.Icon({'Magic', type='skill', nolink='true'})
  else
     return "Invalid"
   end
   end
  return 'Invalid'
end
end


function p.getWeaponAttackType(frame)
function p.getWeaponAttackType(frame)
Line 284: Line 303:
   result = ''
   result = ''
   --For equipment, show the slot they go in
   --For equipment, show the slot they go in
   if item.equipmentSlot ~= nil then
   if item.validSlots ~= nil then
     result = result.."\r\n|-\r\n|'''Equipment Slot:''' "..Constants.getEquipmentSlotName(item.equipmentSlot)
     result = result.."\r\n|-\r\n|'''Equipment Slot:''' "..table.concat(item.validSlots, ', ')
    if item.isPassiveItem then
      result = result..', Passive'
    end
   end
   end
   --For weapons with a special attack, show the details
   --For weapons with a special attack, show the details
   if item.hasSpecialAttack then
   if item.hasSpecialAttack then
     local spAtt = p.getSpecialAttackByID(item.specialAttackID)
     local spAttPart = {}
     result = result.."\r\n|-\r\n|'''Special Attack:'''"
     table.insert(spAttPart, "\r\n|-\r\n|'''Special Attack:'''")
     result = result..'\r\n* '..spAtt.chance..'% chance for '..spAtt.name..':'
     for i, spID in ipairs(item.specialAttacks) do
    result = result..'\r\n** '..spAtt.description
      local spAtt = p.getSpecialAttackByID(spID)
      table.insert(spAttPart, '\r\n* ' .. spAtt.defaultChance .. '% chance for ' .. spAtt.name .. ':')
      table.insert(spAttPart, '\r\n** ' .. spAtt.description)
    end
    result = result .. table.concat(spAttPart)
   end
   end
   --For potions, show the number of charges
   --For potions, show the number of charges
Line 320: Line 340:
   local item = p.getItem(itemName)
   local item = p.getItem(itemName)
   local asList = false
   local asList = false
   if frame.args ~= nil then  
   if frame.args ~= nil then
     asList = frame.args.asList ~= nil and frame.args.asList ~= '' and frame.args.asList ~= 'false'
     asList = frame.args.asList ~= nil and frame.args.asList ~= '' and frame.args.asList ~= 'false'
   end
   end
Line 334: Line 354:
   if item.category ~= nil then result = result..'[[Category:'..item.category..']]' end
   if item.category ~= nil then result = result..'[[Category:'..item.category..']]' end
   if item.type ~= nil then result = result..'[[Category:'..item.type..']]' end
   if item.type ~= nil then result = result..'[[Category:'..item.type..']]' end
  if item.equipmentSlot ~= nil then result = result..'[[Category:'..Constants.getEquipmentSlotName(item.equipmentSlot)..']]' end
   if item.tier ~= nil then result = result..'[[Category:'..Shared.titleCase(item.tier)..' '..item.type..']]' end
   if item.tier ~= nil then result = result..'[[Category:'..Shared.titleCase(item.tier)..' '..item.type..']]' end
   if item.hasSpecialAttack then result = result..'[[Category:Items With Special Attacks]]' end
   if item.hasSpecialAttack then result = result..'[[Category:Items With Special Attacks]]' end
   if item.isPassiveItem then result = result..'[[Category:Passive Items]]' end
   if item.validSlots ~= nil then
   if item.chanceToDoubleLoot ~= nil and item.chanceToDoubleLoot > 0 then result = result..'[[Category:Double Loot Chance Items]]' end
    local slotRemap = {
      ['Passive'] = 'Passive Items',
      ['Summon1'] = 'Summoning Familiars',
      ['Summon2'] = ''
    }
    for i, slotName in ipairs(item.validSlots) do
      local slotRemapName = slotName
      if slotRemap[slotName] ~= nil then slotRemapName = slotRemap[slotName] end
      if slotRemapName ~= '' then result = result .. '[[Category:' .. slotRemapName .. ']]' end
    end
  end
   if item.modifiers ~= nil then
    local modsDL = {
      'increasedChanceToDoubleLootCombat',
      'decreasedChanceToDoubleLootCombat',
      'increasedChanceToDoubleLootThieving',
      'decreasedChanceToDoubleLootThieving',
      'increasedChanceToDoubleItemsGlobal',
      'decreasedChanceToDoubleItemsGlobal'
    }
    for modName, val in pairs(item.modifiers) do
      if Shared.contains(modsDL, modName) then
        result = result..'[[Category:Double Loot Chance Items]]'
        break
      end
    end
  end
   return result
   return result
end
end
Line 379: Line 424:
function p.getSpecialAttackTable(frame)
function p.getSpecialAttackTable(frame)
   local spAttTable = {}
   local spAttTable = {}
 
 
   for i, item in Shared.skpairs(ItemData.Items) do
   for i, item in Shared.skpairs(ItemData.Items) do
     if item.hasSpecialAttack then
     if item.hasSpecialAttack then
       if spAttTable[item.specialAttackID] == nil then spAttTable[item.specialAttackID] = {sortName=item.name, Icons = {}} end
       for i, spID in ipairs(item.specialAttacks) do
      table.insert(spAttTable[item.specialAttackID].Icons, Icons.Icon({item.name, type='item'}))
        local spAtt = p.getSpecialAttackByID(spID)
        if spAttTable[spID] == nil then spAttTable[spID] = {sortName=item.name, Icons = {}} end
        table.insert(spAttTable[spID].Icons, Icons.Icon({item.name, type='item'}))
      end
     end
     end
   end
   end


   local result = '{|class="wikitable sortable stickyHeader"'
   local result = '{|class="wikitable sortable stickyHeader"'
Line 395: Line 443:
     result = result..'\r\n|-'
     result = result..'\r\n|-'
     result = result..'\r\n|data-sort-value="'..spAttData.sortName..'"|'..table.concat(spAttData.Icons, '<br/>')
     result = result..'\r\n|data-sort-value="'..spAttData.sortName..'"|'..table.concat(spAttData.Icons, '<br/>')
     result = result..'||'..spAtt.name..'||data-sort-value="'..spAtt.chance..'"|'..spAtt.chance..'%'
     result = result..'||'..spAtt.name..'||data-sort-value="'..spAtt.defaultChance..'"|'..spAtt.defaultChance..'%'
     result = result..'||'..spAtt.description
     result = result..'||'..spAtt.description
   end
   end
Retrieved from "https://testwiki.melvoridle.com/w/Special:MobileDiff/46108"