Anonymous

Module:Pets: Difference between revisions

From Melvor Idle

Module:Pets (view source)

Revision as of 20:41, 15 January 2023

1,441 bytes added ,  15 January 2023
getPetNavbox: Migrate to Module:Navboxes
m (_getPetEffect(): Fix new lines)
(getPetNavbox: Migrate to Module:Navboxes)
 
(40 intermediate revisions by 2 users not shown)
Line 2: Line 2:


local p = {}
local p = {}
local PetData = mw.loadData('Module:Pets/data')


local Shared = require( "Module:Shared" )
local Shared = require( "Module:Shared" )
local Constants = require('Module:Constants')
local Constants = require('Module:Constants')
local GameData = require('Module:GameData')
local Icons = require('Module:Icons')
local Icons = require('Module:Icons')
local Skills = require('Module:Skills')
local Zones = require('Module:CombatAreas')


local areaDataKeys = { 'combatAreas', 'dungeons', 'slayerAreas' }
-- Compute combat pet sources once for use later
local function getCombatPetSources()
local result = {}
for _, key in ipairs(areaDataKeys) do
local areas = GameData.getEntities(key, function(area) return area.pet ~= nil end)
for i, area in ipairs(areas) do
result[area.pet.petID] = {
id = area.id,
name = area.name,
type = area.type,
weight = area.pet.weight,
fixedChance = (area.fixedPetClears ~= nil and area.fixedPetClears) or area.pet.weight == 1
}
end
end
return result
end
local CombatPetSources = getCombatPetSources()


function p.getPetByID(ID)
function p.getPetByID(ID)
  local result = Shared.clone(PetData.Pets[ID + 1])
return GameData.getEntityByID('pets', ID)
  if result ~= nil then
    result.id = ID
  end
  return result
end
end


function p.getPet(name)
function p.getPet(name)
  local result = nil
return GameData.getEntityByName('pets', Shared.fixPagename(name))
  name = string.gsub(name, "%%27", "'")
  name = string.gsub(name, "'", "'")
  name = string.gsub(name, "'", "'")
  for i, pet in pairs(PetData.Pets) do
    local PetName = string.gsub(pet.name, '#', '')
    if(name == PetName) then
      result = Shared.clone(pet)
      --Make sure every pet has an id, and account for Lua being 1-index
      result.id = i - 1
      break
    end
  end
  return result
end
end


function p.getPetBySkill(skillName)
function p.getPets(checkFunc)
  local result = nil
return GameData.getEntities('pets', checkFunc)
  local skillID = Skills.getSkillID(skillName)
  for i, pet in pairs(PetData.Pets) do
    if(skillID == pet.skill) then
      result = Shared.clone(pet)
      --Make sure every pet has an id, and account for Lua being 1-index
      result.id = i - 1
      break
    end
  end
  return result
end
end


function p._getPetEffect(pet)
--Returns the expansion icon for the pet if it has one
  if pet.modifiers ~= nil then
function p.getExpansionIcon(frame)
    local effects = {}
local petName = frame.args ~= nil and frame.args[1] or frame
    for effectName, effectValue in pairs(pet.modifiers) do
local pet = p.getPet(petName)
      table.insert(effects, Constants.getModifierText(effectName, effectValue, false))
if pet == nil then
    end
return Shared.printError('No pet named "' .. petName .. '" exists in the data module')
    return table.concat(effects, '<br/>')
end
  else
    return pet.description
return Icons.getExpansionIcon(pet.id)
  end
end
end


function p.getPetTable(frame)
function p._getPetSource(pet)
  local petName = frame.args ~= nil and frame.args[1] or frame
local skillID = p._getPetSkill(pet)
  local pet = p.getPet(petName)
if skillID ~= nil then
  local result = '{| class="wikitable"\r\n'
local skillName = Constants.getSkillName(skillID)
  result = result..'!Pet!!Name!!Effect'
return { id = skillID, name = skillName, type = 'skill' }
  result = result..'\r\n|-\r\n|'..Icons.Icon({pet.name, type='pet', size='60', notext=true})
elseif CombatPetSources ~= nil then
  result = result..'||[['..pet.name..']]||'..pet.description
return CombatPetSources[pet.id]
  result = result..'\r\n|}'
end
  return result
end
end


