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:Currency.

Module:ChefList requires Module:Infobox Recipe.

Module:ChefList requires Module:Mw.html extension.

Module:ChefList requires Module:Paramtest.

Module:ChefList requires strict.

---

require('strict')
require('Module:Mw.html extension')
local recipe = require('Module:Infobox Recipe') -- to make use of its extensive  material searching function
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 = {
		'[[-Sold item.Sold by::Head Chef (shop)]]',
		'?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.screenResults(results,false)

	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

-- Need to split the table into two, lines with crates are passive and lines without are not
function p.screenResults(results,isPassive)
	local resultsPassive = {}
	local resultsNotPassive = {}
	
	-- iterate through products
	for _, item in ipairs(results) do
		local hasCrate = string.find(item.recipeJSON,'Crate')
		
		if hasCrate then
			table.insert(resultsPassive,item)
		else
			table.insert(resultsNotPassive,item)
		end
		
	end
	
	if isPassive then
		return resultsPassive
	else
		return resultsNotPassive
	end
end

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

	-- iterate through products
	for _, item in ipairs(results) do
		
		-- recipe in a workable format
		local unpackJSON = mw.text.jsonDecode(item.recipeJSON)
		item.outputQuantity = unpackJSON.output[1].quantity

		-- call the module:infobox recipe to extensively search for 
		-- all raw materials (to add to prices) 
		-- all intermediate materials (for intermediate XP and duration)
		local Materials = recipe._getTrueRawMaterials(unpackJSON.materials)
		if next(Materials) ~= nil then
			item.materials = Materials.rawMaterials
			item.intermediates = Materials.intermediateMaterials
		end
		
		-- iterate through materials, adding buy price to running total (individuals not needed)
		-- also need to keep track of how many materials are needed from each shop
		item.buy = 0
		item.fishShopTrips = 0
		item.vegShopTrips = 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
			
			-- query which shop sold it, add to running total
			local shopNameQuery = '[[:+]][[Sold item::' .. material.name .. ']]|?Sold by|mainlabel=' .. material.name
			local shopNameResult = mw.smw.ask(shopNameQuery) or {}
			local shopName = ''

			if shopNameResult[1] and shopNameResult[1]["Sold by"] then
				shopName = shopNameResult[1]["Sold by"] or ''
			end
			
			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
		
		-- iterate through intermediaries to add to XP and duration parameters
		for _, intermediate in ipairs(item.intermediates) do
			
			-- look up activity XP and add it to running total
			local XPQuery = '[[Recipe output::' .. intermediate.name .. ']]|?Activity XP|mainlabel=' .. intermediate.name
			local XPResult = mw.smw.ask(XPQuery) or {}
			local XPIncrease = 0
			if XPResult[1] and XPResult[1]["Activity XP"] then
				XPIncrease =  tonumber(XPResult[1]["Activity XP"]) or 0
			else
				XPIncrease = nil
			end
			
			-- need to look up both the amount of the item used in this recipe and created in its own recipe to know how much of this xp to use
			local QTYused = intermediate.quantity

			local QTYQuery = '[[Recipe output::' .. intermediate.name .. ']]|?Recipe JSON|mainlabel=' .. intermediate.name
			local QTYResult = mw.smw.ask(QTYQuery) or {}
			local QTYmade = 0
			if QTYResult[1] and QTYResult[1]["Recipe JSON"] then
				QTYmade =  mw.text.jsonDecode(QTYResult[1]["Recipe JSON"]) or {}
			end
			QTYmade = QTYmade.output[1].quantity
			
			item.XP = item.XP and XPIncrease and item.XP + XPIncrease * QTYused / QTYmade;
			
			-- look up activity duration and add it to running total
			local durationQuery = '[[Recipe output::' .. intermediate.name .. ']]|?Activity duration|mainlabel=' .. intermediate.name
			local durationResult = mw.smw.ask(durationQuery) or {}
			local durationIncrease = 0
			if durationResult[1] and durationResult[1]["Activity duration"] then
				durationIncrease =  tonumber(durationResult[1]["Activity duration"]) or 0
			else
				durationIncrease = nil
			end
			item.duration = item.duration and durationIncrease and item.duration + durationIncrease * intermediate.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.profitPerXP = item.profit and item.XP and math.floor(item.profit / item.XP * 100) / 100

		-- 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)
	local out = mw.html.create('table')
		:addClass('wikitable sortable')
		: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()

	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|30px|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