Anonymous

Module:Pets: Difference between revisions

From Melvor Idle

Module:Pets (view source)

Revision as of 20:41, 15 January 2023

5,083 bytes added ,  15 January 2023
getPetNavbox: Migrate to Module:Navboxes
(Switch to skill icons)
(getPetNavbox: Migrate to Module:Navboxes)
 
(57 intermediate revisions by 3 users not shown)
Line 2: Line 2:


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


local Shared = require( "Module:Shared" )
local Shared = require( "Module:Shared" )
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 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", "'")
end
  name = string.gsub(name, "'", "'")
 
  name = string.gsub(name, "'", "'")
function p.getPets(checkFunc)
  for i, pet in pairs(PetData.Pets) do
return GameData.getEntities('pets', checkFunc)
    local PetName = string.gsub(pet.name, '#', '')
end
    if(name == PetName) then
 
      result = Shared.clone(pet)
--Returns the expansion icon for the pet if it has one
      --Make sure every pet has an id, and account for Lua being 1-index
function p.getExpansionIcon(frame)
      result.id = i - 1
local petName = frame.args ~= nil and frame.args[1] or frame
      break
local pet = p.getPet(petName)
    end
if pet == nil then
  end
return Shared.printError('No pet named "' .. petName .. '" exists in the data module')
  return result
end
return Icons.getExpansionIcon(pet.id)
end
 
function p._getPetSource(pet)
local skillID = p._getPetSkill(pet)
if skillID ~= nil then
local skillName = Constants.getSkillName(skillID)
return { id = skillID, name = skillName, type = 'skill' }
elseif CombatPetSources ~= nil then
return CombatPetSources[pet.id]
end
end
 
