Module:Calculator/AgilityObstacle: Difference between revisions
No edit summary |
(Add support for more currencies) |
||
(18 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
local p = {} | local p = {} | ||
local yesno = require('Module:Shared/Yesno') | |||
local Num = require('Module:Number') | local Num = require('Module:Number') | ||
local Constants = require('Module:Constants') | local Constants = require('Module:Constants') | ||
local Modifiers = require('Module:Modifiers') | |||
local Agility = require('Module:Skills/Agility') | local Agility = require('Module:Skills/Agility') | ||
local Shared = require('Module:Shared') | local Shared = require('Module:Shared') | ||
local Icons = require('Module:Icons') | local Icons = require('Module:Icons') | ||
local | |||
local iconTable = { | |||
['GP'] = function(amount) return Icons._Currency('GP', amount) end, | |||
['SC'] = function(amount) return Icons._Currency('SC', amount) end, | |||
['AP'] = function(amount) return Icons._Currency('AP', amount) end, | |||
['ASC'] = function(amount) return Icons._Currency('ASC', amount) end, | |||
} | |||
local currencies = { | |||
'GP', 'SC', 'AP', 'ASC' | |||
} | |||
local function getItemIcon(itemName, amount) | local function getItemIcon(itemName, amount) | ||
if | local iconFunc = iconTable[itemName] | ||
if iconFunc then | |||
return iconFunc(amount) | |||
else | |||
return Icons.Icon({itemName, type='item', qty = amount, notext=true}) | |||
end | |||
end | |||
return Icons.Icon({ | local function getObstacleIcon(obstacle) | ||
local obs = obstacle.Obstacle | |||
return Icons.getExpansionIcon(obs.id) .. Icons.Icon({obs.name, type='agility'}) | |||
end | end | ||
Line 25: | Line 39: | ||
local obstacle = Agility.getObstacle(name) or Agility.getPillar(name) | local obstacle = Agility.getObstacle(name) or Agility.getPillar(name) | ||
if obstacle == nil then | if obstacle == nil then | ||
error("Unknown Agility obstacle or pillar name: " .. name) | error("Unknown Agility obstacle or pillar name: " .. (name or '<name is nil>')) | ||
end | end | ||
Line 36: | Line 50: | ||
slot = 'Pillar' | slot = 'Pillar' | ||
end | end | ||
elseif string.find(name, 'Obelisk') then | |||
slot = 'Obelisk' | |||
else | else | ||
slot = obstacle.category + 1 | slot = obstacle.category + 1 | ||
Line 78: | Line 94: | ||
function p.calculateCourse(obstacleNames, checkDoubleSlots, costReduction) | function p.calculateCourse(obstacleNames, checkDoubleSlots, costReduction) | ||
function poolItems(tbl, item, amount) | |||
Shared.addOrUpdate(tbl, item, function(x) x = x or 0 return x + amount end) | Shared.addOrUpdate(tbl, item, function(x) x = x or 0 return x + amount end) | ||
end | end | ||
-- Calculate the highest level requirements and the total amount of items | -- Calculate the highest level requirements and the total amount of items | ||
Line 90: | Line 104: | ||
['Items'] = {} | ['Items'] = {} | ||
} | } | ||
local courseObstacles = getObstacles(obstacleNames, checkDoubleSlots, costReduction) | |||
for _, obstacle in pairs(courseObstacles) do | for _, obstacle in pairs(courseObstacles) do | ||
-- Pool together highest level requirements for the entire course. | -- Pool together highest level requirements for the entire course. | ||
Line 102: | Line 117: | ||
-- Pool together total item costs to build the entire course course. | -- Pool together total item costs to build the entire course course. | ||
local obstacleCosts = obstacle.ItemCosts | local obstacleCosts = obstacle.ItemCosts | ||
-- Iterate over currencies and pool these costs | |||
for _, curr in ipairs(currencies) do | |||
if obstacleCosts[curr] then | |||
poolItems(courseItemCosts, curr, obstacleCosts[curr]) | |||
end | |||
end | |||
for item, amount in pairs(obstacleCosts['Items']) do | for item, amount in pairs(obstacleCosts['Items']) do | ||
poolItems(courseItemCosts['Items'], item, amount) | |||
end | end | ||
end | end | ||
Line 113: | Line 133: | ||
local sortFunc = function(a, b) | local sortFunc = function(a, b) | ||
-- Special case to sort pillars AFTER all regular obstacles. | -- Special case to sort pillars AFTER all regular obstacles. | ||
local pillar = { ["Pillar"] = 99, ["Elite Pillar"] = 100 } | local pillar = { ["Pillar"] = 99, ["Elite Pillar"] = 100, ["Obelisk"] = 60 } | ||
return (pillar[a.Slot] or a.Slot) < (pillar[b.Slot] or b.Slot) | return (pillar[a.Slot] or a.Slot) < (pillar[b.Slot] or b.Slot) | ||
end | end | ||
Line 147: | Line 167: | ||
function p._getCourseList(args) | function p._getCourseList(args) | ||
-- Parse optional parameters | -- Parse optional parameters | ||
local costReduction = { | local costReduction = { | ||
['GP'] = args['gpCostReduction'] | ['GP'] = Num.toNumberOrDefault(args['gpCostReduction'], 0), | ||
['SC'] = args['scCostReduction'] | ['SC'] = Num.toNumberOrDefault(args['scCostReduction'], 0), | ||
['Item'] = args['itemCostReduction'] | ['Item'] = Num.toNumberOrDefault(args['itemCostReduction'], 0), | ||
} | } | ||
Line 163: | Line 179: | ||
local div = html:tag('div') | local div = html:tag('div') | ||
if includeObstacles then | if yesno(args['includeObstacles'], true) == true then | ||
div:tag('b'):wikitext('Obstacles') | div:tag('b'):wikitext('Obstacles') | ||
local tbl = mw.html.create("table") | local tbl = mw.html.create("table") | ||
Line 178: | Line 194: | ||
:wikitext(v.Slot) | :wikitext(v.Slot) | ||
:tag('td') | :tag('td') | ||
:wikitext( | :wikitext(getObstacleIcon(v)) | ||
end | end | ||
Line 185: | Line 201: | ||
end | end | ||
if | if yesno(args['includeitems'], true) then | ||
div:tag('b'):wikitext('Items Required') | div:tag('b'):wikitext('Items Required') | ||
local ul = div:tag('ul') | local ul = div:tag('ul') | ||
local courseItems = courseRequirements.CourseItemCosts | local courseItems = courseRequirements.CourseItemCosts | ||
-- Put | -- Put currencies at the top. | ||
for _, curr in ipairs(currencies) do | |||
if courseItems[curr] then | |||
ul:tag('li'):wikitext(getItemIcon(curr, courseItems[curr])) | |||
end | |||
end | |||
local itemList = Shared.sortDictionary(courseItems['Items'], | |||
local itemList = Shared.sortDictionary(courseItems, | |||
function(a, b) return a.item < b.item end, | function(a, b) return a.item < b.item end, | ||
function(a, b) return {item = a, amount = b} end) | function(a, b) return {item = a, amount = b} end) | ||
Line 208: | Line 223: | ||
end | end | ||
if | if yesno(args['includeskills'], true) then | ||
div:tag('b'):wikitext('Skills Required') | div:tag('b'):wikitext('Skills Required') | ||
local ul2 = div:tag('ul') | local ul2 = div:tag('ul') | ||
Line 233: | Line 248: | ||
--== Local Functions for formatting Obstacle MetaData ==-- | --== Local Functions for formatting Obstacle MetaData ==-- | ||
local function getBonusses(obstacle) | local function getBonusses(obstacle) | ||
if obstacle.modifiers == nil then | |||
return '<span style="color:red">None :(</span>' | |||
else | |||
return Modifiers.getModifiersText(obstacle.modifiers, true, false, 10) | |||
end | end | ||
end | end | ||
Line 257: | Line 269: | ||
local function getCosts(costsTable) | local function getCosts(costsTable) | ||
local res = {} | local res = {} | ||
-- Order table with GP, SC first, then the other items. | -- Order table with GP, SC first, then the other items. | ||
for _, curr in ipairs(currencies) do | |||
if costsTable[curr] then | |||
table.insert(res, getItemIcon(curr, costsTable[curr])) | |||
end | |||
end | |||
local sortedCosts = Shared.sortDictionary(costsTable['Items'], | local sortedCosts = Shared.sortDictionary(costsTable['Items'], | ||
function(a, b) return a.item < b. | function(a, b) return a.item < b.item end, | ||
function(a, b) return {item = a, amount = b} end) | function(a, b) return {item = a, amount = b} end) | ||
Line 273: | Line 288: | ||
local function getTotalBonuses(obstacles) | local function getTotalBonuses(obstacles) | ||
--[==[ | |||
local bonuses = {} | local bonuses = {} | ||
for _, obstacle in pairs(obstacles) do | for _, obstacle in pairs(obstacles) do | ||
Line 291: | Line 307: | ||
return table.concat(ret, '<br/>') | return table.concat(ret, '<br/>') | ||
--]==] | |||
return '' | |||
end | end | ||
--== Parse optional parameters==-- | --== Parse optional parameters==-- | ||
local showTotals = args['showtotals'] | local showTotals = yesno(args['showtotals'], false) | ||
local obstacleMastery = args['obstacleMastery'] | local showbonus = yesno(args['showbonus'], true) | ||
local showrequirements = yesno(args['showrequirements'], true) | |||
local showcosts = yesno(args['showcosts'], true) | |||
local obstacleMastery = yesno(args['obstacleMastery'], false) | |||
local costReduction = { | local costReduction = { | ||
['GP'] = args['gpCostReduction'] | ['GP'] = Num.toNumberOrDefault(args['gpCostReduction'], 0), | ||
['SC'] = args['scCostReduction'] | ['SC'] = Num.toNumberOrDefault(args['scCostReduction'], 0), | ||
['Item'] = args['itemCostReduction'] | ['Item'] = Num.toNumberOrDefault(args['itemCostReduction'], 0), | ||
} | } | ||
Line 308: | Line 329: | ||
--== Start of table formatting ==-- | --== Start of table formatting ==-- | ||
local tbl = mw.html.create("table") | local tbl = mw.html.create("table") | ||
:addClass("wikitable | :addClass("wikitable stickyheader") | ||
tbl :tag('tr') | local thr = tbl:tag('tr') | ||
thr:tag('th'):wikitext('Slot') | |||
thr:tag('th'):wikitext('Obstacle') | |||
if showbonus then | |||
thr:tag('th'):wikitext('Bonuses') | |||
end | |||
if showrequirements then | |||
thr:tag('th'):wikitext('Requirements') | |||
end | |||
if showcosts then | |||
thr:tag('th'):wikitext('Costs') | |||
end | |||
for _, obstacle in pairs(courseRequirements.Obstacles) do | for _, obstacle in pairs(courseRequirements.Obstacles) do | ||
tbl :tag('tr') | local tr = tbl:tag('tr') | ||
tr :tag('td') | |||
:css('text-align', 'right') | |||
:wikitext(obstacle.Slot) | |||
:tag('td'):wikitext(getObstacleIcon(obstacle)) | |||
if showbonus then | |||
tr:tag('td'):wikitext(getBonusses(obstacle.Obstacle)) | |||
end | |||
if showrequirements then | |||
tr:tag('td'):wikitext(getRequirements(obstacle.LevelRequirements)) | |||
end | |||
if showcosts then | |||
tr:tag('td'):wikitext(getCosts(obstacle.ItemCosts)) | |||
end | |||
end | end | ||
if showTotals == true then | if showTotals == true then | ||
tbl :tag('tr') | local tr = tbl:tag('tr') | ||
tr :tag('th') | |||
:attr('colspan', 2) | |||
:wikitext('Totals') | |||
if showbonus then | |||
tr :tag('td') | |||
:wikitext(getTotalBonuses(courseRequirements.Obstacles)) | |||
end | |||
if showrequirements then | |||
tr :tag('td') | |||
:wikitext(getRequirements(courseRequirements.CourseLevelRequirements)) | |||
end | |||
if showcosts then | |||
tr :tag('td') | |||
:wikitext(getCosts(courseRequirements.CourseItemCosts)) | |||
end | |||
end | end | ||
Line 344: | Line 385: | ||
end | end | ||
return p | return p |
Latest revision as of 17:53, 22 July 2024
Documentation for this module may be created at Module:Calculator/AgilityObstacle/doc
local p = {}
local yesno = require('Module:Shared/Yesno')
local Num = require('Module:Number')
local Constants = require('Module:Constants')
local Modifiers = require('Module:Modifiers')
local Agility = require('Module:Skills/Agility')
local Shared = require('Module:Shared')
local Icons = require('Module:Icons')
local iconTable = {
['GP'] = function(amount) return Icons._Currency('GP', amount) end,
['SC'] = function(amount) return Icons._Currency('SC', amount) end,
['AP'] = function(amount) return Icons._Currency('AP', amount) end,
['ASC'] = function(amount) return Icons._Currency('ASC', amount) end,
}
local currencies = {
'GP', 'SC', 'AP', 'ASC'
}
local function getItemIcon(itemName, amount)
local iconFunc = iconTable[itemName]
if iconFunc then
return iconFunc(amount)
else
return Icons.Icon({itemName, type='item', qty = amount, notext=true})
end
end
local function getObstacleIcon(obstacle)
local obs = obstacle.Obstacle
return Icons.getExpansionIcon(obs.id) .. Icons.Icon({obs.name, type='agility'})
end
-- Gets all associated metadata from an obstacle based on its name.
local function getObstacle(name, costReduction)
name = Shared.specialTitleCase(name)
local obstacle = Agility.getObstacle(name) or Agility.getPillar(name)
if obstacle == nil then
error("Unknown Agility obstacle or pillar name: " .. (name or '<name is nil>'))
end
-- Resolve obstacle slot.
local slot = 0
if string.find(name, 'Pillar') then
if string.find(name, 'Elite') then
slot = 'Elite Pillar'
else
slot = 'Pillar'
end
elseif string.find(name, 'Obelisk') then
slot = 'Obelisk'
else
slot = obstacle.category + 1
end
-- Apply cost reduction, if available.
local itemCosts = Agility.getObstacleCosts(obstacle)
if costReduction then
Agility.applyCostReduction(itemCosts, costReduction)
end
local obstacleInfo = {
Name = obstacle.name,
Slot = slot,
Obstacle = obstacle,
LevelRequirements = Agility.getObstacleRequirements(obstacle),
ItemCosts = itemCosts,
}
return obstacleInfo
end
local function getObstacles(obstacleNames, checkDoubleSlots, costReduction)
-- Collect all obstacles and filter out nill values.
local courseObstacles = {}
local courseSlots = {}
for _, v in pairs(obstacleNames) do
local currObstacle = getObstacle(v, costReduction)
if currObstacle then
if checkDoubleSlots and courseSlots[currObstacle.Slot] == true then
error('There are two or more obstacles in the same slot. Obstacle: ' .. currObstacle.Name .. ' Slot: ' .. currObstacle.Slot)
end
courseSlots[currObstacle.Slot] = true
table.insert(courseObstacles, currObstacle)
end
end
return courseObstacles
end
function p.calculateCourse(obstacleNames, checkDoubleSlots, costReduction)
function poolItems(tbl, item, amount)
Shared.addOrUpdate(tbl, item, function(x) x = x or 0 return x + amount end)
end
-- Calculate the highest level requirements and the total amount of items
-- required to build this agility course.
local courseLevelRequirements = {}
local courseItemCosts = {
['Items'] = {}
}
local courseObstacles = getObstacles(obstacleNames, checkDoubleSlots, costReduction)
for _, obstacle in pairs(courseObstacles) do
-- Pool together highest level requirements for the entire course.
for skill, level in pairs(obstacle.LevelRequirements) do
Shared.addOrUpdate(courseLevelRequirements, skill,
function(x)
if x then return math.max(x, level) else return level end
end)
end
-- Pool together total item costs to build the entire course course.
local obstacleCosts = obstacle.ItemCosts
-- Iterate over currencies and pool these costs
for _, curr in ipairs(currencies) do
if obstacleCosts[curr] then
poolItems(courseItemCosts, curr, obstacleCosts[curr])
end
end
for item, amount in pairs(obstacleCosts['Items']) do
poolItems(courseItemCosts['Items'], item, amount)
end
end
-- Sort course on category
local sortFunc = function(a, b)
-- Special case to sort pillars AFTER all regular obstacles.
local pillar = { ["Pillar"] = 99, ["Elite Pillar"] = 100, ["Obelisk"] = 60 }
return (pillar[a.Slot] or a.Slot) < (pillar[b.Slot] or b.Slot)
end
table.sort(courseObstacles, sortFunc)
return {
Obstacles = courseObstacles,
CourseLevelRequirements = courseLevelRequirements,
CourseItemCosts = courseItemCosts
}
end
-- Stupid shenanigans to filter out numeric parameters.
-- Because just iterating over #args doesn't work for some reason...
function parseObstacleArgs(args)
local obstacleNames = {}
for k, v in pairs(args) do
k = tonumber(k)
if k then
table.insert(obstacleNames, v:match("^%s*(.-)%s*$"))
end
end
return obstacleNames
end
function p.getCourseList(frame)
local args = frame:getParent().args
return p._getCourseList(args)
end
function p._getCourseList(args)
-- Parse optional parameters
local costReduction = {
['GP'] = Num.toNumberOrDefault(args['gpCostReduction'], 0),
['SC'] = Num.toNumberOrDefault(args['scCostReduction'], 0),
['Item'] = Num.toNumberOrDefault(args['itemCostReduction'], 0),
}
local obstacleNames = parseObstacleArgs(args)
local courseRequirements = p.calculateCourse(obstacleNames, true, costReduction)
local html = mw.html.create()
local div = html:tag('div')
if yesno(args['includeObstacles'], true) == true then
div:tag('b'):wikitext('Obstacles')
local tbl = mw.html.create("table")
:addClass("wikitable stickyHeader text-align-left")
tbl :tag("tr")
:tag("th"):wikitext("Slot")
:tag("th"):wikitext("Obstacle")
for _, v in pairs(courseRequirements.Obstacles) do
tbl :tag('tr')
:tag('td')
:css('text-align', 'right')
:wikitext(v.Slot)
:tag('td')
:wikitext(getObstacleIcon(v))
end
div:node(tbl)
div:wikitext('<br>')
end
if yesno(args['includeitems'], true) then
div:tag('b'):wikitext('Items Required')
local ul = div:tag('ul')
local courseItems = courseRequirements.CourseItemCosts
-- Put currencies at the top.
for _, curr in ipairs(currencies) do
if courseItems[curr] then
ul:tag('li'):wikitext(getItemIcon(curr, courseItems[curr]))
end
end
local itemList = Shared.sortDictionary(courseItems['Items'],
function(a, b) return a.item < b.item end,
function(a, b) return {item = a, amount = b} end)
for _, v in pairs(itemList) do
ul:tag('li'):wikitext(getItemIcon(v.item, v.amount))
end
div:wikitext('<br>')
end
if yesno(args['includeskills'], true) then
div:tag('b'):wikitext('Skills Required')
local ul2 = div:tag('ul')
local skillList = Shared.sortDictionary(courseRequirements.CourseLevelRequirements,
function(a, b) return a.skill < b.skill end,
function(a, b) return {skill = a, level = b} end)
for _, v in pairs(skillList) do
ul2:tag('li'):wikitext(Icons._SkillReq(v.skill, v.level))
end
div:wikitext('<br>')
end
return tostring(html)
end
function p.getCourseTable(frame)
local args = frame:getParent().args
return p._getCourseTable(args)
end
function p._getCourseTable(args)
--== Local Functions for formatting Obstacle MetaData ==--
local function getBonusses(obstacle)
if obstacle.modifiers == nil then
return '<span style="color:red">None :(</span>'
else
return Modifiers.getModifiersText(obstacle.modifiers, true, false, 10)
end
end
local function getRequirements(requirementsTable)
local skillList = Shared.sortDictionary(requirementsTable,
function(a, b) return a.skill < b.skill end,
function(a, b) return {skill = a, level = b} end)
local res = {}
for _, v in pairs(skillList) do
table.insert(res, Icons._SkillReq(v.skill, v.level))
end
return table.concat(res, '<br/>')
end
local function getCosts(costsTable)
local res = {}
-- Order table with GP, SC first, then the other items.
for _, curr in ipairs(currencies) do
if costsTable[curr] then
table.insert(res, getItemIcon(curr, costsTable[curr]))
end
end
local sortedCosts = Shared.sortDictionary(costsTable['Items'],
function(a, b) return a.item < b.item end,
function(a, b) return {item = a, amount = b} end)
for _, v in pairs(sortedCosts) do
table.insert(res, getItemIcon(v.item, v.amount))
end
return table.concat(res, '<br/>')
end
local function getTotalBonuses(obstacles)
--[==[
local bonuses = {}
for _, obstacle in pairs(obstacles) do
for bonusName, bonusValue in pairs(obstacle.Obstacle.modifiers) do
table.insert(bonuses, {name = bonusName, value = bonusValue})
end
end
table.sort(bonuses, function(a, b) return a.name < b.name end)
local ret = {}
for _, bonus in pairs(bonuses) do
table.insert(ret, Constants._getModifierText(bonus.name, bonus.value))
end
if Shared.tableIsEmpty(ret) then
table.insert(ret, '<span style="color:red">None :(</span>')
end
return table.concat(ret, '<br/>')
--]==]
return ''
end
--== Parse optional parameters==--
local showTotals = yesno(args['showtotals'], false)
local showbonus = yesno(args['showbonus'], true)
local showrequirements = yesno(args['showrequirements'], true)
local showcosts = yesno(args['showcosts'], true)
local obstacleMastery = yesno(args['obstacleMastery'], false)
local costReduction = {
['GP'] = Num.toNumberOrDefault(args['gpCostReduction'], 0),
['SC'] = Num.toNumberOrDefault(args['scCostReduction'], 0),
['Item'] = Num.toNumberOrDefault(args['itemCostReduction'], 0),
}
local obstacleNames = parseObstacleArgs(args)
local courseRequirements = p.calculateCourse(obstacleNames, true, costReduction)
--== Start of table formatting ==--
local tbl = mw.html.create("table")
:addClass("wikitable stickyheader")
local thr = tbl:tag('tr')
thr:tag('th'):wikitext('Slot')
thr:tag('th'):wikitext('Obstacle')
if showbonus then
thr:tag('th'):wikitext('Bonuses')
end
if showrequirements then
thr:tag('th'):wikitext('Requirements')
end
if showcosts then
thr:tag('th'):wikitext('Costs')
end
for _, obstacle in pairs(courseRequirements.Obstacles) do
local tr = tbl:tag('tr')
tr :tag('td')
:css('text-align', 'right')
:wikitext(obstacle.Slot)
:tag('td'):wikitext(getObstacleIcon(obstacle))
if showbonus then
tr:tag('td'):wikitext(getBonusses(obstacle.Obstacle))
end
if showrequirements then
tr:tag('td'):wikitext(getRequirements(obstacle.LevelRequirements))
end
if showcosts then
tr:tag('td'):wikitext(getCosts(obstacle.ItemCosts))
end
end
if showTotals == true then
local tr = tbl:tag('tr')
tr :tag('th')
:attr('colspan', 2)
:wikitext('Totals')
if showbonus then
tr :tag('td')
:wikitext(getTotalBonuses(courseRequirements.Obstacles))
end
if showrequirements then
tr :tag('td')
:wikitext(getRequirements(courseRequirements.CourseLevelRequirements))
end
if showcosts then
tr :tag('td')
:wikitext(getCosts(courseRequirements.CourseItemCosts))
end
end
return tostring(tbl)
end
return p