Module:ChefList

Module documentation

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

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

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

Module:ChefList requires Module:Mw.html extension.

Module:ChefList requires Module:ProfessionList.

Module:ChefList requires Module:Purge.

Module:ChefList 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:Chef]] AND [[Category:Pages with recipes]] AND [[-Sold item.Sold by::Head Chef (shop)]]'
	
	local function screenFunction(item)
		return not 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
		
		-- 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

		-- profitability
		item.profitPerXP = item.profit and item.xp and item.profit / item.xp
		
		-- iterate through materials, keep track of how many materials are needed from each shop
		item.fishShopTrips = 0
		item.vegShopTrips = 0
		for _, material in ipairs(item.materials) do
		
			-- query which shop sold it, add to running total
			local shopNameQuery = '[[:+]][[Sold item::' .. material.name .. ']]|?Sold by #-=data|mainlabel=' .. material.name
			local shopNameResult = mw.smw.ask(shopNameQuery) or {}
			local shopName = (shopNameResult and shopNameResult[1] and shopNameResult[1].data) or ''

			if shopName=="The Frequently Fresh Fish Stall" then
				item.fishShopTrips = item.fishShopTrips + 1
			elseif shopName=="Kevin's Ingredients" then
				item.vegShopTrips = item.vegShopTrips + 1
			end

		end
		
		-- there will be extra time spent buying and selling items, and moving between stations
		-- assume make one trip to buy 24 of each material from each shop per batch of 24 food
		local batchSize = 24
		-- 20 seconds moving between stations per 24 made
		-- 30 seconds per trip to Kevin's Ingredients
		-- 60 seconds per trip to the fish shop
		-- are these results optimal? no. are they approximate? yes
		local downtime = 20 + item.vegShopTrips * 30 + item.fishShopTrips * 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:Chef 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