Module:PotionList

From Brighter Shores Wiki
Revision as of 10:00, 28 November 2024 by Artoire (talk | contribs) (Use multiple rows for multiple reagents)
Jump to navigation Jump to search
Module documentation
This documentation is transcluded from Module:PotionList/doc. [edit] [history] [purge]
This module does not have any documentation. Please consider adding documentation at Module:PotionList/doc. [edit]
Module:PotionList's function main is invoked by Template:PotionList.
Module:PotionList requires Module:Currency.
Module:PotionList requires Module:Mw.html extension.
Module:PotionList requires Module:Paramtest.
require('Module:Mw.html extension')
local param = require('Module:Paramtest')
local currency = require('Module:Currency')
local lang = mw.getContentLanguage()


local p = {}

-- non dynamic module, no inputs
function p.main()

	-- returns almost every parameter needed for the row, except buy values for reagents
	local query = {
		'[[Category:Potions]]',
		'[[Uses facility::Standard Potion Station||Potent Potion Station]]',
		'?Profession Level A = lvl',
		'? #- = name',
		'?Uses item.Uses item #- = reagents',
		'?Value = sell',
		'?Activity XP = brewXP',
		'?Uses item.Activity XP = prepXP',
		'?Activity KP = brewKP',
		'?Uses item.Activity KP = prepKP',
		'?Activity duration = brewDuration',
		'?Uses item.Activity duration = prepDuration',
		'sort = Profession Level A'
	}
	local results = mw.smw.ask(query)

	results = p.formatResults(results)

	return p.displayTable(results)

end

-- makes the html for the cells containing currency directly
-- Replaces nil with an "unknown" cell
local function currency_cell(amount, rowspan)
	rowspan = rowspan or 1
	if rowspan <= 1 then rowspan = nil end
	if not amount then
		return tostring(mw.html.create('td')
			:addClass('table-bg-gray')
			:css{ ['text-align'] = 'center' }
			:attr{ colspan = '10', rowspan = rowspan }
			:wikitext("''unknown''")
		:done())
	end
	return currency._cell(amount, { html = 'yes', rowspan = rowspan })
end

-- do calculations and determine strings to go in cells
function p.formatResults(results)

	-- iterate through potions
	for i, item in ipairs(results) do

		--in case of single reagent potions, make table of 1 element
		if type(item.reagents) ~= 'table' then
			item.reagents = {item.reagents}
		end

		-- iterate through reagents, adding buy price to running total (individuals not needed)
		-- starting value 20 is for bottle
		item.buy = 20
		for j, reagent in ipairs(item.reagents) do

			--shamelessley lifted from Module:Products
			local shopPriceQuery = '[[:+]][[Sold item::' .. reagent .. ']]|?Shop buy price|mainlabel=' .. reagent
			local shopPriceResult = mw.smw.ask(shopPriceQuery) or {}
			local shopPrice = 0

			if shopPriceResult[1] and shopPriceResult[1]["Shop buy price"] then
				shopPrice = tonumber(shopPriceResult[1]["Shop buy price"]) or 0
			end

			item.buy = item.buy + shopPrice
		end

		-- sanitise data, set to 0 if its not there
		local lvl = item.lvl or '?'
		local buy = item.buy or 0
		local sell = item.sell or 0
		local brewXP = item.brewXP or 0
		local prepXP = item.prepXP or 0
		local brewKP = item.brewKP or 0
		local prepKP = item.prepKP or 0
		local brewDuration = item.brewDuration or 0
		local prepDuration = item.prepDuration or 0

		-- direct values
		item.profit = item.sell and item.buy and item.sell - item.buy
		item.XP = item.brewXP and item.prepXP and item.brewXP + item.prepXP
		item.KP = item.brewKP and item.prepKP and item.brewKP + item.prepKP
		item.profitPerXP = item.profit and item.XP and math.floor(item.profit / item.XP * 100) / 100

		-- 40 seconds to buy new supplies and travel and deposit and everything, per 12 potions
		local batchSize = 12
		local downtime = 40
		item.duration = item.prepDuration and item.brewDuration and item.prepDuration + item.brewDuration + downtime/batchSize
		item.potionPerHour = item.duration and 1 / item.duration * 3600

		-- properties per hour
		item.XPPerHour = item.XP and item.potionPerHour and math.floor(item.XP * item.potionPerHour)
		item.KPPerHour = item.KP and item.potionPerHour and math.floor(item.KP * item.potionPerHour) / 100
		item.profitPerHour = item.profit and item.potionPerHour and math.floor(item.profit * item.potionPerHour)
	end

	return results
