Module:DetectivePassiveList

Module documentation

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

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

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

Module:DetectivePassiveList requires Module:Currency.

Module:DetectivePassiveList requires Module:Mw.html extension.

Module:DetectivePassiveList requires Module:Paramtest.

Module:DetectivePassiveList 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::Forensics (activity)||Evidence Filing||Interrogation||Stakeout]]',
		'?Variant of #- = variant',
		'?Profession Level A = lvl',
		'? #- = name',
		'?Image #- = Image',
		'?Activity XP = XP',
		'?Activity duration = duration',
		'?Activity coins = coins',
		'?Activity input #- = material',
		'?Skill node name = product',
		'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
		
		item.material = item.material or ''
			
		-- work out if the product is coins or items
		item.usesPotion = item.variant=='Forensics (activity)'
		
		-- it it uses a potion, need to account for that in profit
		item.buy = 0
		if item.usesPotion then
			--shamelessley lifted from Module:Products
			local shopPriceQuery = '[[:+]][[Sold item::' .. item.material .. ']]|?Shop buy price=data|mainlabel=' .. item.material
			local shopPriceResult = mw.smw.ask(shopPriceQuery) or {}
			local shopPrice = 0		
			if shopPriceResult[1] and shopPriceResult[1]["data"] then
				shopPrice = tonumber(shopPriceResult[1]["data"]) or 0
			else
				item.buy = nil
			end
			item.buy = shopPrice * 0.005
		end
		
		item.profit = item.coins and item.buy and item.coins - item.buy
		
		-- 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.coins 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:Detective small icon.png|15px]]  Level')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Activity')
			:done()
			:tag('th')
				:wikitext('Materials')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Buy Value')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Payment')
			: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()
			
			-- activity
			:tag('td')
				:css{ ['border-right'] = '0', ['text-align'] = 'right', ['max-width'] = '100px' }
				:addClass('plinkt-link no-border')
				:attr{ ['data-sort-value'] = item.name }
				:wikitext('[[' .. item.Image .. '|link=' .. item.name .. '|30x30px]]')
			:done()
			:tag('td')
				:addClass('plinkt-link no-border')
				:wikitext('[[' .. item.name .. ']]')
			:done()
			
			-- materials
			:IF(item.usesPotion)
				:tag('td')
					:wikitext('0.005 &times; [[File:' .. item.material .. '.png|link=' .. item.material .. '|30x30px]] [[' .. item.material .. ']]')
				:done()
				:node(currency_cell(item.buy))
				:node(currency_cell(item.coins))
			:ELSE()
				:tag('td')
					:addClass('table-na')
					:attr{ colspan = '21' }
					:wikitext('N/A')
				:done()
			:END()
			
			-- products (coins or items)
			:node(currency_cell(item.profit))
			
			-- products per hour (coins or items)
			: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