function p._getPetSourceText(pet)
local sourceOverrides = {
-- 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
 
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
 
function p._getPetChance(pet)
local source = p._getPetSource(pet)
if source ~= nil and source.weight ~= nil then
-- Pet is from a dungeon or combat/slayer area
if source.fixedChance then
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
end


function p.getPetBySkill(skillName)
function p._getPetSkill(pet)
  local result = nil
local skillOverrides = {
  skillName = string.gsub(skillName, "%%27", "&apos;")
['melvorD:Ty'] = nil,
  skillName = string.gsub(skillName, "'", "&apos;")
['melvorF:Mark'] = 'melvorD:Summoning'
  skillName = string.gsub(skillName, "&#39;", "&apos;")
}
  for i, pet in pairs(PetData.Pets) do
 
    if(Skills.getSkillID(skillName) == pet.skill) then
if skillOverrides[pet.id] ~= nil then
      result = Shared.clone(pet)
return skillOverrides[pet.id]
      --Make sure every pet has an id, and account for Lua being 1-index
else
      result.id = i - 1
return pet.skillID
      break
end
    end
  end
  return result
end
end


function p.getPetTable(frame)
function p._getPetTable(pets)
  local petName = frame.args ~= nil and frame.args[1] or frame
if type(pets) ~= 'table' or Shared.tableIsEmpty(pets) then
  local pet = p.getPet(petName)
return nil
  local result = '{| class="wikitable"\r\n'
end
  result = result..'!Pet!!Name!!Effect'
 
  result = result..'\r\n|-\r\n|'..Icons.Icon({pet.name, type='pet', size='60', notext=true})
local resultPart = {}
  result = result..'||[['..pet.name..']]||'..pet.description
table.insert(resultPart, '{| class="wikitable"\r\n!Pet!!Name!!Effect')
  result = result..'\r\n|}'
 
  return result
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 table.concat(resultPart, '\r\n')
end
end


function p.getPetTableBySkill(frame)
function p.getPetTableBySkill(frame)
  local result = nil
local skillName = frame.args ~= nil and frame.args[1] or frame
  local skillName = frame.args ~= nil and frame.args[1] or frame
local skillID = Constants.getSkillID(skillName)
  skillName = string.gsub(skillName, "%%27", "&apos;")
 
  skillName = string.gsub(skillName, "'", "&apos;")
if skillID == nil then
  skillName = string.gsub(skillName, "&#39;", "&apos;")
return ''
  local pet = p.getPetBySkill(skillName)
else
  result = p.getPetTable(pet.name)
local pets = p.getPets(function(pet) return p._getPetSkill(pet) == skillID end)
  return result
if pets == nil or Shared.tableIsEmpty(pets) then
return ''
else
return p._getPetTable(pets)
end
end
end
end


function p.getPetSidebar(frame)
function p.getPetSidebar(frame)
  local args = frame.args ~= nil and frame.args or frame
local args = frame.args ~= nil and frame.args or frame
  local result = nil
local result = nil
  local name = args.name ~= nil and args.name or args[1]
local name = (args.name ~= nil and args.name ~= '') and args.name or args[1]
  local pet = p.getPet(name)
local pet = p.getPet(name)
  --local skill = args.skill ~= nil and args.skill or '{{Skill&#124;'..Skills.getSkillName(pet.skill)..'}}'
if pet == nil then
  local skill = args.skill ~= nil and args.skill or Icons.Icon({name, type='skill'})
return Shared.printError('No pet named "' .. (name or 'Unknown') .. '" exists in the data module')
  local effect = args.effect ~= nil and args.effect or pet.description
end
 
local effect = (args.effect ~= nil and args.effect ~= '') and args.effect or p._getPetEffect(pet)
  result = '{| class="wikitable" style="float:right; clear:right;"\r\n|-\r\n'
local completionReq = (pet.ignoreCompletion ~= nil and pet.ignoreCompletion) and 'No' or 'Yes'
  result = result..'! '..name..'\r\n|-\r\n| '
local dropChance = p._getPetChance(pet)
  result = result..Icons.Icon({name, type='pet', size='250', notext=true})
 
  result = result..'\r\n|-\r\n| Pet ID: '..pet.id
result = '{| class="wikitable infobox"\r\n|-\r\n'
  result = result..'\r\n|-\r\n| Skill: '..skill
result = result..'! ' .. Icons.getExpansionIcon(pet.id) .. name .. '\r\n|-\r\n| '
  result = result..'\r\n|-\r\n| style ="width: 250px;"|Effect: '..effect..'\r\n|}'
result = result..'style="text-align: center;"|' .. Icons.Icon({name, type='pet', size='250', notext=true})
result = result.."\r\n|-\r\n|'''Pet ID:''' "..pet.id
result = result.."\r\n|-\r\n|'''Source:''' "..p._getPetSourceText(pet)
if dropChance ~= nil then
result = result.."\r\n|-\r\n|'''Drop Chance:''' "..dropChance
end
result = result.."\r\n|-\r\n| style =\"width: 250px;\"|'''Effect:''' "..effect
result = result .. "\r\n|-\r\n|'''Part of 100% Completion:''' " .. completionReq .. "\r\n|}"
 
return result
end
 
function p.getPetPageTable()
local result = ''
 
result = '{|class="wikitable sortable lighttable stickyHeader"'
result = result..'\r\n|- class="headerRow-0"\r\n! colspan="2"| Pet !! Acquired From !! Effect'
 
for i, thisPet in ipairs(GameData.rawData.pets) do
result = result..'\r\n|-\r\n|class="table-img" data-sort-value="' .. thisPet.name .. '"| ' .. Icons.Icon({thisPet.name, size='60', type='pet', notext=true})
result = result..'||' .. Icons.getExpansionIcon(thisPet.id) ..Icons.Icon({thisPet.name, type='pet', noicon=true})
result = result..'||'..p._getPetSourceText(thisPet)
result = result..'||'..p._getPetEffect(thisPet)
end
result = result..'\r\n|}'
 
return result
end
 
function p.getDungeonBoxPetText(frame)
local dungeonName = frame.args ~= nil and frame.args[1] or frame
local dung = nil
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


  return result
if dung.pet ~= nil then
local pet = p.getPetByID(dung.pet.petID)
if pet ~= nil then
local result = "\r\n|-\r\n|'''[[Pets#Boss Pets|Pet]]:'''<br/>"
result = result..Icons.Icon({pet.name, type='pet'})
result = result.."\r\n|-\r\n|'''Pet Drop Chance:'''<br/>"..p._getPetChance(pet)
return result
end
end
end
end


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