Module:WoodcutterPassiveList: Difference between revisions

From Brighter Shores Wiki
Jump to navigation Jump to search
Content added Content deleted
m (helper modules were updates to include output quantity, so make use of that)
m (cleanup required modules)
Line 3: Line 3:
local lang = mw.getContentLanguage()
local lang = mw.getContentLanguage()
local plist = require('Module:ProfessionList')
local plist = require('Module:ProfessionList')
local rts = require('Module:RecipeTreeSearch')


local p = {}
local p = {}

Revision as of 14:24, 27 December 2024

Module documentation
This documentation is transcluded from Module:WoodcutterPassiveList/doc. [edit] [history] [purge]
This module does not have any documentation. Please consider adding documentation at Module:WoodcutterPassiveList/doc. [edit]
Module:WoodcutterPassiveList's function main is invoked by Template:WoodcutterPassiveList.
Module:WoodcutterPassiveList requires Module:Mw.html extension.
Module:WoodcutterPassiveList requires Module:ProfessionList.
Module:WoodcutterPassiveList requires strict.

require('strict')
require('Module:Mw.html extension')
local lang = mw.getContentLanguage()
local plist = require('Module:ProfessionList')

local p = {}

-- non dynamic module, no inputs
function p.main()
	
	local queryString = '[[Category:Woodcutter]] AND [[Category:Pages with activities]]'
	
	local function screenFunction(item)
		return 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
			
		item.givesCoins = string.find(item.product,'Split')
		if item.givesCoins then
			item.profit = item.coins and tonumber(item.coins)
		else
			item.profit = item.sellPrice
		end

		-- 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.coinsPerHour = 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 nil
	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('Woodcutter node')
			:done()
			:tag('th')
				:attr{ colspan = '3' }
				:wikitext('Product')
			:done()
			:tag('th')
				:wikitext('Quantity/hr')
			:done()
			:tag('th')
				:attr{ colspan = '10' }
				:wikitext('Profit/hr')
			:done()
			:tag('th')
				:wikitext('XP')
			:done()
			:tag('th')
				:wikitext('XP/hr')
			: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()
			
			-- activity
			:node(plist.two_column_image_text(item.pageName,item.pageImage,item.product,item.product))
			
			-- products (coins or items)
			:IF(item.givesCoins)
				:IF(item.profit)
					:tag('td')
						:css{ ['border-right'] = '0', ['text-align'] = 'right' }
						:addClass('plinkt-link no-border')
						:attr{ ['data-sort-value'] = item.product }
						:wikitext(item.profit)
					:done()
				:ELSE()
					:node(plist.unknown_value_edit_cell(item.pageName,1))
				:END()
				:tag('td')
					:css{ ['border-right'] = '0', ['text-align'] = 'center' }
					:addClass('plinkt-link no-border')
					:wikitext('[[File:Copper coin.png|20x20px]]')
				:done()
				:tag('td')
					:addClass('plinkt-link no-border')
					:wikitext('Coins')
				:done()
			:ELSE()
				:node(plist.three_column_image_text(item.product,item.output[1].quantity,'File:'..item.product..'.png',item.product,item.product))
			:END()
			
			-- products per hour (items)
			:IF(item.givesCoins)
				:tag('td')
					:addClass('table-na')
					:wikitext('N/A')
				:done()
			:ELSE()
				:tag('td')
					:css{ ['text-align'] = 'right' }
					:wikitext('0.9 &times; [[File:' .. item.product .. '.png|link=' .. item.product .. '|30x30px]]')
				:done()
			:END()
			
			-- profit per hour (coins)
			:node(plist.currency_cell(item.coinsPerHour))

			-- 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()

		:done()
	end

	return out
end

return p