Module:ForagerList

Module documentation

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

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

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

Module:ForagerList requires Module:Mw.html extension.

Module:ForagerList requires Module:ProfessionList.

Module:ForagerList requires Module:Purge.

Module:ForagerList requires strict.

---

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 inputscleanup required modules
function p.main()
	
	local queryString = '[[Category:Forager]] AND [[Category:Pages with activities]]'
	
	local function screenFunction(item)
		return not 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

		-- downtime is very important for gathering-type professions
		-- initial values, it will be obvious if these get used
		item.downtime = 10000 
		item.nodes = 1
		-- these numbers are based roughly on how far the nodes are from a storage rift or shop or bank
		-- 20s per room to traverse
		-- duration and relocation times arent used for fisher, only respawn time and number of nodes
		if string.find(item.pageName,'Kelp') then
			item.downtime = 20
			item.nodes = 6
		elseif string.find(item.pageName,'Wallplant') then
			item.downtime = 40
			item.nodes = 6
		elseif string.find(item.pageName,'Periwinkle') then
			item.downtime = 40
			item.nodes = 6
		elseif string.find(item.pageName,'Shell') then
			item.downtime = 20
			item.nodes = 6
		elseif string.find(item.pageName,'Potato') then
			item.downtime = 80
			item.nodes = 6
		elseif string.find(item.pageName,'Pond Weed') then
			item.downtime = 40
			item.nodes = 6
		elseif string.find(item.pageName,'Bellplant') then
			item.downtime = 40
			item.nodes = 6
		elseif string.find(item.pageName,'Monument Piece') then
			item.downtime = 20
			item.nodes = 8
		elseif string.find(item.pageName,'Water Lily') then
			item.downtime = 40
			item.nodes = 6
		elseif string.find(item.pageName,'Starfish') then
			item.downtime = 60
			item.nodes = 6
		elseif string.find(item.pageName,'Hogberries') then
			item.downtime = 80
			item.nodes = 6
		elseif string.find(item.pageName,'Limpet') then
			item.downtime = 100
			item.nodes = 6
		elseif string.find(item.pageName,'Nettle') then
			item.downtime = 20
			item.nodes = 6
		elseif string.find(item.pageName,'Wrack') then
			item.downtime = 80
			item.nodes = 6
		end 

		-- profitability
		item.profit = item.sellPrice
		
		-- products per hour
		item.batch = 24
		item.durationEffective = item.duration and item.respawn and (item.duration + item.respawn) / item.nodes
		item.productPerHour = item.durationEffective and math.floor(1 / (item.durationEffective + item.downtime / item.batch) * 3600)
		item.productPerHourDropping = item.durationEffective and 1 / (item.durationEffective) * 3600

		-- 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')
		:tag('caption')
			:wikitext('This list is updated dynamically. '..purge())
		:done()
		:tag('tr')
			:tag('th')
				:wikitext('[[File:Forager 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('Resource')
			:done()
			:tag('th')
				:wikitext('Resource/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.pageName,item.pageName))
			
			:IF(item.tool)
				:node(plist.two_column_image_text(item.tool,'File:'..(item.tool or '')..' (grade 1).png',(item.tool or ''),(item.tool or '')))
			:ELSE()
				:tag('td')
					:addClass('table-na')
					:attr{ colspan = '2' }
					:wikitext('N/A')
				:done()
			:END()
			
			-- 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