Module:GathererList: Difference between revisions

From Brighter Shores Wiki
Jump to navigation Jump to search
Browse history interactively
Content added Content deleted
(Created page with "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::Globeplant (skill node)||Dandelion (skill node)||Goat Horn (skil...")
 
m (add purge link)
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
require('strict')
require('strict')
require('Module:Mw.html extension')
require('Module:Mw.html extension')
local param = require( 'Module:Paramtest' )
local currency = require('Module:Currency')
local lang = mw.getContentLanguage()
local lang = mw.getContentLanguage()
local plist = require('Module:ProfessionList')
local purge = require('Module:Purge')._purge


local p = {}
local p = {}
Line 10: Line 10:
function p.main()
function p.main()
local queryString = '[[Category:Gatherer]] AND [[Category:Pages with activities]]'
-- returns only directly needed parameter needed for the row,
-- other parameters are determined by subqueries of chained pages
local query = {
local function screenFunction(item)
return not item.passive
'[[Variant of::Globeplant (skill node)||Dandelion (skill node)||Goat Horn (skill node)||Apple (skill node)||Leek (skill node)||Haleberries (skill node)||Rams Horn (skill node)||Bitterfruit (skill node)||Chestnut (skill node)||Bone Spike (skill node)||Tangfruit (skill node)||Catkin (skill node)||Femur Shard (skill node)||Clover (skill node)||Snake Scale (skill node)||Orchid (skill node)||Dock Leaf (skill node)||Sage (skill node)||Thistle (skill node)]]',
end
'?Variant of #- = variant',
'?Profession Level A = lvl',
local results = plist.generate_recipe_table(queryString,screenFunction)
'? #- = name',
'?Image #- = Image',
'?Activity XP = XP',
'?Activity duration = duration',
'?Skill node name = product',
'?Activity input #- = material',
'sort = Profession Level A',
'limit = 500'
}
local results = mw.smw.ask(query)

results = p.formatResults(results)
results = p.formatResults(results)


Line 34: Line 25:
--return '<pre>'..mw.text.jsonEncode(results, mw.text.JSON_PRETTY)..'</pre>'
--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
end


-- do calculations and determine strings to go in cells
-- do calculations and determine strings to go in cells
function p.formatResults(results)
function p.formatResults(results)
--simple check for nil results
if results==nil or results[1]==nil then
return nil
end
-- iterate through products
-- iterate through products
for _, item in ipairs(results) do
for _, item in ipairs(results) do


-- downtime is very important for gathering-type professions
--catch badly submitted data
-- initial values, it will be obvious if these get used
item.material = item.material or ''
item.product = item.product or ''
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
-- price of resource
-- 20s per room to traverse
-- query is: there is a shop object page that has this item AND has buy price cannot be "N/A"
-- duration and relocation times arent used for fisher, only respawn time and number of nodes
local query = mw.smw.ask('[[Sold item::' .. item.product .. ']][[Shop sell price::!~N/A]]|?Shop sell price=data|mainlabel=-')
if type(query)=='table' then
if string.find(item.pageName,'Globeplant') then
item.downtime = 40
-- price is returned as a number
item.profit = tonumber(query[1].data) or 0
item.nodes = 8
elseif string.find(item.pageName,'Dandelion') then
else
item.downtime = 20
-- 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
item.nodes = 8
elseif string.find(item.pageName,'Goat Horn') then
end
item.downtime = 60
item.nodes = 8
elseif string.find(item.pageName,'Apple') then
item.downtime = 80
item.nodes = 6
elseif string.find(item.pageName,'Leek') then
item.downtime = 40
item.nodes = 8
elseif string.find(item.pageName,'Haleberries') then
item.downtime = 50 -- portal back after depositing
item.nodes = 8
elseif string.find(item.pageName,'Rams Horn') then
item.downtime = 100
item.nodes = 8
elseif string.find(item.pageName,'Bitterfruit') then
item.downtime = 160 -- cannot be banked, must be sold
item.nodes = 8
elseif string.find(item.pageName,'Chestnut') then
item.downtime = 80
item.nodes = 6
elseif string.find(item.pageName,'Bone Spike') then
item.downtime = 0
item.nodes = 8
elseif string.find(item.pageName,'Tangfruit') then
item.downtime = 150 -- cannot be banked, must be sold
item.nodes = 6
elseif string.find(item.pageName,'Catkin') then
item.downtime = 60
item.nodes = 6
elseif string.find(item.pageName,'Femur Shard') then
item.downtime = 80
item.nodes = 8
elseif string.find(item.pageName,'Clover') then
item.downtime = 40
item.nodes = 8
elseif string.find(item.pageName,'Snake Scale') then
item.downtime = 60
item.nodes = 8
elseif string.find(item.pageName,'Orchid') then
item.downtime = 60
item.nodes = 8
elseif string.find(item.pageName,'Dock Leaf') then
item.downtime = 80 -- portal back after depositing
item.nodes = 8
elseif string.find(item.pageName,'Sage') then
item.downtime = 120 -- portal to deposit then run back
item.nodes = 6
elseif string.find(item.pageName,'Thistle') then
item.downtime = 100
item.nodes = 6
end

