Melvor Idle

Module:CombatAreas: Difference between revisions

Module Discussion

Module:CombatAreas (view source)

Revision as of 00:35, 2 November 2024

2,717 bytes added ,  2 November 2024
getAreaPassives now works for dungeons and strongholds
(Added note about CombatAreas/AreaTables, removed unnecessary Constants call)
(getAreaPassives now works for dungeons and strongholds)
 
(26 intermediate revisions by 4 users not shown)
Line 2: Line 2:
local p = {}
local p = {}


local AreaData = mw.loadData('Module:CombatAreas/data')
local Constants = require('Module:Constants')
 
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
["stronghold"] = 'strongholds'
  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
 
if area.unlockRequirement ~= nil then
-- Avoid repeating the same requirements twice, can happen for some dungeons e.g. Impending Darkness
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


  for i, area in pairs(areas) do
return table.concat(resultArray, '<br/>')
    if type == 'dungeon' then areaName = area.name
end
    else areaName = area.areaName end


    if areaName == name then
function p.getAreaRequirementsForBox(frame)
      return processArea(area, i, type)
--Returns infobox formatting for requirements, or returns nothing if there are none.
    end
local areaName = frame.args ~= nil and frame.args[1] or frame
  end
local area = p.getArea(areaName)
if area == nil then
return Shared.printError('No area named "' .. areaName .. '" exists in the data module')
end


  return nil
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')
and Shared.contains(GameData.rawData.spiderLairMonsters, monster.id)
)
)
end
 
function p._getMonsterAreas(monster)
-- Special handling for Lair of the Spider Queen, which has a random list of enemies
local randomSpiderCheck = Shared.contains(GameData.rawData.spiderLairMonsters, monster.id)
return p.getAreas(
function(area)
return p._isMonsterInArea(monster, area)
end)
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 Shared.printError('No area named "' .. areaName .. '" exists in the data module')
end
 
local result = p._getAreaStat(area, 'requirements')
if result ~= '' then
result = "\r\n|-\r\n|'''Requirements:'''<br/>"..result
end
return result
end
 
function p.getAreaPassives(frame)
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 bossPassives = nil
local nonBossPassives = nil
if area.eventID ~= nil and area.eventID ~= '' then -- currently just Impending Darkness Event
local event = GameData.getEntityByID('combatEvents', area.eventID)
bossPassives = event.bossPassives
-- nonBossPassives = event.enemyPassives -- melvorF:ControlledAffliction is missing from GameData
else
bossPassives = area.bossOnlyPassives -- Strongholds only
nonBossPassives = area.nonBossPassives -- Dungeons only
end
 
local result = ''
 
    if type(nonBossPassives) == 'table' and not Shared.tableIsEmpty(nonBossPassives) then
    result = result .. '\r\n===Non-Boss Monster Passives==='
for i, passiveID in ipairs(nonBossPassives) do
local passive = p.getPassiveByID(passiveID)
result = result .. '\r\n* ' .. passive.name .. '\r\n** ' .. Constants.getDescription(passive.customDescription, passive.modifiers)
end
     end
     end
  end


  for i, area in pairs(AreaData.slayerAreas) do
    if type(bossPassives) == 'table' and not Shared.tableIsEmpty(bossPassives) then
    if Shared.contains(area.monsters, monsterID) then
    result = result .. '\r\n===Boss Monster Passives==='
      table.insert(areaArray, processArea(area, i, 'slayer'))
for i, passiveID in ipairs(bossPassives) do
local passive = p.getPassiveByID(passiveID)
result = result .. '\r\n* ' .. passive.name .. '\r\n** ' .. Constants.getDescription(passive.customDescription, passive.modifiers)
end
     end
     end
  end


  --Hill Giants specifically ignore dungeons to prevent the issue with Into the Mist incorrectly being listed.
if type(area.tiers) == 'table' and not Shared.tableIsEmpty(area.tiers) then
  if monsterID ~= 1 then
result = result .. '\r\n===Stronghold Tier Passives==='
    for i, area in pairs(AreaData.dungeons) do
for tierName, tierData in pairs(area.tiers) do
      if Shared.contains(area.monsters, monsterID) then
result = result .. '\r\n* ' .. tierName .. ' Tier'
        table.insert(areaArray, processArea(area, i, 'dungeon'))
for i, passiveID in ipairs(tierData.passives) do
      end
local passive = p.getPassiveByID(passiveID)
    end
result = result .. '\r\n** ' .. passive.name .. '\r\n*** ' .. Constants.getDescription(passive.customDescription, passive.modifiers)
  end
end
  return areaArray
end
end
 
return result
end
end


function p.getDungeonRequirements(frame)
function p.getPassiveByID(ID)
  local areaName = frame.args ~= nil and frame.args[1] or frame
     return GameData.getEntityByID('combatPassives', ID)
  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
Kalium
242

edits

Retrieved from "https://testwiki.melvoridle.com/w/Special:MobileDiff/44220...83738"