Module:FisherList

Module documentation

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

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

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

Module:FisherList requires Module:Currency.

Module:FisherList requires Module:Mw.html extension.

Module:FisherList requires Module:Paramtest.

Module:FisherList requires strict.

---

require('strict')
require('Module:Mw.html extension')
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 = {
		'[[Variant of::Flounder (skill node)||Eel (skill node)||Pufferfish (skill node)||Gurnard (skill node)||Bass (skill node)||Ray (skill node)||Cod (skill node)]]',
		'?Variant of #- = variant',
		'?Profession Level A = lvl',
		'? #- = name',
		'?Image #- = Image',
		'?Activity XP = XP',
		'?Activity duration = duration',
		'?Skill node name = product',
		'?Activity input #- = material',
		'sort = Profession Level A',
		'limit = 500'
	}
	local results = mw.smw.ask(query)

	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

-- do calculations and determine strings to go in cells
function p.formatResults(results)
	
	-- iterate through products
	for _, item in ipairs(results) do

		--catch badly submitted data	
		item.material = item.material or ''
		item.product = item.product or ''
		
		-- price of fish
		-- query is: there is a shop object page that has this item AND has buy price cannot be "N/A"
		local query = mw.smw.ask('[[Sold item::' .. item.product .. ']][[Shop sell price::!~N/A]]|?Shop sell price=data|mainlabel=-')
		if type(query)=='table' then
			-- price is returned as a number
			item.profit = tonumber(query[1].data) or 0
		else
			-- will return nil if the item is not in a shop, or if it is in a shop but can only be sold to the shop
			item.profit =  nil
		end
		
		-- profitability
		item.profitPerXP = item.profit and item.XP and item.profit / item.XP
		
		-- DOWNTIME VERY IMPORTANT FOR GATHERING TYPE PROFESSIONS
		item.downtime = 60 -- THIS IS AN INITIAL GUESS, DO NOT USE THIS VALUE
		item.batch = 24
		item.productPerHour = item.duration and 1 / (item.duration + item.downtime / item.batch) * 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:Fisher small icon.png|15px]]  Level')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Fishing node')
			: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()
		: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')
		
			--level
			:IF(item.lvl)
				:tag('td')
					:css{ ['text-align'] = 'center' }
					:wikitext(item.lvl)
				:done()
			:ELSE()
				:node(unknown_value_cell)
			:END()
			
			-- fishing node
			:tag('td')
				:css{ ['border-right'] = '0', ['text-align'] = 'right', ['max-width'] = '100px' }
				:attr{ ['data-sort-value'] = item.name }
				:wikitext(' [[' .. item.Image .. '|link=' .. item.name .. '|30x30px]]')
			:done()
			:tag('td')
				:addClass('plinkt-link no-border')
				:wikitext('[[' .. item.name .. '|'  .. item.product ..']]')
			:done()
			
			-- fish
			:tag('td')
				:css{ ['border-right'] = '0', ['text-align'] = 'right', ['max-width'] = '100px'  }
				:attr{ ['data-sort-value'] = item.product }
				:wikitext('[[File:' .. item.product .. '.png|link=' .. item.product .. '|30x30px]]')
			:done()
			:tag('td')
				:addClass('plinkt-link no-border')
				:wikitext('[[' .. item.product .. ']]')
			:done()
			
			-- fish/hr
			:IF(item.productPerHour)
				:tag('td')
					:wikitext(item.productPerHour and math.floor(tonumber(item.productPerHour)*10)/10)
				:done()
			:ELSE()
				:node(unknown_value_cell)
			:END()
			
			-- economics
			:node(currency_cell(item.profit))
			:node(currency_cell(item.profitPerHour))

			-- XP
			:IF(item.XP)
				:tag('td')
					:wikitext(item.XP and lang:formatNum(tonumber(item.XP)))
				:done()
			:ELSE()
				:node(unknown_value_cell)
			:END()
			
			-- XP per hour
			:IF(item.XPPerHour)
				:tag('td')
					:wikitext(item.XPPerHour and lang:formatNum(tonumber(item.XPPerHour)))
				:done()
			:ELSE()
				:node(unknown_value_cell)
			:END()

		:done()
	end

	return out
end

return p