function p.getPetTableBySkill(frame)
function p._getPetSourceText(pet)
  local result = nil
local sourceOverrides = {
  local skillName = frame.args ~= nil and frame.args[1] or frame
-- useIcon: true if Source has an associated icon, false otherwise
['Ripper the Reindeer'] = { text = '[[Events#Christmas Event 2020|Christmas Event 2020]]', useIcon = false },
['Festive Chio'] = { text = '[[Holiday Event 2021]]', useIcon = false },
['Festive Cool Rock'] = { text = '[[Holiday Event 2021]]', useIcon = false },
['Jerry the Giraffe'] = { text = '[[Golbin Raid|Golbin Raid Shop]]', useIcon = false },
['Preston the Platypus'] = { text = '[[Golbin Raid|Golbin Raid Shop]]', useIcon = false },
['Ty'] = { text = 'Mastery', useIcon = true },
['Golden Golbin'] = { text = Icons.Icon({'Golbin', type='monster'}) .. ' kills', useIcon = false},
['Saki'] = { text = 'Mastery', useIcon = true }
}
local petSourceText = nil
local iconType = nil
local useIcon = true
local override = sourceOverrides[pet.name]
if override ~= nil then
petSourceText = override.text
if override.useIcon ~= nil then
useIcon = override.useIcon
end
end
 
if petSourceText == nil then
local petSource = p._getPetSource(pet)
if petSource ~= nil then
iconType = (petSource.type == 'slayerArea' and 'combatArea') or petSource.type
petSourceText = petSource.name
else
useIcon = false
petSourceText = ''
end
end
 
if useIcon then
return Icons.Icon({petSourceText, type=iconType})
else
return petSourceText
end
end


  return p.getPetTable(p.getPetBySkill(skillName).name)
function p._getPetEffect(pet)
local modKeys = {'modifiers', 'enemyModifiers'}
local effects = {}
for i, key in ipairs(modKeys) do
if pet[key] ~= nil and not Shared.tableIsEmpty(pet[key]) then
for effectName, effectValue in pairs(pet[key]) do
local preText = (key == 'enemyModifiers' and 'All enemies have: ' or '')
table.insert(effects, preText .. Constants._getModifierText(effectName, effectValue, false))
end
end
end
if Shared.tableIsEmpty(effects) then
return 'None'
else
return table.concat(effects, '<br/>')
end
end
end


function p.getPetSidebar(frame)
function p._getPetChance(pet)
  local args = frame.args ~= nil and frame.args or frame
local source = p._getPetSource(pet)
  local result = nil
if source ~= nil and source.weight ~= nil then
  local name = (args.name ~= nil and args.name ~= '') and args.name or args[1]
-- Pet is from a dungeon or combat/slayer area
  local pet = p.getPet(name)
if source.fixedChance then
  local effect = (args.effect ~= nil and args.effect ~= '') and args.effect or p._getPetEffect(pet)
return 'Guaranteed after ' .. Shared.formatnum(source.weight) .. (source.weight == 1 and ' clear' or ' clears')
else
return '1 in ' .. Shared.formatnum(source.weight) .. ' (' .. Shared.round(100 / source.weight, 2, 2) .. '%)'
end
else
-- Skill pet or other
return 'See: [[Pets#Acquiring Pets|Acquiring Pets]]'
end
end


  local source = nil
function p._getPetSkill(pet)
  if (args.skill ~= nil and args.skill ~= '') then
local skillOverrides = {
    source = args.skill
['melvorD:Ty'] = nil,
  elseif pet.skill ~= nil and pet.skill >= 0 then
['melvorF:Mark'] = 'melvorD:Summoning'
    source = Icons.Icon({Skills.getSkillName(pet.skill), type='skill'})
}
  else
    local combatArea = Zones.getArea(pet.acquiredBy)
    if combatArea ~= nil then
      source = Icons.Icon({combatArea.name, type=combatArea.type})
    end
  end


  local dropChance = nil
if skillOverrides[pet.id] ~= nil then
  if pet.obtained ~= nil and pet.obtained.dungeonCompletion ~= nil then
return skillOverrides[pet.id]
    local odds = pet.obtained.dungeonCompletion[1][2]
else
    dropChance = '1 in '..odds..' ('..Shared.round(100 / odds, 2, 2)..'%)'
return pet.skillID
  end
