Module:WoodcutterList

From Brighter Shores Wiki
Revision as of 13:11, 24 December 2024 by Alsang (talk | contribs) (more accuracy to the trees per hour, especially for ash)
Jump to navigation Jump to search
Module documentation
This documentation is transcluded from Module:WoodcutterList/doc. [edit] [history] [purge]
This module does not have any documentation. Please consider adding documentation at Module:WoodcutterList/doc. [edit]
Module:WoodcutterList's function main is invoked by Template:WoodcutterList.
Module:WoodcutterList requires Module:Mw.html extension.
Module:WoodcutterList requires Module:ProfessionList.
Module:WoodcutterList requires Module:RecipeTreeSearch.
Module:WoodcutterList 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:Woodcutter]] 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

		-- detect brambles
		item.hideCells = string.find(item.pageName,'Brambles')
		
		-- downtime is very important for gathering-type professions
		-- initial guesses
		item.downtime = 60 
		item.relocate = 5
		-- these numbers are based roughly on how far the trees are from a storage rift or bank
		if item.hideCells then
			item.downtime = 0
			item.relocate = 2.125 -- basically just the respawn timer (45s / 8nodes - 3.5s chopping)
		elseif string.find(item.pageName,'Ash') then
			item.downtime = 35 -- from the Strategy guide on the Ash Tree page, 35s to lumber bank
			item.relocate = 6.5 -- from the Strategy guide on the Ash Tree page, 360 log per hour 
		elseif string.find(item.pageName,'Oak') then
			item.downtime = 30
		elseif string.find(item.pageName,'Pine') then
			item.downtime = 45
		elseif string.find(item.pageName,'Hickory') then
			item.downtime = 45
		elseif string.find(item.pageName,'Juniper') then
			item.downtime = 15
		elseif string.find(item.pageName,'Poplar') then
			item.downtime = 60
		elseif string.find(item.pageName,'Suave') then
			item.downtime = 60
		elseif string.find(item.pageName,'Yew') then
			item.downtime = 45
		end 

		-- profitability
		item.profit = item.sellPrice
		
		-- products per hour
		item.batch = 24
		item.productPerHour = item.duration and math.floor(1 / (item.duration +  item.relocate + item.downtime / item.batch) * 3600)
		item.productPerHourDropping = item.duration and 1 / (item.duration +  item.relocate) * 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:Woodcutter small icon.png|15px]]  Level')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Tree')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Tool')
			:done()
			:tag('th')
				:attr{ colspan = '2' }
				:wikitext('Log')
			:done()
			:tag('th')
				:wikitext('Log/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))
			:node(plist.two_column_image_text(item.tool,'File:'..item.tool..' (grade 1).png',item.tool,item.tool))

			-- resource
			:IF(item.hideCells)
				:tag('td')
					:addClass('table-na')
					:attr{ colspan = '23' }
					:wikitext('N/A')
				:done()
			:ELSE()
				: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))
			
			:END()

			-- 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.hideCells)
				:tag('td')
					:addClass('table-na')
					:wikitext('N/A')
				:done()
			:ELSE()
				:IF(item.xpPerHourDropping)
					:tag('td')
						:wikitext(item.xpPerHourDropping and lang:formatNum(tonumber(item.xpPerHourDropping)))
					:done()
				:ELSE()
					:node(plist.unknown_value_cell(1))
				:END()
			:END()

		:done()
	end

	return out
end

return p
Retrieved from ‘https://brightershoreswiki.org/w/Module:WoodcutterList?oldid=82588’