-- profitability
-- profitability
item.profitPerXP = item.profit and item.XP and item.profit / item.XP
item.profit = item.sellPrice
-- products per hour
-- DOWNTIME VERY IMPORTANT FOR GATHERING TYPE PROFESSIONS
item.downtime = 60 -- THIS IS AN INITIAL GUESS, DO NOT USE THIS VALUE
item.batch = 24
item.batch = 24
item.productPerHour = item.duration and 1 / (item.duration + item.downtime / item.batch) * 3600
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
-- properties per hour
item.XPPerHour = item.XP and item.productPerHour and math.floor(item.XP * item.productPerHour)
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)
item.profitPerHour = item.profit and item.productPerHour and math.floor(item.profit * item.productPerHour)
end
end


Line 89: Line 125:
-- make the table
-- make the table
function p.displayTable(results)
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')
local out = mw.html.create('table')
:addClass('wikitable sortable')
:addClass('wikitable sortable')
:tag('caption')
:wikitext('This list is updated dynamically. '..purge())
:done()
:tag('tr')
:tag('tr')
:tag('th')
:tag('th')
:wikitext('[[File:Gatherer small icon.png|15px]] Level')
:wikitext('[[File:Forager small icon.png|15px]] Level')
:done()
:tag('th')
:attr{ colspan = '2' }
:wikitext('Node')
:done()
:done()
:tag('th')
:tag('th')
:attr{ colspan = '2' }
:attr{ colspan = '2' }
:wikitext('Gathering node')
:wikitext('Tool')
:done()
:done()
:tag('th')
:tag('th')
Line 119: Line 168:
:tag('th')
:tag('th')
:wikitext('XP/hr')
:wikitext('XP/hr')
:done()
:tag('th')
:wikitext('XP/hr<br>(Discarding)')
:done()
:done()
: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
for i, item in ipairs(results) do
Line 131: Line 178:
--level
--level
:IF(item.lvl)
:IF(item.level)
:tag('td')
:tag('td')
:css{ ['text-align'] = 'center' }
:css{ ['text-align'] = 'center' }
:wikitext(item.lvl)
:wikitext(item.level)
:done()
:done()
:ELSE()
:ELSE()
:node(plist.unknown_value_edit_cell(item.pageName,1))
:node(unknown_value_cell)
:END()
:END()
-- gathering node
-- gathering node
:node(plist.two_column_image_text(item.pageName,item.pageImage,item.pageName,item.pageName))
:tag('td')
:css{ ['border-right'] = '0', ['text-align'] = 'right', ['max-width'] = '100px' }
:IF(item.tool)
:addClass('plinkt-link no-border')
:node(plist.two_column_image_text(item.tool,'File:'..(item.tool or '')..' (grade 1).png',(item.tool or ''),(item.tool or '')))
:attr{ ['data-sort-value'] = item.name }
:ELSE()
:wikitext(' [[' .. item.Image .. '|link=' .. item.name .. '|30x30px]]')
:done()
:tag('td')
:tag('td')
:addClass('table-na')
:attr{ colspan = '2' }
:addClass('plinkt-link no-border')
:wikitext('[[' .. item.name .. '|' .. item.product ..']]')
:wikitext('N/A')
:done()
:done()
:END()
-- resource
-- resource
:node(plist.two_column_image_text(item.product,'File:' .. item.product .. '.png',item.product,item.product))
:tag('td')
:css{ ['border-right'] = '0', ['text-align'] = 'right', ['max-width'] = '100px' }
:addClass('plinkt-link no-border')
: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
-- resource/hr
Line 170: Line 209:
:done()
:done()
:ELSE()
:ELSE()
:node(plist.unknown_value_edit_cell(item.pageName,1))
:node(unknown_value_cell)
:END()
:END()
-- economics
-- economics
:node(currency_cell(item.profit))
:node(plist.currency_cell(item.profit))
:node(currency_cell(item.profitPerHour))
:node(plist.currency_cell(item.profitPerHour))