end
end


 
function p._getPetTable(pets)
  result = '{| class="wikitable" style="float:right; clear:right;"\r\n|-\r\n'
if type(pets) ~= 'table' or Shared.tableIsEmpty(pets) then
  result = result..'! '..name..'\r\n|-\r\n| '
return nil
  result = result..Icons.Icon({name, type='pet', size='250', notext=true})
end
  result = result..'\r\n|-\r\n| Pet ID: '..pet.id


  result = result..'\r\n|-\r\n| Source: '..source
local resultPart = {}
  if dropChance ~= nil then
table.insert(resultPart, '{| class="wikitable"\r\n!Pet!!Name!!Effect')
    result = result..'\r\n|-\r\n| Drop Chance: '..dropChance
  end


  result = result..'\r\n|-\r\n| style ="width: 250px;"|Effect: '..effect..'\r\n|}'
for i, pet in ipairs(pets) do
table.insert(resultPart, '|-')
table.insert(resultPart, '|style="text-align: center;"|' .. Icons.Icon({pet.name, type='pet', size=60, notext=true}))
table.insert(resultPart, '|' .. Icons.getExpansionIcon(pet.id) .. Icons.Icon({pet.name, type='pet', noicon=true}))
table.insert(resultPart, '| ' .. p._getPetEffect(pet))
end
table.insert(resultPart, '|}')


  return result
return table.concat(resultPart, '\r\n')
end
end


function p.getPetPageTable()
function p.getPetTableBySkill(frame)
  local result = ''
local skillName = frame.args ~= nil and frame.args[1] or frame
local skillID = Constants.getSkillID(skillName)


  local petList = {}
if skillID == nil then
  local acquiredOverrides = {
return ''
    ['Ripper the Reindeer'] = '[[Events#Christmas_Event_2020|Christmas Event 2020]]',
else
    ['Jerry the Giraffe'] = '[[Golbin Raid|Golbin Raid Shop]]',
local pets = p.getPets(function(pet) return p._getPetSkill(pet) == skillID end)
    ['Preston the Platypus'] = '[[Golbin Raid|Golbin Raid Shop]]',
if pets == nil or Shared.tableIsEmpty(pets) then
  }
return ''
  local effectOverrides = {
else
    ['Ripper the Reindeer'] = 'None',
return p._getPetTable(pets)
  }
end
  local acquired = nil
end
  local temp = nil
end
  for i, pet in pairs(PetData.Pets) do
    temp = Shared.clone(pet)


    if(effectOverrides[temp.name] ~= nil) then
function p.getPetSidebar(frame)
      temp.description = effectOverrides[temp.name]
local args = frame.args ~= nil and frame.args or frame
    end
local result = nil
    if(temp.name == 'Asura') then temp.acquiredBy = 'Slayer' end
local name = (args.name ~= nil and args.name ~= '') and args.name or args[1]
local pet = p.getPet(name)
if pet == nil then
return Shared.printError('No pet named "' .. (name or 'Unknown') .. '" exists in the data module')
end
local effect = (args.effect ~= nil and args.effect ~= '') and args.effect or p._getPetEffect(pet)
local completionReq = (pet.ignoreCompletion ~= nil and pet.ignoreCompletion) and 'No' or 'Yes'
local dropChance = p._getPetChance(pet)


    acquired = ''
result = '{| class="wikitable infobox"\r\n|-\r\n'
    if(Skills.getSkillID(temp.acquiredBy) ~= nil) then
result = result..'! ' .. Icons.getExpansionIcon(pet.id) .. name .. '\r\n|-\r\n| '
      acquired = 'skill'
result = result..'style="text-align: center;"|' .. Icons.Icon({name, type='pet', size='250', notext=true})
    elseif Zones.getAreaFilterType('slayer', temp.acquiredBy) ~= nil then
result = result.."\r\n|-\r\n|'''Pet ID:''' "..pet.id
      acquired = 'slayer'
result = result.."\r\n|-\r\n|'''Source:''' "..p._getPetSourceText(pet)
    elseif Zones.getAreaFilterType('dungeon', temp.acquiredBy) ~= nil then
if dropChance ~= nil then
      acquired = 'dungeon'
result = result.."\r\n|-\r\n|'''Drop Chance:''' "..dropChance
    end
end
    temp.type = acquired
