Melvor Idle

Module:CombatAreas: Difference between revisions

Module Discussion

Module:CombatAreas (view source)

Revision as of 17:55, 18 June 2024

1,491 bytes added ,  18 June
Update for v1.3
(Added new function for auto-building dungeon monster tables)
 
(Update for v1.3)
(38 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 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 Monsters = require('Module:Monsters')
 
local areaMap = {
["combat"] = 'combatAreas',
["dungeon"] = 'dungeons',
["slayer"] = 'slayerAreas',
["depth"] = 'abyssDepths'
}


function p.getArea(name)
function p.getArea(name)
  local result = nil
--There are three types of areas but the lists are pretty short so looping all of them isn't a real issue
  --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
  for i, area in pairs(AreaData.combatAreas) do
local area = GameData.getEntityByName(areaType, name)
    if area.areaName == name then
if area ~= nil then
      result = Shared.clone(area)
return area
      result.id = i - 1
end
      return result
end
    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
 
function p.getAreaFilterType(name, type)
local areaType = areaMap[type]
if areaType ~= nil then
return GameData.getEntityByName(areaType, name)
end
end
 
function p.getAreas(checkFunc)
local resultArray = nil
 
for i, areaType in pairs(areaMap) do
local areas = GameData.getEntities(areaType, checkFunc)
if resultArray == nil then
resultArray = areas
else
for k, area in ipairs(areas) do
table.insert(resultArray, area)
end
end
end
if resultArray == nil then
resultArray = {}
end
 
return resultArray
end
 
--Returns the expansion icon for the area if it has one
function p.getExpansionIcon(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
return Icons.getExpansionIcon(area.id)
end
 
function p._getAreaRequirements(area)
local resultArray = {}
if area.entryRequirements ~= nil then
local reqText = Common.getRequirementString(area.entryRequirements)
if reqText ~= nil then
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(AreaData.slayerAreas) do
return table.concat(resultArray, '<br/>')
    if area.areaName == name then
end
      result = Shared.clone(area)
      result.id = i - 1
      return result
    end
  end


  for i, area in pairs(AreaData.dungeons) do
function p.getAreaRequirementsForBox(frame)
    if area.name == name then
--Returns infobox formatting for requirements, or returns nothing if there are none.
      result = Shared.clone(area)
local areaName = frame.args ~= nil and frame.args[1] or frame
      result.type = 'dungeon'
local area = p.getArea(areaName)
      result.id = i - 1
if area == nil then
      return result
return Shared.printError('No area named "' .. areaName .. '" exists in the data module')
    end
end
  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.getAreaMonsterTable(frame)
function p._getAreaStat(area, statName)
  local areaName = frame.args ~= nil and frame.args[1] or frame
if statName == 'requirements' then
  local area = p.getArea(frame)
return p._getAreaRequirements(area)
  if area == nil then
elseif statName == 'areaEffectDesc' then
    return "ERROR: Could not find an area named "..areaName
if area.areaEffect ~= nil then
  end
local descText, subIdx = string.gsub(area.areaEffectDescription, '${effectValue}', area.areaEffect.magnitude or 0)
return descText
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


  if area.type == 'dungeon' then
return area[statName]
    return p.getDungeonMonsterTable(frame)
end
  end


  local tableTxt = '{| class="wikitable sortable"'
function p.getAreaStat(frame)
  tableTxt = tableTxt..'\r\n! Name !! Combat Level !! Hitpoints !! Max Hit !! [[Combat Triangle|Combat Style]]'
local areaName = frame.args ~= nil and frame.args[1] or frame[1]
  for i, monsterID in pairs(area.monsters) do
local statName = frame.args ~= nil and frame.args[2] or frame[2]
    local monster = Monsters.getMonsterByID(monsterID)
local area = p.getArea(areaName)
    tableTxt = tableTxt..'\r\n|-\r\n|'..Icons.Icon({monster.name, type='monster'})
if area == nil then
    tableTxt = tableTxt..'||'..Monsters.getMonsterCombatLevel(monster.name)
return Shared.printError('No area named "' .. areaName .. '" exists in the data module')
    tableTxt = tableTxt..'||'..Shared.formatnum(Monsters.getMonsterHP(monster.name))
end
    tableTxt = tableTxt..'||'..Shared.formatnum(Monsters.getMonsterMaxHit(monster.name))
 
    tableTxt = tableTxt..'||'..Monsters.getMonsterStyleIcon({monster.name, nolink='true'})
return p._getAreaStat(area, statName)
  end
  tableTxt = tableTxt..'\r\n|}'
  return tableTxt
end
end


function p.getDungeonMonsterTable(frame)
function p._isMonsterInArea(monster, area)
  local areaName = frame.args ~= nil and frame.args[1] or frame
return (
  local area = p.getArea(frame)
Shared.contains(area.monsterIDs, monster.id)
  if area == nil then
-- Check for Lair of the Spider Queen random spiders
    return "ERROR: Could not find an area named "..areaName
or (
  end
Shared.contains(area.monsterIDs, 'melvorTotH:RandomSpiderLair')
and Shared.contains(GameData.rawData.spiderLairMonsters, monster.id)
)
)
end


  --For Dungeons, go through and count how many of each monster are in the dungeon first
function p._getMonsterAreas(monster)
  local monsterCounts = {}
-- Special handling for Lair of the Spider Queen, which has a random list of enemies
  for i, monsterID in pairs(area.monsters) do
local randomSpiderCheck = Shared.contains(GameData.rawData.spiderLairMonsters, monster.id)
    if monsterCounts[monsterID] == nil then
return p.getAreas(
      monsterCounts[monsterID] = 1
function(area)
    else
return p._isMonsterInArea(monster, area)
      monsterCounts[monsterID] = monsterCounts[monsterID] + 1
end)
    end
end
  end


  local usedMonsters = {}
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 tableTxt = '{| class="wikitable sortable"'
local result = p._getAreaStat(area, 'requirements')
  tableTxt = tableTxt..'\r\n! Name !! Combat Level !! Hitpoints !! Max Hit !! [[Combat Triangle|Combat Style]] !! Count'
if result ~= '' then
  for i, monsterID in pairs(area.monsters) do
result = "\r\n|-\r\n|'''Requirements:'''<br/>"..result
    if not Shared.contains(usedMonsters, monsterID) then
end
      local monster = Monsters.getMonsterByID(monsterID)
return result
      local name = monster.name
      if monsterID == 51 then name = 'Spider2' end
      tableTxt = tableTxt..'\r\n|-\r\n|'..Icons.Icon({name, type='monster'})
      tableTxt = tableTxt..'||'..Monsters.getMonsterCombatLevel(name)
      tableTxt = tableTxt..'||'..Shared.formatnum(Monsters.getMonsterHP(name))
      tableTxt = tableTxt..'||'..Shared.formatnum(Monsters.getMonsterMaxHit(name))
      tableTxt = tableTxt..'||'..Monsters.getMonsterStyleIcon({name, nolink='true'})
      tableTxt = tableTxt..'||'..monsterCounts[monsterID]
      table.insert(usedMonsters, monsterID)
    end
  end
  tableTxt = tableTxt..'\r\n|}'
  return tableTxt
end
end


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