Module:FisherList

Module documentation

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

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

Module:FisherList requires Module:Mw.html extension.

Module:FisherList requires Module:ProfessionList.

Module:FisherList requires Module:Purge.

Module:FisherList requires strict.

This module is meant to be exclusively used by {{FisherList}} to generate , see Template:FisherList/doc.

---

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 results = plist.generate_recipe_table(p.queryString,p.screenFunction)
	
	results = p.formatResults(results)

	return p.displayTable(results)
	
	--for debugging
	--return '<pre>'..mw.text.jsonEncode(results, mw.text.JSON_PRETTY)..'</pre>'

end
	
p.queryString = '[[Category:Fisher]] AND [[Category:Pages with activities]]'
	
function p.screenFunction(item)
	return not item.passive
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
		
		--look up how many actions per hour this type of node can do
		local query = '[['..item.pageName..']]|?Variant of.Action per hour banking=productPerHour|?Variant of.Action per hour discarding=productPerHourDropping|?Variant of.Action per hour selling=productPerHourSelling'
		local result = mw.smw.ask(query)
		item.productPerHour = result and result[1] and (result[1].productPerHour or result[1].productPerHourSelling)
		item.productPerHourDropping = result and result[1] and result[1].productPerHourDropping
		
		-- profitability
		item.profit = item.sellPrice

		-- properties per hour
		item.xpPerHour = item.xp and item.productPerHour and math.floor(item.xp * item.productPerHour)
		item.xpPerHourDropping = item.xp and item.productPerHourDropping and math.floor(item.xp * item.productPerHourDropping)
		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 sticky-header')
		:tag('caption')
			:wikitext('This list is updated dynamically. '..purge())
		:done()
		:tag('tr')
			:tag('th')
				:wikitext('[[File:Fisher small icon.png|15px]]  Level')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Node')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Tool')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Fish')
			:done()
			:tag('th')
				:wikitext('Fish/hr')
			: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')
				:wikitext('XP/hr<br>(Discarding)')
			: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()
			
			-- gathering node
			:node(plist.two_column_image_text(item.pageName,item.pageImage,item.product,item.pageName))
			:node(plist.two_column_image_text(item.tool,'File:'..item.tool..' (grade 1).png',item.tool,item.tool))

			-- resource
			:IF(item.coop)
				:node(plist.two_column_image_text(item.product,'File:' .. item.product .. '.png',item.product .. ' (co-op)',item.product))
			:ELSE()
				:node(plist.two_column_image_text(item.product,'File:' .. item.product .. '.png',item.product,item.product))
			:END()
			
			-- resource/hr
			:IF(item.productPerHour)
				:tag('td')
					:wikitext(item.productPerHour and math.floor(tonumber(item.productPerHour)*10)/10)
				:done()
			:ELSE()
				:node(plist.unknown_value_edit_cell(item.pageName,1))
			:END()
		
			-- economics
			: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
			:IF(item.xpPerHourDropping)
				:tag('td')
					:wikitext(item.xpPerHourDropping and lang:formatNum(tonumber(item.xpPerHourDropping)))
				:done()
			:ELSE()
				:node(plist.unknown_value_cell(1))
			:END()

		:done()
	end

	return out
end

return p