Module:WoodcutterList

From Brighter Shores Wiki
Revision as of 14:12, 18 December 2024 by Alsang (talk | contribs) (spacing around images)
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:Currency.
Module:WoodcutterList requires Module:Mw.html extension.
Module:WoodcutterList requires Module:Paramtest.
Module:WoodcutterList 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::~*Tree||Brambles]]',
		'?Variant of #- = variant',
		'?Profession Level A = lvl',
		'? #- = name',
		'?Image #- = Image',
		'?Activity XP = XP',
		'?Activity duration = duration',
		'?Activity coins = coins',
		'?Skill node name = product',
		'?Activity input #- = material',
		'?Activity JSON = activityJSON',
		'sort = Profession Level A',
		'limit = 500'
	}
	local results = mw.smw.ask(query)
	
	results = p.screenResults(results)

	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

-- goes through a list of results and culls the ones which are not needed for this table
function p.screenResults(results)
	local resultsScreened = {}
	
	-- iterate through products
	for _, item in ipairs(results) do
		
		-- if theres only one activity, wrap in table
		if type(item.activityJSON)=='string' then
			item.activityJSON = { item.activityJSON }
		end
		
		if item.activityJSON ~= nil then -- TEMPORARY LINE WHILE PAGES DONT ALL HAVE PROFESSION INFO
		for j,json in ipairs(item.activityJSON) do
		
			if string.find(json,'Log') or string.find(json,'Brambles') then
				
				local activityJSON = mw.text.jsonDecode(json)
				
				item.XP = activityJSON.xp
				item.lvl = activityJSON.level
				item.duration = activityJSON.duration and tonumber(activityJSON.duration)
				item.product = activityJSON.output[1].name
				item.activityJSON = json
				table.insert(resultsScreened,item)
			end
		end
		end
	end
	
	-- sort the results by recipe level
	table.sort(resultsScreened, function(item1, item2)
		local lvl1 = item1.lvl
		local lvl2 = item2.lvl
		if (lvl1 == nil) ~= (lvl2 == nil) then --one of two are empty
			return lvl2 == nil -- true if lvl2 is nil but not lvl1, false if lvl1 is nil but not lvl2
		end
		if lvl1 == nil then
			return false  -- Both empty, equivalent
		end
		return lvl1 < lvl2 -- normal comparison
	end)

	return resultsScreened

end

-- do calculations and determine strings to go in cells
function p.formatResults(results)
	
	-- iterate through products
	for _, item in ipairs(results) do

		--catch badly submitted data	
		item.material = item.material or ''
		item.product = item.product or ''
		
		-- price of resource
		-- query is: there is a shop object page that has this item AND has buy price cannot be "N/A"
		local query = mw.smw.ask('[[Sold item::' .. item.product .. ']][[Shop sell price::!~N/A]]|?Shop sell price=data|mainlabel=-')
		if type(query)=='table' then
			-- price is returned as a number
			item.profit = tonumber(query[1].data) or 0
		else
			-- will return nil if the item is not in a shop, or if it is in a shop but can only be sold to the shop
			item.profit =  nil
		end
		
		-- detect brambles
		item.isBrambles = string.find(item.name,'Brambles')
		
		-- profitability
		item.profitPerXP = item.profit and item.XP and item.profit / item.XP
		
		-- DOWNTIME VERY IMPORTANT FOR GATHERING TYPE PROFESSIONS
		item.downtime = 60 -- THIS IS AN INITIAL GUESS, DO NOT USE THIS VALUE
		item.batch = 24
		item.productPerHour = item.duration and 1 / (item.duration + item.downtime / item.batch) * 3600

		-- properties per hour
		item.XPPerHour = item.XP and item.productPerHour and math.floor(item.XP * item.productPerHour)
		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)
	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('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()
		: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()
			
			-- gathering node
			:tag('td')
				:css{ ['border-right'] = '0', ['text-align'] = 'right', ['max-width'] = '100px' }
				:attr{ ['data-sort-value'] = item.name }
				:wikitext(' [[' .. item.Image .. '|link=' .. item.name .. '|30x30px]]')
			:done()
			:tag('td')
				:addClass('plinkt-link no-border')
				:wikitext('[[' .. item.name .. '|'  .. item.name ..']]')
			:done()
			
			-- resource
			:IF(item.isBrambles)
				:tag('td')
					:addClass('table-na')
					:attr{ colspan = '23' }
					:wikitext('N/A')
				:done()
			:ELSE()
				:tag('td')
					:css{ ['border-right'] = '0', ['text-align'] = 'right', ['max-width'] = '100px'  }
					:attr{ ['data-sort-value'] = item.product }
					:wikitext('[[File:' .. item.product .. '.png|link=' .. item.product .. '|30x30px]]')
				:done()
				:tag('td')
					:addClass('plinkt-link no-border')
					:wikitext('[[' .. item.product .. ']]')
				:done()
			
				-- resource/hr
				:IF(item.productPerHour)
					:tag('td')
						:wikitext(item.productPerHour and math.floor(tonumber(item.productPerHour)*10)/10)
					:done()
				:ELSE()
					:node(unknown_value_cell)
				:END()
			
				-- economics
				:node(currency_cell(item.profit))
				:node(currency_cell(item.profitPerHour))
			
			:END()

			-- 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
Retrieved from ‘https://brightershoreswiki.org/w/Module:WoodcutterList?oldid=78863’