result = result.."\r\n|-\r\n| style =\"width: 250px;\"|'''Effect:''' "..effect
result = result .. "\r\n|-\r\n|'''Part of 100% Completion:''' " .. completionReq .. "\r\n|}"


    table.insert(petList, temp)
return result
  end
end


  result = result..'{|class="wikitable lighttable"'
function p.getPetPageTable()
  result = result..'\r\n|-\r\n! Name !! Image !! Acquired From !! Effect'
local result = ''
 
  table.sort(petList, function(a, b)
                        return p.getPet(a.name).id < p.getPet(b.name).id
                      end)


  for i, thisPet in pairs(petList) do
result = '{|class="wikitable sortable lighttable stickyHeader"'
    result = result..'\r\n|-\r\n|[['..thisPet.name..']]'
result = result..'\r\n|- class="headerRow-0"\r\n! colspan="2"| Pet !! Acquired From !! Effect'
    result = result..'||'..Icons.Icon({thisPet.name, size='60', type='pet', notext=true})


    if acquiredOverrides[thisPet.name] ~= nil then
for i, thisPet in ipairs(GameData.rawData.pets) do
      result = result..'||'..acquiredOverrides[thisPet.name]
result = result..'\r\n|-\r\n|class="table-img" data-sort-value="' .. thisPet.name .. '"| ' .. Icons.Icon({thisPet.name, size='60', type='pet', notext=true})
    else
result = result..'||' .. Icons.getExpansionIcon(thisPet.id) ..Icons.Icon({thisPet.name, type='pet', noicon=true})
      result = result..'||'..Icons.Icon({thisPet.acquiredBy, type=thisPet.type})
result = result..'||'..p._getPetSourceText(thisPet)
    end
result = result..'||'..p._getPetEffect(thisPet)
    result = result..'||'..p._getPetEffect(thisPet)
end
  end
result = result..'\r\n|}'
  result = result..'\r\n|}'


  return result
return result
end
end


function p.getPetNavbox(frame)
function p.getDungeonBoxPetText(frame)
  --•
local dungeonName = frame.args ~= nil and frame.args[1] or frame
  local result = '{| class="wikitable" style="margin:auto; text-align:center; clear:both; width: 100%"'
local dung = nil
  result = result..'\r\n|-\r\n!colspan="2"|[[Pets]]'
for i, key in ipairs(areaDataKeys) do
dung = GameData.getEntityByName(key, dungeonName)
if dung ~= nil then
break
end
end
if dung == nil then
return Shared.printError('No dungeon named "' .. dungeonName .. '" exists in the data module')
end


  local skillPetList = {}
if dung.pet ~= nil then
  local bossPetList = {}
local pet = p.getPetByID(dung.pet.petID)
  local otherPetList = {}
if pet ~= nil then
  for i, petData in Shared.skpairs(PetData.Pets) do
local result = "\r\n|-\r\n|'''[[Pets#Boss Pets|Pet]]:'''<br/>"
    if petData.skill ~= nil and petData.skill >= 0 and petData.name ~= "Ty" then
result = result..Icons.Icon({pet.name, type='pet'})
      table.insert(skillPetList, Icons.Icon({petData.name, type='pet'}))
result = result.."\r\n|-\r\n|'''Pet Drop Chance:'''<br/>"..p._getPetChance(pet)
    elseif petData.obtained ~= nil and petData.obtained.dungeonCompletion ~= nil then
return result
      table.insert(bossPetList, Icons.Icon({petData.name, type='pet'}))
end
    else
end
      table.insert(otherPetList, Icons.Icon({petData.name, type='pet'}))
    end
  end
  table.sort(skillPetList, function(a, b) return a < b end)
  table.sort(bossPetList, function(a, b) return a < b end)
  table.sort(otherPetList, function(a, b) return a < b end)
  result = result..'\r\n|-\r\n!Skill Pets\r\n|'..table.concat(skillPetList, ' • ')
  result = result..'\r\n|-\r\n!Boss Pets\r\n|'..table.concat(bossPetList, ' • ')
  result = result..'\r\n|-\r\n!Other Pets\r\n|'..table.concat(otherPetList, ' • ')
  result = result..'\r\n|}'
  return result
end
end


return p
return p
Retrieved from "https://wiki.melvoridle.com/w/Special:MobileDiff/43495...60261"