Module:CarpenterList

Module documentation

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

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

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

Module:CarpenterList requires Module:Mw.html extension.

Module:CarpenterList requires Module:ProfessionList.

Module:CarpenterList requires Module:Purge.

Module:CarpenterList requires strict.

---

require('strict')
require('Module:Mw.html extension')
local lang = mw.getContentLanguage()
local plist = require('Module:ProfessionList')
local purge = require('Module:Purge')._purge

local p = {}

-- non dynamic module, no inputs
function p.main()
	
	local queryString = '[[Category:Carpenter]] AND [[Category:Pages with recipes]]'
	
	local function screenFunction(item)
		local product = (item.output and item.output[1] and item.output[1].name) or ''
		return not (item.passive or string.find(product,'Post'))
	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
		
		-- list of all pages to edit, if edit is needed
		item.allPageEdits = { item.pageName }
		for _,intermediate in ipairs(item.intermediateMaterials) do
			table.insert(item.allPageEdits,intermediate.name)
		end
		
		-- poles will show as making 1 and using 0.5 log, which doesnt match the look of planks or staves
		-- double them, 
		if item.pageName and string.find(item.pageName,'Pole') then
			item.output[1].quantity = item.output and item.output[1] and item.output[1].quantity and item.output[1].quantity * 2
			item.buyPrice = item.buyPrice and item.buyPrice * 2
			item.sellPrice = item.sellPrice and item.sellPrice * 2
			item.profit = item.profit and item.profit * 2
			item.xp = item.xp and item.xp * 2
			item.duration = item.duration and item.duration * 2
			
			for j,jtem in ipairs(item.materials) do
				jtem.quantity = jtem.quantity and jtem.quantity * 2
			end
		end

		-- profitability
		item.profitPerXP = item.profit and item.xp and item.profit / item.xp
		
		-- 40 seconds to buy new supplies and travel and deposit and everything, per 12 potions
		local batchSize = 12
		local downtime = 60
		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)
	
	--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('caption')
			:wikitext('This list is updated dynamically. '..purge())
		:done()
		:tag('tr')
			:tag('th')
				:wikitext('[[File:Carpenter 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
			:node(plist.one_column_image_text(item.materials))
			:node(plist.currency_cell(item.buyPrice))
			:node(plist.currency_cell(item.sellPrice))
			:node(plist.currency_cell(item.profit))
			: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.allPageEdits,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