Module:MinerList: Difference between revisions

From Brighter Shores Wiki
Jump to navigation Jump to search
Content added Content deleted
(Add materials used (explosives) column)
(xp per hour when dropping deathstone doesnt work as you need to get more explosives anyway)
Line 95:
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)
Line 221:
:END()
-- XP per hour discarding
:IF(not item.xpPerHourDroppingusesExplosives)
:IF(item.xpPerHourDropping)
:tag('td')
:wikitext(item.xpPerHourDropping and lang:formatNum(tonumber(item.xpPerHourDropping)))
:ELSEdone()
:ELSE()
:node(plist.unknown_value_cell(1))
:END()
:ELSE()
:tag('td')
:addClass('table-na')
:wikitext(item.xpPerHourDropping and lang:formatNum(tonumber(item.xpPerHourDropping)))
:wikitext('N/A')
:done()
:ELSE()
:node(plist.unknown_value_cell(1))
:END()
 

Revision as of 18:36, 22 December 2024

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

		--catch badly submitted data	
		item.product = item.product or ''
		
		-- detect mine cart work or deathstone
		item.hideCells = string.find(item.pageName,'Mine Cart Work')
		item.usesExplosives = string.find(item.pageName,'Deathstone')
		if item.hideCells then
			item.profit = item.coins and tonumber(item.coins)
		end
		
		-- materials used
		item.material = (item.materials and item.materials[1] and item.materials[1].name) or ''
		
		-- downtime is very important for gathering-type professions
		-- initial guesses
		item.downtime = 60 
		-- 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 miner, only respawn time and number of nodes
		if item.hideCells then
			item.downtime = 0
			item.nodes = 1
			item.respawn = item.duration
		elseif string.find(item.pageName,'Iron Ore') then
			item.downtime = 20
			item.nodes = 10
		elseif string.find(item.pageName,'Cabranese Ore') then
			item.downtime = 120 -- teleport to mine south west to bank and run back
			item.nodes = 10
		elseif string.find(item.pageName,'Flantium Ore') then
			item.downtime = 100
			item.nodes = 10
		elseif string.find(item.pageName,'Adathril Ore') then
			item.downtime = 60
			item.nodes = 10
		elseif string.find(item.pageName,'Flint') then
			item.downtime = 20
			item.nodes = 6
		elseif string.find(item.pageName,'Basalt') then
			item.downtime = 60
			item.nodes = 6
		elseif string.find(item.pageName,'Andesite') then
			item.downtime = 60
			item.nodes = 6
		elseif string.find(item.pageName,'Granite') then
			item.downtime = 20
			item.nodes = 6
		elseif string.find(item.pageName,'Deathstone') then
			item.downtime = 120 -- includes getting more explosives
			item.nodes = 6
		end 

		--products per hour
		item.batch = 24
		item.durationEffective = item.respawn and 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('tr')
			:tag('th')
				:wikitext('[[File:Miner small icon.png|15px]]  Level')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Mining node')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Materials')
			: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))
			
			-- resource
			:IF(item.hideCells)
				:tag('td')
					:addClass('table-na')
					:attr{ colspan = '5' }
					:wikitext('N/A')
				:done()
			:ELSE()
				:IF(item.usesExplosives)
					:node(plist.two_column_image_text(item.material,'File:' .. item.material .. '.png',item.material,item.material))
				:ELSE()
					:tag('td')
						:addClass('table-na')
						:attr{ colspan = '2' }
						:wikitext('N/A')
					:done()
				:END()
				
				:node(plist.two_column_image_text(item.product,'File:' .. item.product .. '.png',item.product,item.product))
			
				-- 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()
			: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 discarding
			:IF(not item.usesExplosives)
				:IF(item.xpPerHourDropping)
					:tag('td')
						:wikitext(item.xpPerHourDropping and lang:formatNum(tonumber(item.xpPerHourDropping)))
					:done()
				:ELSE()
					:node(plist.unknown_value_cell(1))
				:END()
			:ELSE()
				:tag('td')
					:addClass('table-na')
					:wikitext('N/A')
				:done()
			:END()

		:done()
	end

	return out
end

return p