Module:Calculator/AgilityObstacle

Revision as of 14:30, 22 April 2024 by Ricewind (talk | contribs)

Documentation for this module may be created at Module:Calculator/AgilityObstacle/doc

local p = {}

local Num = require('Module:Number')
local Constants = require('Module:Constants')
local Agility = require('Module:Skills/Agility')
local Shared = require('Module:Shared')
local Skills = require('Module:Skills')
local Items = require('Module:Items')
local Icons = require('Module:Icons')
local Debug = require('Module:Debug') -- Comment out when Module is finalised.

-- Adds the the highest level to the dictionary, or the level, if the key isn't present.
local function addHighestLevelRequirement(tbl, skill, level)
	Shared.addOrUpdate(tbl, skill, 
		function(x)
			if x then
				return math.max(x, level)
			else
				return level
			end
		end
	)
end

-- Adds the item amount to the dictionary, or just the amount if the key isn't present.
local function concatItemRequirements(tbl, item, amount)
	Shared.addOrUpdate(tbl, item, 
		function(x)
			x = x or 0
			return x + amount
		end
	)
end

--- Gets all required levels to build the given obstacle.
local function getLevelRequirements(obstacle)
	local levelRequirements = {}
	
	-- Add agility level requirement.
	addHighestLevelRequirement(levelRequirements, 'Agility', Skills.getRecipeLevel('Agility', obstacle))

	-- Add other level requirements.
	if type(obstacle.skillRequirements) == 'table' then
		for i, skillReq in ipairs(obstacle.skillRequirements) do
			local skillName = Constants.getSkillName(skillReq.skillID)
			if skillName ~= nil then
				addHighestLevelRequirement(levelRequirements, skillName, skillReq.level)
			end
		end
	end
	
	return levelRequirements
end

local function getItemRequirements(obstacle)
	local itemRequirements = {}

	if obstacle.gpCost > 0 then
		concatItemRequirements(itemRequirements, 'GP', obstacle.gpCost)
	end
	if obstacle.scCost > 0 then
		concatItemRequirements(itemRequirements, 'SC', obstacle.scCost)
	end
	
	for j, itemCost in ipairs(obstacle.itemCosts) do
		local item = Items.getItemByID(itemCost.id)
		concatItemRequirements(itemRequirements, item.name, itemCost.quantity)
	end
	
	return itemRequirements
end

local function getObstacle(name)
	name = Shared.specialTitleCase(name)
	local obstacle = Agility.getObstacle(name)
	if obstacle == nil then
		return nil
	end
	
	-- TODO: Handle pillars and return the same format/table.
	-- if obstacle == pillar.....
	
	local obstacleInfo = {
		Name = obstacle.name,
		Slot = obstacle.category + 1,
		LevelRequirements = getLevelRequirements(obstacle),
		ItemCosts = getItemRequirements(obstacle),
	}

	return obstacleInfo
end

function p.calculateCourse(obstacles, checkDoubleSlots)
	-- Collect all obstacles and filter out nill values.
	local courseObstacles = {}
	local courseSlots = {}
	
	for _, v in pairs(obstacles) do
		local currObstacle = getObstacle(v)
		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
	
	-- Calculate the highest level requirements and the total amount of items
	-- required to build this agility course.
	local courseLevelRequirements = {}
	local courseItemCosts = {}
	
	for _, course in pairs(courseObstacles) do
		for skill, level in pairs(course.LevelRequirements) do
			addHighestLevelRequirement(courseLevelRequirements, skill, level)
		end
		
		for item, amount in pairs(course.ItemCosts) do
			concatItemRequirements(courseItemCosts, item, amount)
		end
	end
	
	return {
		CourseLevelRequirements = courseLevelRequirements,
		CourseItemCosts = courseItemCosts
	}
end

-- Stupid shenanigans to filter out numeric parameters.
-- Because just iterating over #args doesn't work for some reason...
function getNumericArgs(args)
	local ret = {}
	for k, v in pairs(args) do
		k = tonumber(k)
		if k then table.insert(ret, v) end
	end
	return ret
end

function p.main(frame)
	local args = frame:getParent().args
	return p._main(args)
end

function p._main(args)
	local numParams = getNumericArgs(args)
	local obstacleNames = {}
	for i = 1, #numParams do
    	if numParams[i] then
    		table.insert(obstacleNames, numParams[i]:match("^%s*(.-)%s*$"))
    	end
	end
	
	local courseRequirements = p.calculateCourse(obstacleNames, true)

	-------- TEMP --------
	local html = mw.html.create()
    local div = html:tag('div')
    div:tag('h2'):wikitext('Items Required')
    
    local ul = div:tag('ul')
    for k, v in pairs(courseRequirements.CourseItemCosts) do
    	ul:tag('li'):wikitext(k .. ': ' .. v)
    end
	 
	div:tag('h2'):wikitext('Skills Required')
	
    local ul2 = div:tag('ul')
    for k, v in pairs(courseRequirements.CourseLevelRequirements) do
    	ul2:tag('li'):wikitext(k .. ': ' .. v)
    end
    
    return tostring(html)
end

function p.test()
	mw.log( p._main({
		' Cargo Net ',' Balance Beam','Pipe Climb'
	}))
end

function p._getCourseTable(obstacleNames)
	local result = ''
	local obstacles = {}
	for i, name in ipairs(obstacleNames) do
		local obst = p.getObstacle(Shared.trim(name))
		if obst == nil then
			result = result .. Shared.printError('Invalid Obstacle Name "' .. name .. '"') .. '<br/>'
		else
			table.insert(obstacles, obst)
		end
	end

	result = result..'{| class="wikitable sortable stickyHeader"'
	result = result..'\r\n|- class="headerRow-0"'
	result = result..'\r\n!Slot!!Name!!Bonuses!!Requirements!!Cost'

	local catLog = {}
	
	table.sort(obstacles, function(a, b) return a.category < b.category end)

	local catCounts = {}
	for i, obst in ipairs(obstacles) do
		if catCounts[obst.category] == nil then
			catCounts[obst.category] = 1
		else
			catCounts[obst.category] = catCounts[obst.category] + 1
		end
	end

	for i, obst in ipairs(obstacles) do
		result = result..'\r\n|-'
		result = result..'\r\n|'
		if catLog[obst.category] == nil then
			local rowspan = catCounts[obst.category]
			result = result..'rowspan="'..rowspan..'" style="border:1px solid black"|'..(obst.category + 1)..'||'
			catLog[obst.category] = true
		end
		result = result..obst.name

		local bonuses = {}
		--After that, adding the bonuses
		for bonusName, bonusValue in pairs(obst.modifiers) do
			table.insert(bonuses, Constants._getModifierText(bonusName, bonusValue))
		end
		if Shared.tableIsEmpty(bonuses) then
			table.insert(bonuses, '<span style="color:red">None :(</span>')
		end
		result = result..'||'..table.concat(bonuses, '<br/>')

		--Grabbing requirements to create
		result = result..'|| ' .. formatObstacleRequirements(obst)

		--Finally, the cost
		result = result..'|| data-sort-value="'..obst.gpCost..'"|'.. formatObstacleCosts(obst)
	end

	result = result..'\r\n|}'

	return result
end

function p.getCourseTable(frame)
	local obstNameStr = frame.args ~= nil and frame.args[1] or frame
	local obstacleNames = Shared.splitString(obstNameStr, ',')
	
	return p._getCourseTable(obstacleNames)
end

return p