Module:CombatAreas: Difference between revisions

Fixed an issue with getting difficulty not working when multiple difficulties were present
(p.getAreaStat now handles Slayer areas)
(Fixed an issue with getting difficulty not working when multiple difficulties were present)
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
--NOTE: Some tables are in Module:CombatAreas/AreaTables to prevent loop from referencing Monsters
local p = {}
local p = {}


local Constants = mw.loadData('Module:Constants/data')
local AreaData = mw.loadData('Module:CombatAreas/data')
local AreaData = mw.loadData('Module:CombatAreas/data')


local Constants = require('Module:Constants')
local Shared = require('Module:Shared')
local Shared = require('Module:Shared')
local Icons = require('Module:Icons')
local Icons = require('Module:Icons')
local Items = require('Module:Items')
local Items = require('Module:Items')


function processArea(area, index)
function processArea(area, index, type)
   local result = Shared.clone(area)
   local result = Shared.clone(area)
   result.id = index - 1
   result.id = index - 1
Line 14: Line 15:
     result.name = result.areaName
     result.name = result.areaName
   end
   end
   if Shared.contains(result.type, 'Dungeon') then
   result.type = type
    result.type = 'dungeon'
  end
   return result
   return result
end
end
Line 25: Line 24:
   for i, area in pairs(AreaData.combatAreas) do
   for i, area in pairs(AreaData.combatAreas) do
     if area.areaName == name then
     if area.areaName == name then
       return processArea(area, i)
       return processArea(area, i, 'combat')
     end
     end
   end
   end
Line 31: Line 30:
   for i, area in pairs(AreaData.slayerAreas) do
   for i, area in pairs(AreaData.slayerAreas) do
     if area.areaName == name then
     if area.areaName == name then
       return processArea(area, i)
       return processArea(area, i, 'slayer')
     end
     end
   end
   end
Line 37: Line 36:
   for i, area in pairs(AreaData.dungeons) do
   for i, area in pairs(AreaData.dungeons) do
     if area.name == name then
     if area.name == name then
       return processArea(area, i)
       return processArea(area, i, 'dungeon')
     end
     end
   end
   end
Line 51: Line 50:
end
end


function p.getAreaStat(frame)
function p.getAreaFilterType(type, name)
   local areaName = frame.args ~= nil and frame.args[1] or frame[1]
   local areaName = nil
   local statName = frame.args ~= nil and frame.args[2] or frame[2]
  if type == 'dungeon' then areas = AreaData.dungeons
   local area = p.getArea(areaName)
  elseif type == 'combat' then areas = AreaData.combatAreas
  if area == nil then
   elseif type == 'slayer' then areas = AreaData.slayerAreas
     return "ERROR: Could not find an area named "..areaName
  else return nil end
 
   for i, area in pairs(areas) do
    if type == 'dungeon' then areaName = area.name
     else areaName = area.areaName end
 
    if areaName == name then
      return processArea(area, i, type)
    end
   end
   end
  return nil
end
function p._getAreaStat(area, statName)
   if statName == 'slayerLevel' then
   if statName == 'slayerLevel' then
     return Icons._SkillReq('Slayer', area.slayerLevel)
     return Icons._SkillReq('Slayer', area.slayerLevel)
   end
   elseif statName == 'slayerItem' then
  if statName == 'slayerItem' then
     if area.slayerItem ~= nil and area.slayerItem > 0 then
     if area.slayerItem ~= nil and area.slayerItem > 0 then
       local slayItem = Items.getItemByID(area.slayerItem)
       local slayItem = Items.getItemByID(area.slayerItem)
Line 68: Line 79:
       return 'None'
       return 'None'
     end
     end
  elseif statName == 'dungeonReq' then
    if area.requiresCompletion ~= nil and area.requiresCompletion >= 0 then
      local dung = p.getAreaByID('dungeon', area.requiresCompletion)
      local compCount = area.requiresCompletionCount ~= nil and area.requiresCompletionCount or 1
      if compCount > 1 then
        return compCount..'x '..Icons.Icon({dung.name, type='dungeon'})..' Completions'
      else
        return Icons.Icon({dung.name, type='dungeon'})..' Completed'
      end
    else
      return ''
    end
  elseif statName == 'areaEffectDesc' then
    if area.areaEffect ~= nil and area.areaEffect then
      return area.areaEffectDescription
    else
      return 'None'
    end
  elseif statName == 'difficulty' then
    local result = Constants.getDifficultyString(area.difficulty[1])
    if area.difficulty[2] ~= nil then
      result = result..' - '..Constants.getDifficultyString(area.difficulty[2])
    end
    return result
   end
   end


   return area[statName]
   return area[statName]
end
function p.getAreaStat(frame)
  local areaName = frame.args ~= nil and frame.args[1] or frame[1]
  local statName = frame.args ~= nil and frame.args[2] or frame[2]
  local area = p.getArea(areaName)
  if area == nil then
    return "ERROR: Could not find an area named "..areaName
  end
  return p._getAreaStat(area, statName)
end
end


Line 78: Line 124:
   for i, area in pairs(AreaData.combatAreas) do
   for i, area in pairs(AreaData.combatAreas) do
     if Shared.contains(area.monsters, monsterID) then
     if Shared.contains(area.monsters, monsterID) then
       table.insert(areaArray, processArea(area, i))
       table.insert(areaArray, processArea(area, i, 'combat'))
     end
     end
   end
   end
Line 84: Line 130:
   for i, area in pairs(AreaData.slayerAreas) do
   for i, area in pairs(AreaData.slayerAreas) do
     if Shared.contains(area.monsters, monsterID) then
     if Shared.contains(area.monsters, monsterID) then
       table.insert(areaArray, processArea(area, i))
       table.insert(areaArray, processArea(area, i, 'slayer'))
     end
     end
   end
   end


   for i, area in pairs(AreaData.dungeons) do
   --Hill Giants specifically ignore dungeons to prevent the issue with Into the Mist incorrectly being listed.
    if Shared.contains(area.monsters, monsterID) then
  if monsterID ~= 1 then
      table.insert(areaArray, processArea(area, i))
    for i, area in pairs(AreaData.dungeons) do
      if Shared.contains(area.monsters, monsterID) then
        table.insert(areaArray, processArea(area, i, 'dungeon'))
      end
     end
     end
   end
   end
   return areaArray
   return areaArray
end
function p.getDungeonRequirements(frame)
  local areaName = frame.args ~= nil and frame.args[1] or frame
  local area = p.getArea(areaName)
  if area == nil then
    return "ERROR: Could not find an area named "..areaName
  end
  local result = p._getAreaStat(area, 'dungeonReq')
  if result ~= '' then
    result = "\r\n|-\r\n|'''Requirements:'''<br/>"..result
  end
  return result
end
end


return p
return p