Module:AlchemistList: Difference between revisions

From Brighter Shores Wiki
Jump to navigation Jump to search
Content added Content deleted
m (Spaces to tabs)
m (Alsang moved page Module:PotionList to Module:AlchemistList without leaving a redirect: match the naming convention of the other "List" modules)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
require('strict')
require('Module:Mw.html extension')
require('Module:Mw.html extension')
local search = require('Module:RecipeTreeSearch')
local param = require( 'Module:Paramtest' )
local param = require( 'Module:Paramtest' )
local currency = require('Module:Currency')
local currency = require('Module:Currency')
local lang = mw.getContentLanguage()
local lang = mw.getContentLanguage()
require("Module:Mw.html extension")



local p = {}
local p = {}
Line 10: Line 10:
-- non dynamic module, no inputs
-- non dynamic module, no inputs
function p.main()
function p.main()
-- returns only directly needed parameter needed for the row,
-- other parameters are determined by subqueries of chained pages
-- returns almost every parameter needed for the row, except buy values for reagents
local query = {
local query = {
'[[Category:Potions]]',
'[[Uses facility::Standard Potion Station||Potent Potion Station]]',
'[[Uses facility::Standard Potion Station||Potent Potion Station]]',
'?Profession Level A = lvl',
'?Profession Level A = lvl',
'? #- = name',
'? #- = name',
'?Uses item.Uses item #- = reagents',
'?Recipe JSON = recipeJSON',
'?Activity XP = XP',
'?Activity duration = duration',
'?Value = sell',
'?Value = sell',
'?Activity XP = brewXP',
'sort = Profession Level A',
'limit = 500'
'?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)
local results = mw.smw.ask(query)

results = p.formatResults(results)
results = p.formatResults(results)


return p.displayTable(results)
return p.displayTable(results)
--for debugging
--return '<pre>'..mw.text.jsonEncode(results, mw.text.JSON_PRETTY)..'</pre>'

end
end


-- makes the html for the cells containing currency directly, no tags needed
-- makes the html for the cells containing currency directly
-- Replaces nil with an "unknown" cell
-- flag is for if the number should not be known, replaces with zero
local function currency_cell(amount)
local function currency_cell(amount)
if not amount then
return mw.html.create('td')
:addClass('table-bg-gray')
:css{ ['text-align'] = 'center' }
:attr{ colspan = '10' }
:wikitext("''unknown''")
:done()
end
return currency._cell(amount, { html = 'yes' })
return currency._cell(amount, { html = 'yes' })
end
end
Line 44: Line 51:
function p.formatResults(results)
function p.formatResults(results)


-- iterate through potions
-- iterate through products
for i, item in ipairs(results) do
for _, item in ipairs(results) do
-- New module for recipe searching
--in case of single reagent potions, make table of 1 element
local fullRecipe = search.main(item.name)
if type(item.reagents) ~= 'table' then
item.reagents = {item.reagents}
item.materials = fullRecipe.materials
item.outputQuantity = fullRecipe.output[1].quantity
end
item.buy = fullRecipe.buyPrice
item.XP = fullRecipe.xp
-- iterate through reagents, adding buy price to running total (individuals not needed)
item.duration = fullRecipe.duration
-- 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
-- direct values
item.sell = item.sell and item.outputQuantity and item.sell * item.outputQuantity
item.profit = sell - buy
item.XP = brewXP + prepXP
item.profit = item.sell and item.buy and item.sell - item.buy
item.profitPerXP = item.profit and item.XP and math.floor(item.profit / item.XP * 100) / 100
item.KP = brewKP + prepKP
item.profitPerXP = math.floor(item.profit / item.XP * 100) / 100


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

-- properties per hour
-- properties per hour
item.XPPerHour = math.floor(item.XP * item.potionPerHour)
item.XPPerHour = item.XP and item.productPerHour and math.floor(item.XP * item.productPerHour)
item.KPPerHour = math.floor(item.KP * item.potionPerHour) / 100
item.profitPerHour = item.profit and item.productPerHour and math.floor(item.profit * item.productPerHour)
item.profitPerHour = math.floor(item.profit * item.potionPerHour)
-- flags for if data values should be shown
item.hasLvl = param.has_content(item.lvl)
item.hasBuy = param.has_content(item.buy)
item.hasSell = param.has_content(item.sell)
item.hasProfit = item.hasBuy and item.hasSell
item.hasXP = param.has_content(item.brewXP) and param.has_content(item.prepXP)
item.hasKP = param.has_content(item.brewKP) and param.has_content(item.prepKP)
item.hasDuration = param.has_content(item.brewDuration) and param.has_content(item.prepDuration)
end
end


Line 114: Line 83:
-- make the table
-- make the table
function p.displayTable(results)
function p.displayTable(results)
local out = mw.html.create('table')
local out = mw.html.create('table')
:addClass('wikitable sortable')
:addClass('wikitable sortable')
Line 122: Line 90:
:done()
:done()
:tag('th')
:tag('th')
:wikitext('Potion')
:attr{ colspan = '3' }
:wikitext('Product')
:done()
:done()
:tag('th')
:tag('th')
:wikitext('Reagents (plus bottle)')
:wikitext('Materials')
:done()
:done()
:tag('th')
:tag('th')
Line 154: Line 123:
:done()
:done()
:done()
:done()

local unknown_value_cell = mw.html.create('td')
:addClass('table-bg-gray')
for i,item in ipairs(results) do
:css{ ['text-align'] = 'center' }
:wikitext("''unknown''")
-- need to generate the text for the reagent cell before starting the row

local reagentCell = ''
for j, reagent in ipairs(item.reagents) do
for i, item in ipairs(results) do
local row = out:tag('tr')
reagentCell = reagentCell .. '[[File:' .. reagent .. '.png|30px|link=' .. reagent .. ']] [[' .. reagent .. ']]<br>'
:IF(item.lvl)
end
:tag('td')
out
:tag('tr')
:tag('td')
:IF(item.hasBuy)
:css{ ['text-align'] = 'center' }
:css{ ['text-align'] = 'center' }
:wikitext(item.lvl)
:wikitext(item.lvl)
:ELSE()
:done()
:ELSE()
:addClass('table-bg-grey')
:node(unknown_value_cell)
:css{ ['text-align'] = 'center' }
:wikitext('unknown')
:END()

:END()
:tag('td')
:css{ ['border-right'] = '0', ['padding-right'] = '0', ['text-align'] = 'right' }
:attr{ ['data-sort-value'] = item.name }
:wikitext(item.outputQuantity .. ' &times;')
:done()
:done()
:tag('td')
:tag('td')
:addClass('plinkt-image no-border')
:wikitext('[[File:' .. item.name .. '.png|30px|link=' .. item.name .. ']] [[' .. item.name .. ']]')
:css{ ['border-left'] = '0', ['padding-left'] = '0' }
:wikitext('[[File:' .. item.name .. '.png|link=' .. item.name .. '|30px]]')
:done()
:done()
:tag('td')
:tag('td')
:addClass('plinkt-link no-border')
:wikitext(reagentCell)
:wikitext('[[' .. item.name .. ']]')
:done()
:done()

local materialCell = row:tag('td')
:IF(item.hasBuy)

:wikitext(currency_cell(item.buy))
for i, _ in ipairs(item.materials) do
:ELSE()
materialCell:wikitext(item.materials[i].quantity .. '&times; [[File:' .. item.materials[i].name .. '.png|18px|link=' .. item.materials[i].name .. ']] [[' .. item.materials[i].name .. ']]<br>')
end
row
:node(currency_cell(item.buy))
:node(currency_cell(item.sell))
:node(currency_cell(item.profit))
:node(currency_cell(item.profitPerHour))

:IF(item.XP)
:tag('td')
:tag('td')
:wikitext(item.XP and lang:formatNum(tonumber(item.XP)))
:addClass('table-bg-grey')
:attr{ colspan = '10' }
:css{ ['text-align'] = 'center' }
:wikitext('unknown')
:done()
:done()
:END()
:IF(item.hasSell)
:wikitext(currency_cell(item.sell))
:ELSE()
:ELSE()
:tag('td')
:node(unknown_value_cell)
:addClass('table-bg-grey')
:attr{ colspan = '10' }
:css{ ['text-align'] = 'center' }
:wikitext('unknown')
:done()
:END()
:END()

:IF(item.hasProfit)
:IF(item.XPPerHour)
:wikitext(currency_cell(item.profit))
:ELSE()
:tag('td')
:tag('td')
:wikitext(item.XPPerHour and lang:formatNum(tonumber(item.XPPerHour)))
:addClass('table-bg-grey')
:attr{ colspan = '10' }
:css{ ['text-align'] = 'center' }
:wikitext('unknown')
:done()
:done()
:END()
:IF(item.hasProfit and item.hasDuration)
:wikitext(currency_cell(item.profitPerHour))
:ELSE()
:ELSE()
:tag('td')
:node(unknown_value_cell)
:addClass('table-bg-grey')
:attr{ colspan = '10' }
:css{ ['text-align'] = 'center' }
:wikitext('unknown')
:done()
:END()
:END()

:node(currency_cell(item.profitPerXP))
:tag('td')

:IF(item.hasXP)
:wikitext(lang:formatNum(tonumber(item.XP)))
:ELSE()
:addClass('table-bg-grey')
:css{ ['text-align'] = 'center' }
:wikitext('unknown')
:END()
:done()
:tag('td')
:IF(item.hasXP and item.hasDuration)
:wikitext(lang:formatNum(tonumber(item.XPPerHour)))
:ELSE()
:addClass('table-bg-grey')
:css{ ['text-align'] = 'center' }
:wikitext('unknown')
:END()
:done()
:IF(item.hasXP and item.hasProfit)
:wikitext(currency_cell(item.profitPerXP))
:ELSE()
:tag('td')
:addClass('table-bg-grey')
:attr{ colspan = '10' }
:css{ ['text-align'] = 'center' }
:wikitext('unknown')
:done()
:END()
:done()
:done()
end
end

return out
return out
end
end

Latest revision as of 23:02, 16 December 2024

Module documentation
This documentation is transcluded from Module:AlchemistList/doc. [edit] [history] [purge]
This module does not have any documentation. Please consider adding documentation at Module:AlchemistList/doc. [edit]
Module:AlchemistList's function main is invoked by Template:AlchemistList.
Module:AlchemistList requires Module:Currency.
Module:AlchemistList requires Module:Mw.html extension.
Module:AlchemistList requires Module:Paramtest.
Module:AlchemistList requires Module:RecipeTreeSearch.
Module:AlchemistList requires strict.

require('strict')
require('Module:Mw.html extension')
local search = require('Module:RecipeTreeSearch')
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 only directly needed parameter needed for the row,
	-- other parameters are determined by subqueries of chained pages
	local query = {
		'[[Uses facility::Standard Potion Station||Potent Potion Station]]',
		'?Profession Level A = lvl',
		'? #- = name',
		'?Recipe JSON = recipeJSON',
		'?Activity XP = XP',
		'?Activity duration = duration',
		'?Value = sell',
		'sort = Profession Level A',
		'limit = 500'
	}
	local results = mw.smw.ask(query)

	results = p.formatResults(results)

	return p.displayTable(results)
	
	--for debugging
	--return '<pre>'..mw.text.jsonEncode(results, mw.text.JSON_PRETTY)..'</pre>'

end

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

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

	-- iterate through products
	for _, item in ipairs(results) do
		
		-- New module for recipe searching
		local fullRecipe = search.main(item.name)
		item.materials = fullRecipe.materials
		item.outputQuantity = fullRecipe.output[1].quantity
		item.buy = fullRecipe.buyPrice
		item.XP = fullRecipe.xp
		item.duration = fullRecipe.duration
		
		-- direct values
		item.sell = item.sell and item.outputQuantity and item.sell * item.outputQuantity
		item.profit = item.sell and item.buy and item.sell - item.buy
		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.duration and item.duration + downtime/batchSize
		item.productPerHour = item.duration and 1 / item.duration * 3600

		-- properties per hour
		item.XPPerHour = item.XP and item.productPerHour and math.floor(item.XP * item.productPerHour)
		item.profitPerHour = item.profit and item.productPerHour and math.floor(item.profit * item.productPerHour)
	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')
				:attr{ colspan = '3' }
				:wikitext('Product')
			:done()
			:tag('th')
				:wikitext('Materials')
			: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()

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

	for i, item in ipairs(results) do
		local row = out:tag('tr')
			:IF(item.lvl)
				:tag('td')
					:css{ ['text-align'] = 'center' }
					:wikitext(item.lvl)
				:done()
			:ELSE()
				:node(unknown_value_cell)
			:END()

			:tag('td')
				:css{ ['border-right'] = '0', ['padding-right'] = '0', ['text-align'] = 'right' }
				:attr{ ['data-sort-value'] = item.name }
				:wikitext(item.outputQuantity .. ' &times;')
			:done()
			:tag('td')
				:addClass('plinkt-image no-border')
				:css{ ['border-left'] = '0', ['padding-left'] = '0' }
				:wikitext('[[File:' .. item.name .. '.png|link=' .. item.name .. '|30px]]')
			:done()
			:tag('td')
				:addClass('plinkt-link no-border')
				:wikitext('[[' .. item.name .. ']]')
			:done()

		local materialCell = row:tag('td')

		for i, _ in ipairs(item.materials) do
			materialCell:wikitext(item.materials[i].quantity .. '&times; [[File:' .. item.materials[i].name .. '.png|18px|link=' .. item.materials[i].name .. ']] [[' .. item.materials[i].name .. ']]<br>')
		end
		
		row
			:node(currency_cell(item.buy))
			:node(currency_cell(item.sell))
			:node(currency_cell(item.profit))
			:node(currency_cell(item.profitPerHour))

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

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

			:node(currency_cell(item.profitPerXP))

		:done()
	end

	return out
end

return p