Melvor Idle

Module:CombatAreas: Difference between revisions

Module Discussion

Module:CombatAreas (view source)

Revision as of 17:55, 18 June 2024

589 bytes added ,  18 June
Update for v1.3
(_getAreaStat: Add areaEffectDesc)
(Update for v1.3)
(24 intermediate revisions by 2 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 Constants = require('Module:Constants')
local AreaData = mw.loadData('Module:CombatAreas/data')
 
local Shared = require('Module:Shared')
local Shared = require('Module:Shared')
local GameData = require('Module:GameData')
local Common = require('Module:Common')
local Icons = require('Module:Icons')
local Icons = require('Module:Icons')
local Items = require('Module:Items')


function processArea(area, index, type)
local areaMap = {
  local result = Shared.clone(area)
["combat"] = 'combatAreas',
  result.id = index - 1
["dungeon"] = 'dungeons',
  if result.name == nil then
["slayer"] = 'slayerAreas',
    result.name = result.areaName
["depth"] = 'abyssDepths'
  end
}
  result.type = type
 
  return result
function p.getArea(name)
--There are three types of areas but the lists are pretty short so looping all of them isn't a real issue
for k, areaType in pairs(areaMap) do
local area = GameData.getEntityByName(areaType, name)
if area ~= nil then
return area
end
end
end
 
function p.getAreaByID(id, areaType)
for aType, areaKey in pairs(areaMap) do
if areaType == nil or areaType == aType then
local area = GameData.getEntityByID(areaKey, id)
if area ~= nil then
return area
end
end
end
end
end


function p.getArea(name)
function p.getAreaFilterType(name, type)
  local result = nil
local areaType = areaMap[type]
  --There are three types of areas but the lists are pretty short so looping all of them isn't a real issue
if areaType ~= nil then
  for i, area in pairs(AreaData.combatAreas) do
return GameData.getEntityByName(areaType, name)
    if area.areaName == name then
end
      return processArea(area, i, 'combat')
end
    end
  end


  for i, area in pairs(AreaData.slayerAreas) do
function p.getAreas(checkFunc)
    if area.areaName == name then
local resultArray = nil
      return processArea(area, i, 'slayer')
    end
  end


  for i, area in pairs(AreaData.dungeons) do
for i, areaType in pairs(areaMap) do
    if area.name == name then
local areas = GameData.getEntities(areaType, checkFunc)
      return processArea(area, i, 'dungeon')
if resultArray == nil then
    end
resultArray = areas
  end
else
for k, area in ipairs(areas) do
table.insert(resultArray, area)
end
end
end
if resultArray == nil then
resultArray = {}
end


  return nil
return resultArray
end
end


function p.getAreaByID(type, id)
--Returns the expansion icon for the area if it has one
  if type == 'dungeon' then type = 'dungeons'
function p.getExpansionIcon(frame)
  elseif type == 'combat' then type = 'combatAreas'
local areaName = frame.args ~= nil and frame.args[1] or frame
  elseif type == 'slayer' then type = 'slayerAreas' end
local area = p.getArea(areaName)
  return processArea(AreaData[type][id + 1], id + 1)
if area == nil then
return Shared.printError('No area named "' .. areaName .. '" exists in the data module')
end
return Icons.getExpansionIcon(area.id)
end
end


function p.getAreaFilterType(type, name)
function p._getAreaRequirements(area)
  local areaName = nil
local resultArray = {}
  if type == 'dungeon' then areas = AreaData.dungeons
if area.entryRequirements ~= nil then
  elseif type == 'combat' then areas = AreaData.combatAreas
local reqText = Common.getRequirementString(area.entryRequirements)
  elseif type == 'slayer' then areas = AreaData.slayerAreas
if reqText ~= nil then
  else return nil end
table.insert(resultArray, reqText)
end
end


  for i, area in pairs(areas) do
if area.unlockRequirement ~= nil then
    if type == 'dungeon' then areaName = area.name
-- Avoid repeating the same requirements twice, can happen for some dungeons e.g. Impending Darkness
    else areaName = area.areaName end
if area.entryRequirements == nil or mw.dumpObject(area.unlockRequirement) ~= mw.dumpObject(area.entryRequirements) then
local reqText = Common.getRequirementString(area.unlockRequirement)
if reqText ~= nil then
table.insert(resultArray, reqText)
end
end
end


    if areaName == name then
return table.concat(resultArray, '<br/>')
      return processArea(area, i, type)
end
    end
  end


  return nil
function p.getAreaRequirementsForBox(frame)
--Returns infobox formatting for requirements, or returns nothing if there are none.
local areaName = frame.args ~= nil and frame.args[1] or frame
local area = p.getArea(areaName)
if area == nil then
return Shared.printError('No area named "' .. areaName .. '" exists in the data module')
end
 
local reqs = p._getAreaRequirements(area)
if reqs ~= '' then
reqs = "|-\r\n|'''Requirements:'''\r\n"..reqs
end
return reqs
end
end


function p._getAreaStat(area, statName)
function p._getAreaStat(area, statName)
  if statName == 'slayerLevel' then
if statName == 'requirements' then
    return Icons._SkillReq('Slayer', area.slayerLevel)
return p._getAreaRequirements(area)
  elseif statName == 'slayerItem' then
elseif statName == 'areaEffectDesc' then
    if area.slayerItem ~= nil and area.slayerItem > 0 then
if area.areaEffect ~= nil then
      local slayItem = Items.getItemByID(area.slayerItem)
local descText, subIdx = string.gsub(area.areaEffectDescription, '${effectValue}', area.areaEffect.magnitude or 0)
      return Icons.Icon({slayItem.name, type='item'})
return descText
    else
else
      return 'None'
return 'None'
    end
end
  elseif statName == 'dungeonReq' then
elseif statName == 'difficulty' then
    if area.requiresCompletion ~= nil and area.requiresCompletion >= 0 then
local result = Constants.getDifficultyString(area.difficulty[1])
      local dung = p.getAreaByID('dungeon', area.requiresCompletion)
if area.difficulty[2] ~= nil then
      local compCount = area.requiresCompletionCount ~= nil and area.requiresCompletionCount or 1
result = result..' - '..Constants.getDifficultyString(area.difficulty[2])
      if compCount > 1 then
end
        return compCount..'x '..Icons.Icon({dung.name, type='dungeon'})..' Completions'
return result
      else
end
        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
  end


  return area[statName]
return area[statName]
end
end


function p.getAreaStat(frame)
function p.getAreaStat(frame)
  local areaName = frame.args ~= nil and frame.args[1] or frame[1]
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 statName = frame.args ~= nil and frame.args[2] or frame[2]
  local area = p.getArea(areaName)
local area = p.getArea(areaName)
  if area == nil then
if area == nil then
    return "ERROR: Could not find an area named "..areaName
return Shared.printError('No area named "' .. areaName .. '" exists in the data module')
  end
end


  return p._getAreaStat(area, statName)
return p._getAreaStat(area, statName)
end
end


function p.getMonsterAreas(monsterID)
function p._isMonsterInArea(monster, area)
  local areaArray = {}
return (
  --There are three types of areas but the lists are pretty short so looping all of them isn't a real issue
Shared.contains(area.monsterIDs, monster.id)
  for i, area in pairs(AreaData.combatAreas) do
-- Check for Lair of the Spider Queen random spiders
    if Shared.contains(area.monsters, monsterID) then
or (
      table.insert(areaArray, processArea(area, i, 'combat'))
Shared.contains(area.monsterIDs, 'melvorTotH:RandomSpiderLair')
    end
and Shared.contains(GameData.rawData.spiderLairMonsters, monster.id)
  end
)
 
)
  for i, area in pairs(AreaData.slayerAreas) do
end
    if Shared.contains(area.monsters, monsterID) then
      table.insert(areaArray, processArea(area, i, 'slayer'))
    end
  end


  --Hill Giants specifically ignore dungeons to prevent the issue with Into the Mist incorrectly being listed.
function p._getMonsterAreas(monster)
  if monsterID ~= 1 then
-- Special handling for Lair of the Spider Queen, which has a random list of enemies
    for i, area in pairs(AreaData.dungeons) do
local randomSpiderCheck = Shared.contains(GameData.rawData.spiderLairMonsters, monster.id)
      if Shared.contains(area.monsters, monsterID) then
return p.getAreas(
        table.insert(areaArray, processArea(area, i, 'dungeon'))
function(area)
      end
return p._isMonsterInArea(monster, area)
    end
end)
  end
  return areaArray
end
end


function p.getDungeonRequirements(frame)
function p.getDungeonRequirements(frame)
  local areaName = frame.args ~= nil and frame.args[1] or frame
local areaName = frame.args ~= nil and frame.args[1] or frame
  local area = p.getArea(areaName)
local area = p.getArea(areaName)
  if area == nil then
if area == nil then
    return "ERROR: Could not find an area named "..areaName
return Shared.printError('No area named "' .. areaName .. '" exists in the data module')
  end
end


  local result = p._getAreaStat(area, 'dungeonReq')
local result = p._getAreaStat(area, 'requirements')
  if result ~= '' then
if result ~= '' then
    result = "\r\n|-\r\n|'''Requirements:'''<br/>"..result
result = "\r\n|-\r\n|'''Requirements:'''<br/>"..result
  end
end
  return result
return result
end
end


return p
return p
Retrieved from "https://testwiki.melvoridle.com/w/Special:MobileDiff/43871...72730"