12,714
edits
m (Include script errors category) |
(getPetNavbox: Migrate to Module:Navboxes) |
||
(10 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
local p = {} | local p = {} | ||
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 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) | ||
return GameData.getEntityByID('pets', ID) | |||
end | end | ||
function p.getPet(name) | function p.getPet(name) | ||
return GameData.getEntityByName('pets', Shared.fixPagename(name)) | |||
end | end | ||
function p.getPets(checkFunc) | function p.getPets(checkFunc) | ||
return GameData.getEntities('pets', checkFunc) | |||
end | |||
--Returns the expansion icon for the pet if it has one | |||
function p.getExpansionIcon(frame) | |||
local petName = frame.args ~= nil and frame.args[1] or frame | |||
local pet = p.getPet(petName) | |||
if pet == nil then | |||
return Shared.printError('No pet named "' .. petName .. '" exists in the data module') | |||
end | end | ||
return | |||
return Icons.getExpansionIcon(pet.id) | |||
end | end | ||
function p._getPetSource(pet) | 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 = { | 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 }, | |||
['Ripper the Reindeer'] = {'[[Events# | ['Festive Cool Rock'] = { text = '[[Holiday Event 2021]]', useIcon = false }, | ||
['Festive Chio'] = {'[[Holiday Event 2021]]'}, | ['Jerry the Giraffe'] = { text = '[[Golbin Raid|Golbin Raid Shop]]', useIcon = false }, | ||
['Festive Cool Rock'] = {'[[Holiday Event 2021]]'}, | ['Preston the Platypus'] = { text = '[[Golbin Raid|Golbin Raid Shop]]', useIcon = false }, | ||
['Jerry the Giraffe'] = {'[[Golbin Raid|Golbin Raid Shop]]', false}, | ['Ty'] = { text = 'Mastery', useIcon = true }, | ||
['Preston the Platypus'] = {'[[Golbin Raid|Golbin Raid Shop]]', false}, | ['Golden Golbin'] = { text = Icons.Icon({'Golbin', type='monster'}) .. ' kills', useIcon = false}, | ||
[' | ['Saki'] = { text = 'Mastery', useIcon = true } | ||
[' | |||
} | } | ||
local | local petSourceText = nil | ||
local iconType = nil | |||
local useIcon = true | local useIcon = true | ||
local override = sourceOverrides[pet.name] | local override = sourceOverrides[pet.name] | ||
if override ~= nil then | if override ~= nil then | ||
petSourceText = override.text | |||
if override.useIcon ~= nil then | |||
useIcon = override.useIcon | |||
end | |||
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 | |||
local | else | ||
if | useIcon = false | ||
iconType = combatArea.type | petSourceText = '' | ||
end | end | ||
end | end | ||
if useIcon then | if useIcon then | ||
return Icons.Icon({petSourceText, type=iconType}) | |||
else | |||
return petSourceText | |||
end | end | ||
end | end | ||
function p._getPetEffect(pet) | 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 | end | ||
end | |||
if Shared.tableIsEmpty(effects) then | |||
return 'None' | |||
else | |||
return table.concat(effects, '<br/>') | |||
end | end | ||
end | end | ||
function p._getPetChance(pet) | function p._getPetChance(pet) | ||
if | local source = p._getPetSource(pet) | ||
if source ~= nil and source.weight ~= nil then | |||
if | -- Pet is from a dungeon or combat/slayer area | ||
if source.fixedChance then | |||
return 'Guaranteed after ' .. | return 'Guaranteed after ' .. Shared.formatnum(source.weight) .. (source.weight == 1 and ' clear' or ' clears') | ||
else | else | ||
return '1 in ' .. Shared.formatnum(source.weight) .. ' (' .. Shared.round(100 / source.weight, 2, 2) .. '%)' | |||
return '1 in ' .. | |||
end | end | ||
else | else | ||
-- Skill pet or other | -- Skill pet or other | ||
Line 144: | Line 137: | ||
function p._getPetSkill(pet) | function p._getPetSkill(pet) | ||
local skillOverrides = { | local skillOverrides = { | ||
['Ty'] = | ['melvorD:Ty'] = nil, | ||
['Mark'] = | ['melvorF:Mark'] = 'melvorD:Summoning' | ||
} | } | ||
if skillOverrides[pet.id] ~= nil then | |||
if skillOverrides[pet. | return skillOverrides[pet.id] | ||
else | else | ||
return skillID | return pet.skillID | ||
end | end | ||
end | end | ||
function p._getPetTable(pets) | function p._getPetTable(pets) | ||
if pets = | if type(pets) ~= 'table' or Shared.tableIsEmpty(pets) then | ||
return nil | |||
end | |||
local resultPart = {} | local resultPart = {} | ||
table.insert(resultPart, '{| class="wikitable"\r\n!Pet!!Name!!Effect') | table.insert(resultPart, '{| class="wikitable"\r\n!Pet!!Name!!Effect') | ||
for i, pet in | for i, pet in ipairs(pets) do | ||
table.insert(resultPart, '|-') | table.insert(resultPart, '|-') | ||
table.insert(resultPart, '|style="text-align: center;"|' .. Icons.Icon({pet.name, type='pet', size=60, notext=true})) | table.insert(resultPart, '|style="text-align: center;"|' .. Icons.Icon({pet.name, type='pet', size=60, notext=true})) | ||
table.insert(resultPart, '|' .. Icons.Icon({pet.name, type='pet', noicon=true})) | table.insert(resultPart, '|' .. Icons.getExpansionIcon(pet.id) .. Icons.Icon({pet.name, type='pet', noicon=true})) | ||
table.insert(resultPart, '| ' .. p._getPetEffect(pet)) | table.insert(resultPart, '| ' .. p._getPetEffect(pet)) | ||
end | end | ||
Line 184: | Line 175: | ||
else | else | ||
local pets = p.getPets(function(pet) return p._getPetSkill(pet) == skillID end) | local pets = p.getPets(function(pet) return p._getPetSkill(pet) == skillID end) | ||
if pets == nil then | if pets == nil or Shared.tableIsEmpty(pets) then | ||
return '' | return '' | ||
else | else | ||
Line 198: | Line 189: | ||
local pet = p.getPet(name) | local pet = p.getPet(name) | ||
if pet == nil then | if pet == nil then | ||
return ' | return Shared.printError('No pet named "' .. (name or 'Unknown') .. '" exists in the data module') | ||
end | end | ||
local effect = (args.effect ~= nil and args.effect ~= '') and args.effect or p._getPetEffect(pet) | local effect = (args.effect ~= nil and args.effect ~= '') and args.effect or p._getPetEffect(pet) | ||
Line 204: | Line 195: | ||
local dropChance = p._getPetChance(pet) | local dropChance = p._getPetChance(pet) | ||
result = '{| class="wikitable infobox | result = '{| class="wikitable infobox"\r\n|-\r\n' | ||
result = result..'! '..name..'\r\n|-\r\n| ' | result = result..'! ' .. Icons.getExpansionIcon(pet.id) .. name .. '\r\n|-\r\n| ' | ||
result = result..'style="text-align: center;"|' .. Icons.Icon({name, type='pet', size='250', notext=true}) | 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|'''Pet ID:''' "..pet.id | ||
result = result.."\r\n|-\r\n|'''Source:''' "..p. | result = result.."\r\n|-\r\n|'''Source:''' "..p._getPetSourceText(pet) | ||
if dropChance ~= nil then | if dropChance ~= nil then | ||
result = result.."\r\n|-\r\n|'''Drop Chance:''' "..dropChance | result = result.."\r\n|-\r\n|'''Drop Chance:''' "..dropChance | ||
Line 220: | Line 211: | ||
function p.getPetPageTable() | function p.getPetPageTable() | ||
local result = '' | local result = '' | ||
result = '{|class="wikitable sortable lighttable stickyHeader"' | result = '{|class="wikitable sortable lighttable stickyHeader"' | ||
result = result..'\r\n|- class="headerRow-0"\r\n! | result = result..'\r\n|- class="headerRow-0"\r\n! colspan="2"| Pet !! Acquired From !! Effect' | ||
for i, thisPet in | for i, thisPet in ipairs(GameData.rawData.pets) do | ||
result = result..'\r\n|-\r\n|'..Icons.Icon({thisPet.name, type='pet', | 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..'| | result = result..'||' .. Icons.getExpansionIcon(thisPet.id) ..Icons.Icon({thisPet.name, type='pet', noicon=true}) | ||
result = result..'||'..p. | result = result..'||'..p._getPetSourceText(thisPet) | ||
result = result..'||'..p._getPetEffect(thisPet) | result = result..'||'..p._getPetEffect(thisPet) | ||
end | end | ||
Line 242: | Line 228: | ||
function p.getDungeonBoxPetText(frame) | function p.getDungeonBoxPetText(frame) | ||
local dungeonName = frame.args ~= nil and frame.args[1] or frame | local dungeonName = frame.args ~= nil and frame.args[1] or frame | ||
local dung = | 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 | if dung == nil then | ||
return ' | return Shared.printError('No dungeon named "' .. dungeonName .. '" exists in the data module') | ||
end | end | ||
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 | ||
end | end | ||
return p | return p |