Module:AlchemistPassiveList: Difference between revisions

From Brighter Shores Wiki
Jump to navigation Jump to search
Content added Content deleted
m (Alsang moved page Module:PassivePotionList to Module:AlchemistPassiveList without leaving a redirect: match the naming convention of the other "List" modules)
(offload much of the search, screen, and format functions to the new ProfessionList module, so they work the same for all table)
Line 1: Line 1:
require('strict')
require('strict')
require('Module:Mw.html extension')
require('Module:Mw.html extension')
local param = require( 'Module:Paramtest' )
local currency = require('Module:Currency')
local lang = mw.getContentLanguage()
local lang = mw.getContentLanguage()
local plist = require('Module:ProfessionList')
local rts = require('Module:RecipeTreeSearch')


local p = {}
local p = {}
Line 9: Line 9:
-- 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
local query = {
'[[Uses facility::Passive Potion Station]] OR [[Variant of::Ebsworth Work]]',
'?Variant of #- = variant',
'?Profession Level A = lvl',
'? #- = name',
'?Recipe JSON = recipeJSON',
'?Activity XP = XP',
'?Activity duration = duration',
'?Value = sell',
'?Activity coins = coins',
'sort = Profession Level A',
'limit = 500'
}
local results = mw.smw.ask(query)
local queryString = '[[Category:Alchemist]] AND [[Category:Pages with recipes]] OR [[Category:Pages with activities]]'
-- criterion for if an entry is a recipe, or a passive activity
for _, item in ipairs(results) do
local function screenFunction(item)
item.passiveActivity = item.variant=='Ebsworth Work'
return item.passive
end
end
local results = plist.generate_recipe_table(queryString,screenFunction)

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


Line 38: Line 25:
--return '<pre>'..mw.text.jsonEncode(results, mw.text.JSON_PRETTY)..'</pre>'
--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
end


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

--simple check for nil results
if results ==nil or results[1] == nil then
return nil
end
-- iterate through products
-- iterate through products
for _, item in ipairs(results) do
for _, item in ipairs(results) do
-- Ebsworth work
-- recipe in a workable format
if item.passiveActivity then
if item.type=='activity' then
item.profit = item.coins
-- if it is a passive activity that is not a recipe
-- some fields are easy to work out
item.outputQuantity = 1
item.materials = {}
item.intermediates = {}
item.buy = 0
item.sell = item.coins

else
local unpackJSON = mw.text.jsonDecode(item.recipeJSON)
item.outputQuantity = unpackJSON.output[1].quantity
-- SECTION REMOVED
-- do not need to extensively search for subrecipes, as passive recipe
-- passive recipes only ever have one step
item.materials = unpackJSON.materials
-- iterate through materials, adding buy price to running total (individuals not needed)
item.buy = 0
for _, material in ipairs(item.materials) do
--shamelessley lifted from Module:Products
local shopPriceQuery = '[[:+]][[Sold item::' .. material.name .. ']]|?Shop buy price|mainlabel=' .. material.name
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
else
item.buy = nil
end
item.buy = item.buy and item.buy + shopPrice * material.quantity
end
end
end
-- direct values
-- profitability
item.sell = item.sell and item.outputQuantity and item.sell * item.outputQuantity
item.profitPerXP = item.profit and item.xp and item.profit / item.xp
item.profit = item.sell and item.buy and item.sell - item.buy
-- no downtime for passives
item.profitPerXP = item.profit and item.XP and math.floor(item.profit / item.XP * 100) / 100

-- products made in 200 lots of 0.005, no downtime for passive activities
local batchSize = 200
local downtime = 0
item.duration = item.duration and item.duration + downtime/batchSize
item.productPerHour = item.duration and 1 / item.duration * 3600
item.productPerHour = item.duration and 1 / item.duration * 3600


-- properties per hour
-- properties per hour
item.XPPerHour = item.XP and item.productPerHour and math.floor(item.XP * item.productPerHour)
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)
item.profitPerHour = item.profit and item.productPerHour and math.floor(item.profit * item.productPerHour)
end
end
Line 123: Line 59:
-- make the table
-- make the table
function p.displayTable(results)
function p.displayTable(results)
--simple check for nil results
if results ==nil or results[1] == nil then
return 'No data found for table'
end
local out = mw.html.create('table')
local out = mw.html.create('table')
:addClass('wikitable sortable')
:addClass('wikitable sortable')
Line 131: Line 73:
:tag('th')
:tag('th')
:attr{ colspan = '3' }
:attr{ colspan = '3' }
:wikitext('Product')
:wikitext('Products')
:done()
:done()
:tag('th')
:tag('th')
Line 163: Line 105:
:done()
:done()
: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
for i, item in ipairs(results) do
local row = out:tag('tr')
local row = out:tag('tr')
:IF(item.lvl)
--level
:IF(item.level)
:tag('td')
:tag('td')
:css{ ['text-align'] = 'center' }
:css{ ['text-align'] = 'center' }
:wikitext(item.lvl)
:wikitext(item.level)
:done()
:done()
:ELSE()
:ELSE()
:node(plist.unknown_value_edit_cell(item.pageName,1))
:node(unknown_value_cell)
: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()
: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()
-- recipe
:IF(not(item.passiveActivity))
:node(plist.three_column_image_text(item.product,item.output[1].quantity,'File:' .. item.product .. '.png',item.product,item.product))

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
-- materials
row
:node(currency_cell(item.buy))
:IF(item.type=='recipe')
:node(currency_cell(item.sell))
:node(plist.one_column_image_text(item.materials))
:node(plist.currency_cell(item.buyPrice))
:node(plist.currency_cell(item.sellPrice))
:ELSE()
:tag('td')
:ELSE()
:addClass('table-na')
:tag('td')
:attr{ colspan = '21' }
:addClass('table-na')
:css{ ['text-align'] = 'center' }
:wikitext('N/A')
:attr{ colspan = '21' }
:done()
:END()
:wikitext('N/A')
:done()
:END()
:IF(item.type=='activity' and not item.profit)
:node(plist.unknown_value_edit_cell(item.pageName,10))
:ELSE()
:node(plist.currency_cell(item.profit))
:END()
:node(currency_cell(item.profit))
:node(plist.currency_cell(item.profitPerHour))
:node(currency_cell(item.profitPerHour))


