Module:Pets: Difference between revisions
From Melvor Idle
(getPetSidebar: Add completion indicator & formatting for consistency with {{ItemBox}}) |
Falterfire (talk | contribs) (Fixing Ty showing up as the woodcutting pet) |
||
Line 41: | Line 41: | ||
local skillID = Skills.getSkillID(skillName) | local skillID = Skills.getSkillID(skillName) | ||
for i, pet in pairs(PetData.Pets) do | for i, pet in pairs(PetData.Pets) do | ||
if(skillID == pet.skill) then | --Deliberately excluding Ty. He knows what he did. | ||
if(skillID == pet.skill and pet.name ~= 'Ty') then | |||
result = Shared.clone(pet) | result = Shared.clone(pet) | ||
--Make sure every pet has an id, and account for Lua being 1-index | --Make sure every pet has an id, and account for Lua being 1-index |
Revision as of 13:11, 9 March 2021
Data for this page is stored in Module:GameData/data
--This module contains all sorts of functions for getting data on pets
local p = {}
local PetData = mw.loadData('Module:Pets/data')
local Shared = require( "Module:Shared" )
local Constants = require('Module:Constants')
local Icons = require('Module:Icons')
local Skills = require('Module:Skills')
local Zones = require('Module:CombatAreas')
function p.getPetByID(ID)
local result = Shared.clone(PetData.Pets[ID + 1])
if result ~= nil then
result.id = ID
end
return result
end
function p.getPet(name)
local result = nil
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
function p.getPetBySkill(skillName)
local result = nil
local skillID = Skills.getSkillID(skillName)
for i, pet in pairs(PetData.Pets) do
--Deliberately excluding Ty. He knows what he did.
if(skillID == pet.skill and pet.name ~= 'Ty') 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
function p._getPetSource(pet)
local sourceOverrides = {
-- Format: ['PetName'] = {'Source', UseIcon}
-- UseIcon = true if Source has an associated icon, false otherwise
['Asura'] = {'Slayer', true},
['Ripper the Reindeer'] = {'[[Events#Christmas_Event_2020|Christmas Event 2020]]', false},
['Jerry the Giraffe'] = {'[[Golbin Raid|Golbin Raid Shop]]', false},
['Preston the Platypus'] = {'[[Golbin Raid|Golbin Raid Shop]]', false}
}
local petSource = ''
local useIcon = true
local override = sourceOverrides[pet.name]
if override ~= nil then
petSource = override[1] ~= nil and override[1] or pet.acquiredBy
useIcon = override[2]
elseif pet.acquiredBy ~= nil then
petSource = pet.acquiredBy
end
-- Determine icon type (if any)
local iconType = nil
if Skills.getSkillID(petSource) ~= nil then
iconType = 'skill'
else
local combatArea = Zones.getArea(petSource)
if combatArea ~= nil then
iconType = combatArea.type
end
end
if useIcon then
petSource = Icons.Icon({petSource, type=iconType})
end
return petSource
end
function p._getPetEffect(pet)
local effectOverrides = {
['Ripper the Reindeer'] = 'None',
}
if effectOverrides[pet.name] ~= nil then
return effectOverrides[pet.name]
elseif pet.modifiers ~= nil then
local effects = {}
for effectName, effectValue in pairs(pet.modifiers) do
table.insert(effects, Constants.getModifierText(effectName, effectValue, false))
end
return table.concat(effects, '<br/>')
else
return pet.description
end
end
function p.getPetTable(frame)
local petName = frame.args ~= nil and frame.args[1] or frame
local pet = p.getPet(petName)
local result = '{| class="wikitable"\r\n'
result = result..'!Pet!!Name!!Effect'
result = result..'\r\n|-\r\n|'..Icons.Icon({pet.name, type='pet', size='60', notext=true})
result = result..'||[['..pet.name..']]||'..p._getPetEffect(pet)
result = result..'\r\n|}'
return result
end
function p.getPetTableBySkill(frame)
local result = nil
local skillName = frame.args ~= nil and frame.args[1] or frame
return p.getPetTable(p.getPetBySkill(skillName).name)
end
function p.getPetSidebar(frame)
local args = frame.args ~= nil and frame.args or frame
local result = nil
local name = (args.name ~= nil and args.name ~= '') and args.name or args[1]
local pet = p.getPet(name)
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 = nil
if pet.obtained ~= nil and pet.obtained.dungeonCompletion ~= nil then
local odds = pet.obtained.dungeonCompletion[1][2]
dropChance = '1 in '..odds..' ('..Shared.round(100 / odds, 2, 2)..'%)'
end
result = '{| class="wikitable" style="float:right; clear:right;"\r\n|-\r\n'
result = result..'! '..name..'\r\n|-\r\n| '
result = result..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._getPetSource(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 = ''
local petList = Shared.clone(PetData.Pets)
result = '{|class="wikitable lighttable"'
result = result..'\r\n|-\r\n! Name !! Image !! Acquired From !! Effect'
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 = result..'\r\n|-\r\n|[['..thisPet.name..']]'
result = result..'||'..Icons.Icon({thisPet.name, size='60', type='pet', notext=true})
result = result..'||'..p._getPetSource(thisPet)
result = result..'||'..p._getPetEffect(thisPet)
end
result = result..'\r\n|}'
return result
end
function p.getPetNavbox(frame)
--•
local result = '{| class="wikitable" style="margin:auto; text-align:center; clear:both; width: 100%"'
result = result..'\r\n|-\r\n!colspan="2"|[[Pets]]'
local skillPetList = {}
local bossPetList = {}
local otherPetList = {}
for i, petData in Shared.skpairs(PetData.Pets) do
if petData.skill ~= nil and petData.skill >= 0 and petData.name ~= "Ty" then
table.insert(skillPetList, Icons.Icon({petData.name, type='pet'}))
elseif petData.obtained ~= nil and petData.obtained.dungeonCompletion ~= nil then
table.insert(bossPetList, Icons.Icon({petData.name, type='pet'}))
else
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
return p