end

-- make the table
function p.displayTable(results)

	local out = mw.html.create('table')
		:addClass('wikitable sortable')
		:tag('tr')
			:tag('th')
				:wikitext('[[File:Alchemist small icon.png|15px]]  Level')
			:done()
			:tag('th')
				:wikitext('Potion')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Reagents (plus bottle)')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Buy Value')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Sell Value')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Profit')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Profit/hr')
			:done()
			:tag('th')
				:wikitext('XP')
			:done()
			:tag('th')
				:wikitext('XP/hr')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Coins/XP')
			:done()
		:done()

	for i,item in ipairs(results) do
		local rowspan = #item.reagents
		local function createReagentCell(i)
			local reagent = item.reagents[i]
			local bottom_padding
			local top_padding
			if i ~= 1 then top_padding = '0' end
			if i ~= rowspan then bottom_padding = '0' end

			return tostring(mw.html.create('td')
				:addClass('plinkt-image no-border')
				:css{
					['border-top'] = top_padding,
					['padding-top'] = top_padding,
					['border-bottom'] = bottom_padding,
					['padding-bottom'] = bottom_padding
				}
				:tag('span')
					:addClass('inventory-image')
					:wikitext(('[[File:%s.png|x30px|link=%s]]'):format(reagent, reagent))
				:done()
			:done()) .. tostring(mw.html.create('td')
				:addClass('plinkt-link no-border')
				:css{
					['border-top'] = top_padding,
					['padding-top'] = top_padding,
					['border-bottom'] = bottom_padding,
					['padding-bottom'] = bottom_padding
				}
				:wikitext(('[[%s]]'):format(reagent))
			:done())
		end

		local unknown_value_cell = mw.html.create('td')
			:addClass('table-bg-gray')
			:css{ ['text-align'] = 'center' }
			:attr{ rowspan = rowspan }
			:wikitext("''unknown''")

		out:tag('tr')
			:IF(item.lvl)
				:tag('td')
					:css{ ['text-align'] = 'center' }
					:attr{ rowspan = rowspan }
					:wikitext(item.lvl)
				:done()
			:ELSE()
				:node(unknown_value_cell)
			:END()

			:tag('td')
				:attr{ rowspan = rowspan }
				:wikitext('[[File:' .. item.name .. '.png|30px|link=' .. item.name .. ']] [[' .. item.name .. ']]')
			:done()

			:wikitext(createReagentCell(1))

			:wikitext(currency_cell(item.buy, rowspan))

			:wikitext(currency_cell(item.sell, rowspan))

			:wikitext(currency_cell(item.profit, rowspan))

			:wikitext(currency_cell(item.profitPerHour, rowspan))

			:IF(item.XP)
				:tag('td')
					:attr{ rowspan = rowspan }
					:wikitext(item.XP and lang:formatNum(tonumber(item.XP)))
				:done()
			:ELSE()
				:node(unknown_value_cell)
			:END()

			:IF(item.XPPerHour)
				:tag('td')
					:attr{ rowspan = rowspan }
					:wikitext(item.XPPerHour and lang:formatNum(tonumber(item.XPPerHour)))
				:done()
			:ELSE()
				:node(unknown_value_cell)
			:END()

			:wikitext(currency_cell(item.profitPerXP, rowspan))

		:done()

		for i = 2, rowspan do
			out:tag('tr')
				:wikitext(createReagentCell(i))
			:done()
		end
	end

	return out
end

return p
Retrieved from ‘https://brightershoreswiki.org/w/Module:PotionList?oldid=49590’