:IF(item.XP)
-- XP
:IF(item.xp)
:tag('td')
:tag('td')
:wikitext(item.XP and lang:formatNum(tonumber(item.XP)))
:wikitext(item.xp and lang:formatNum(tonumber(item.xp)))
:done()
:done()
:ELSE()
:ELSE()
:node(plist.unknown_value_edit_cell(item.pageName,1))
:node(unknown_value_cell)
:END()
:END()

-- XP per hour
:IF(item.XPPerHour)
:IF(item.xpPerHour)
:tag('td')
:tag('td')
:wikitext(item.XPPerHour and lang:formatNum(tonumber(item.XPPerHour)))
:wikitext(item.xpPerHour and lang:formatNum(tonumber(item.xpPerHour)))
:done()
:done()
:ELSE()
:ELSE()
:node(unknown_value_cell)
:node(plist.unknown_value_cell(1))
:END()
:END()

-- XP per hour
:node(currency_cell(item.profitPerXP))
:node(plist.currency_cell(item.profitPerXP))

:done()
:done()
end
end

Revision as of 20:57, 19 December 2024

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

require('strict')
require('Module:Mw.html extension')
local lang = mw.getContentLanguage()
local plist = require('Module:ProfessionList')
local rts = require('Module:RecipeTreeSearch')

local p = {}

-- non dynamic module, no inputs
function p.main()
	
	local queryString = '[[Category:Alchemist]] AND [[Category:Pages with recipes]] OR [[Category:Pages with activities]]'
	
	local function screenFunction(item)
		return item.passive
	end
	
	local results = plist.generate_recipe_table(queryString,screenFunction)

	results = p.formatResults(results)

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

end

-- do calculations and determine strings to go in cells
function p.formatResults(results)
	
	--simple check for nil results
	if results ==nil or results[1] == nil then
		return nil
	end
	
	-- iterate through products
	for _, item in ipairs(results) do
		
		-- Ebsworth work
		if item.type=='activity' then
			item.profit = item.coins
		end
		
		-- profitability
		item.profitPerXP = item.profit and item.xp and item.profit / item.xp
		
		-- no downtime for passives
		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)
	
	--simple check for nil results
	if results ==nil or results[1] == nil then
		return 'No data found for table'
	end
	
	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('Products')
			: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()

	for i, item in ipairs(results) do
		local row = out:tag('tr')
		
			--level
			:IF(item.level)
				:tag('td')
					:css{ ['text-align'] = 'center' }
					:wikitext(item.level)
				:done()
			:ELSE()
				:node(plist.unknown_value_edit_cell(item.pageName,1))
			:END()
			
			-- recipe
			:node(plist.three_column_image_text(item.product,item.output[1].quantity,'File:' .. item.product .. '.png',item.product,item.product))
			
			-- materials
			:IF(item.type=='recipe')
				:node(plist.one_column_image_text(item.materials))
				:node(plist.currency_cell(item.buyPrice))
				:node(plist.currency_cell(item.sellPrice))
			:ELSE()
				:tag('td')
					:addClass('table-na')
					:css{ ['text-align'] = 'center' }
					:attr{ colspan = '21' }
					:wikitext('N/A')
				:done()
			:END()
			
			:IF(item.type=='activity' and not item.profit)
				:node(plist.unknown_value_edit_cell(item.pageName,10))
			:ELSE()
				:node(plist.currency_cell(item.profit))
			:END()
			
			
			:node(plist.currency_cell(item.profitPerHour))

			-- XP
			:IF(item.xp)
				:tag('td')
					:wikitext(item.xp and lang:formatNum(tonumber(item.xp)))
				:done()
			:ELSE()
				:node(plist.unknown_value_edit_cell(item.pageName,1))
			:END()
			
			-- XP per hour
			:IF(item.xpPerHour)
				:tag('td')
					:wikitext(item.xpPerHour and lang:formatNum(tonumber(item.xpPerHour)))
				:done()
			:ELSE()
				:node(plist.unknown_value_cell(1))
			:END()
			
			-- XP per hour
			:node(plist.currency_cell(item.profitPerXP))
			
		:done()
	end

	return out
end

return p