Module:ChefPassiveList: Difference between revisions

From Brighter Shores Wiki
Jump to navigation Jump to search
Content added Content deleted
(No need to hide broken image file links. Should encourage people to upload them.)
(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,
local queryString = '[[Category:Chef]] AND [[Category:Pages with recipes]]'
-- other parameters are determined by subqueries of chained pages
local query = {
local function screenFunction(item)
'[[Variant of::Roasted Sturlet||Dab Stew||Mackibut on Toast||Baked Bream||Garlic Herring]]',
return item.passive
'?Profession Level A = lvl',
end
'? #- = name',
'?Recipe JSON = recipeJSON',
local results = plist.generate_recipe_table(queryString,screenFunction)
'?Activity XP = XP',
'?Activity duration = duration',
'?Value = sell',
'sort = Profession Level A',
'limit = 500'
}
local results = mw.smw.ask(query)


results = p.formatResults(results)
results = p.formatResults(results)
Line 31: 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
-- recipe in a workable format
local unpackJSON = mw.text.jsonDecode(item.recipeJSON)
item.outputQuantity = unpackJSON.output[1].quantity


-- SECTION REMOVED
-- profitability
item.profitPerXP = item.profit and item.xp and item.profit / item.xp
-- 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
-- no downtime for passives
--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
-- iterate through intermediaries to add to XP and duration parameters
-- SECTION REMOVED, there are no intermediates in passive recipes
-- 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

-- no downtime for passive recipes
local batchSize = 1
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 105: Line 54:
-- 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 120: Line 75:
:tag('th')
:tag('th')
:attr{ colspan = '10' }
:attr{ colspan = '10' }
:wikitext('Buy Value')
:wikitext('Buy<br>Value')
:done()
:done()
:tag('th')
:tag('th')
:attr{ colspan = '10' }
:attr{ colspan = '10' }
:wikitext('Sell Value')
:wikitext('Sell<br>Value')
:done()
:done()
:tag('th')
:tag('th')
Line 145: Line 100:
: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()
-- recipe
:node(plist.three_column_image_text(item.product,item.output[1].quantity,'File:' .. item.product .. '.png',item.product,item.product))
-- bait
:node(plist.one_column_image_text(item.materials))
-- economics
:node(plist.currency_cell(item.buyPrice))
:node(plist.currency_cell(item.sellPrice))
:node(plist.currency_cell(item.profit))
:node(plist.currency_cell(item.profitPerHour))


:tag('td')
-- XP
:IF(item.xp)
: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|18px|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')
: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:37, 19 December 2024

Module documentation
This documentation is transcluded from Module:ChefPassiveList/doc. [edit] [history] [purge]
This module does not have any documentation. Please consider adding documentation at Module:ChefPassiveList/doc. [edit]
Module:ChefPassiveList's function main is invoked by Template:ChefPassiveList.
Module:ChefPassiveList requires Module:Mw.html extension.
Module:ChefPassiveList requires Module:ProfessionList.
Module:ChefPassiveList requires Module:RecipeTreeSearch.
Module:ChefPassiveList 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:Chef]] AND [[Category:Pages with recipes]]'
	
	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

		-- 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: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<br>Value')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Sell<br>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))
			
			-- bait 
			:node(plist.one_column_image_text(item.materials))
			
			-- economics
			: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.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