Module:LeatherworkerList

Module documentation

This documentation is transcluded from Module:LeatherworkerList/doc. [edit] [history] [purge]

This module does not have any documentation. Please consider adding documentation at Module:LeatherworkerList/doc. [edit]

Module:LeatherworkerList's function main is invoked by Template:LeatherworkerList.

Module:LeatherworkerList requires 6 modules

1. Module:Currency
2. Module:MerchantHideDiscount
3. Module:Mw.html extension
4. Module:Paramtest
5. Module:RecipeTreeSearch
6. strict

.

---

require('strict')
require('Module:Mw.html extension')
local search = require('Module:RecipeTreeSearch')
local param = require( 'Module:Paramtest' )
local currency = require('Module:Currency')
local discount = require('Module:MerchantHideDiscount')
local lang = mw.getContentLanguage()

local p = {}

-- non dynamic module, no inputs
function p.main()
	
	-- main query returns only directly needed parameter needed for the row,
	-- other parameters are determined by subqueries of chained pages
		local query = {
		'[[-Sold item.Sold by::Leather stall]]',
		'[[Recipe JSON::~*]]', -- the stall sells scraps and we need to ignore those
		'?Uses facility #- = facility',
		'?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)
	
	-- criterion for if an entry is a recipe, or a passive activity
	for _, item in ipairs(results) do
		item.passiveActivity = false -- no passives in this list
	end
	
	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
		
		-- discounted buy price is not included by the RecipeTreeSearch module, have to do it manually
		item.buyDiscount = 0
		for _, material in ipairs(item.materials) do
		
			--with the merchant discount, buy price is sell price
			local shopPriceQuery = '[[:+]][[Sold item::' .. material.name .. ']]|?Shop sell price|mainlabel=' .. material.name
			local shopPriceResult = mw.smw.ask(shopPriceQuery) or {}
			local shopPrice = 0		
			
			if shopPriceResult[1] and shopPriceResult[1]["Shop sell price"] then
				shopPrice = tonumber(shopPriceResult[1]["Shop sell price"]) or 0
			else
				item.buyDiscount = nil
			end

			item.buyDiscount = item.buyDiscount and item.buyDiscount + shopPrice * material.quantity
			
		end
		
		-- 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.profitDiscount = item.sell and item.buyDiscount and item.sell - item.buyDiscount
		item.profitPerXP = item.profit and item.XP and math.floor(item.profit / item.XP * 100) / 100
		item.profitPerXPDiscount = item.profitDiscount and item.XP and math.floor(item.profitDiscount / item.XP * 100) / 100
		local hideName = string.gsub(item.name,'Leather','Hide')
		item.discountLevel = discount[hideName]

		-- a lot of downtime in leatherworker, but large batch sizes
		-- 1min 40s to go from hide stall to tannery, run round the tannery, run to leather stall, then back to hide stall
		local batchSize = 24
		local downtime = 100
		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)
		item.profitPerHourDiscount = item.profitDiscount and item.productPerHour and math.floor(item.profitDiscount * 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:Leatherworker 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('Profit/item')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Profit/hr')
			:done()
			:tag('th')
				:wikitext('[[File:Merchant_small_icon.png|18px]] level<br>for discount')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Profit/hr with [[File:Merchant_small_icon.png|18px]] discount')
			:done()
			:tag('th')
				:wikitext('XP')
			:done()
			:tag('th')
				:wikitext('XP/hr')
			: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()
			
		:IF(not(item.passiveActivity))

			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|30px|link=' .. item.materials[i].name .. ']] [[' .. item.materials[i].name .. ']]<br>')
			end
			
			row

		:ELSE()
			:tag('td')
				:addClass('table-na')
				:attr{ colspan = '21' }
				:wikitext('N/A')
			:done()
		:END()	
			
		
			:node(currency_cell(item.profit))
			:node(currency_cell(item.profitPerHour))
			
			:tag('td')
				:css{ ['text-align'] = 'center' }
				:wikitext(item.discountLevel)
			:done()
			:node(currency_cell(item.profitPerHourDiscount))

			: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()

		:done()
	end

	return out
end

return p