-- XP
-- XP
:IF(item.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')
:tag('td')
:wikitext(item.XP and lang:formatNum(tonumber(item.XP)))
:wikitext(item.xpPerHour and lang:formatNum(tonumber(item.xpPerHour)))
:done()
:done()
:ELSE()
:ELSE()
:node(unknown_value_cell)
:node(plist.unknown_value_cell(1))
:END()
:END()
-- XP per hour
-- XP per hour
:IF(item.XPPerHour)
:IF(item.xpPerHourDropping)
:tag('td')
:tag('td')
:wikitext(item.XPPerHour and lang:formatNum(tonumber(item.XPPerHour)))
:wikitext(item.xpPerHourDropping and lang:formatNum(tonumber(item.xpPerHourDropping)))
:done()
:done()
:ELSE()
:ELSE()
:node(unknown_value_cell)
:node(plist.unknown_value_cell(1))
:END()
:END()


Revision as of 07:43, 1 January 2025

Module documentation
This documentation is transcluded from Module:GathererList/doc. [edit] [history] [purge]
This module does not have any documentation. Please consider adding documentation at Module:GathererList/doc. [edit]
Module:GathererList's function main is invoked by Template:GathererList.
Module:GathererList requires Module:Mw.html extension.
Module:GathererList requires Module:ProfessionList.
Module:GathererList requires Module:Purge.
Module:GathererList 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 inputs
function p.main()
	
	local queryString = '[[Category:Gatherer]] 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,'Globeplant') then
			item.downtime = 40
			item.nodes = 8
		elseif string.find(item.pageName,'Dandelion') then
			item.downtime = 20
			item.nodes = 8
		elseif string.find(item.pageName,'Goat Horn') then
			item.downtime = 60
			item.nodes = 8
		elseif string.find(item.pageName,'Apple') then
			item.downtime = 80
			item.nodes = 6
		elseif string.find(item.pageName,'Leek') then
			item.downtime = 40
			item.nodes = 8
		elseif string.find(item.pageName,'Haleberries') then
			item.downtime = 50 -- portal back after depositing
			item.nodes = 8
		elseif string.find(item.pageName,'Rams Horn') then
			item.downtime = 100
			item.nodes = 8
		elseif string.find(item.pageName,'Bitterfruit') then
			item.downtime = 160 -- cannot be banked, must be sold
			item.nodes = 8
		elseif string.find(item.pageName,'Chestnut') then
			item.downtime = 80 
			item.nodes = 6
		elseif string.find(item.pageName,'Bone Spike') then
			item.downtime = 0
			item.nodes = 8
		elseif string.find(item.pageName,'Tangfruit') then
			item.downtime = 150 -- cannot be banked, must be sold
			item.nodes = 6
		elseif string.find(item.pageName,'Catkin') then
			item.downtime = 60
			item.nodes = 6
		elseif string.find(item.pageName,'Femur Shard') then
			item.downtime = 80
			item.nodes = 8
		elseif string.find(item.pageName,'Clover') then
			item.downtime = 40
			item.nodes = 8
		elseif string.find(item.pageName,'Snake Scale') then
			item.downtime = 60
			item.nodes = 8
		elseif string.find(item.pageName,'Orchid') then
			item.downtime = 60
			item.nodes = 8
		elseif string.find(item.pageName,'Dock Leaf') then
			item.downtime = 80 -- portal back after depositing
			item.nodes = 8
		elseif string.find(item.pageName,'Sage') then
			item.downtime = 120 -- portal to deposit then run back
			item.nodes = 6
		elseif string.find(item.pageName,'Thistle') then
			item.downtime = 100
			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
			: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()
		
			-- 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
Retrieved from ‘https://brightershoreswiki.org/w/Module:GathererList?oldid=89075’