Module:FisherList: Difference between revisions
m (spacing around images) |
m (do not set to 0 if product per hour data isnt there, let it stay at nil) |
||
(16 intermediate revisions by 3 users 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 results = plist.generate_recipe_table(p.queryString,p.screenFunction) |
|||
-- returns only directly needed parameter needed for the row, |
|||
-- other parameters are determined by subqueries of chained pages |
|||
local query = { |
|||
'[[Variant of::Flounder (skill node)||Eel (skill node)||Pufferfish (skill node)||Gurnard (skill node)||Bass (skill node)||Ray (skill node)||Cod (skill node)]]', |
|||
'?Variant of #- = variant', |
|||
'?Profession Level A = lvl', |
|||
'? #- = 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 35: | Line 20: | ||
end |
end |
||
p.queryString = '[[Category:Fisher]] AND [[Category:Pages with activities]]' |
|||
-- makes the html for the cells containing currency directly |
|||
-- Replaces nil with an "unknown" cell |
|||
function p.screenFunction(item) |
|||
return not item.passive |
|||
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 |
||
--catch badly submitted data |
|||
item.material = item.material or '' |
|||
item.product = item.product or '' |
|||
--look up how many actions per hour this type of node can do |
|||
-- price of fish |
|||
local query = '[['..item.pageName..']]|?Variant of.Action per hour banking=productPerHour|?Variant of.Action per hour discarding=productPerHourDropping|?Variant of.Action per hour selling=productPerHourSelling' |
|||
-- query is: there is a shop object page that has this item AND has buy price cannot be "N/A" |
|||
local result = mw.smw.ask(query) |
|||
local query = mw.smw.ask('[[Sold item::' .. item.product .. ']][[Shop sell price::!~N/A]]|?Shop sell price=data|mainlabel=-') |
|||
item.productPerHour = result and result[1] and (result[1].productPerHour or result[1].productPerHourSelling) |
|||
if type(query)=='table' then |
|||
item.productPerHourDropping = result and result[1] and result[1].productPerHourDropping |
|||
-- 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 |
|||
-- profitability |
-- profitability |
||
item. |
item.profit = item.sellPrice |
||
-- 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 |
-- properties per hour |
||
item. |
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 59: | ||
-- 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 sticky-header') |
||
:tag('caption') |
|||
:wikitext('This list is updated dynamically. '..purge()) |
|||
:done() |
|||
:tag('tr') |
:tag('tr') |
||
:tag('th') |
:tag('th') |
||
Line 97: | Line 76: | ||
:tag('th') |
:tag('th') |
||
:attr{ colspan = '2' } |
:attr{ colspan = '2' } |
||
:wikitext(' |
:wikitext('Node') |
||
:done() |
|||
:tag('th') |
|||
:attr{ colspan = '2' } |
|||
:wikitext('Tool') |
|||
:done() |
:done() |
||
:tag('th') |
:tag('th') |
||
Line 119: | Line 102: | ||
: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 112: | ||
--level |
--level |
||
:IF(item. |
:IF(item.level) |
||
:tag('td') |
:tag('td') |
||
:css{ ['text-align'] = 'center' } |
:css{ ['text-align'] = 'center' } |
||
:wikitext(item. |
:wikitext(item.level) |
||
:done() |
:done() |
||
:ELSE() |
:ELSE() |
||
:node(plist.unknown_value_edit_cell(item.pageName,1)) |
|||
:node(unknown_value_cell) |
|||
:END() |
:END() |
||
-- |
-- gathering node |
||
:node(plist.two_column_image_text(item.pageName,item.pageImage,item.product,item.pageName)) |
|||
:tag('td') |
|||
:node(plist.two_column_image_text(item.tool,'File:'..item.tool..' (grade 1).png',item.tool,item.tool)) |
|||
:css{ ['border-right'] = '0', ['text-align'] = 'right', ['max-width'] = '100px' } |
|||
:attr{ ['data-sort-value'] = item.name } |
|||
-- resource |
|||
:wikitext(' [[' .. item.Image .. '|link=' .. item.name .. '|30x30px]]') |
|||
: |
:IF(item.coop) |
||
:node(plist.two_column_image_text(item.product,'File:' .. item.product .. '.png',item.product .. ' (co-op)',item.product)) |
|||
:tag('td') |
|||
:ELSE() |
|||
:addClass('plinkt-link no-border') |
|||
: |
:node(plist.two_column_image_text(item.product,'File:' .. item.product .. '.png',item.product,item.product)) |
||
: |
:END() |
||
-- |
-- resource/hr |
||
: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() |
|||
-- fish/hr |
|||
:IF(item.productPerHour) |
:IF(item.productPerHour) |
||
:tag('td') |
:tag('td') |
||
Line 168: | Line 138: | ||
: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. |
: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. |
: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. |
:IF(item.xpPerHourDropping) |
||
:tag('td') |
:tag('td') |
||
:wikitext(item. |
: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() |
||
Latest revision as of 17:20, 4 February 2025
Module documentation
This documentation is transcluded from Module:FisherList/doc. [edit] [history] [purge]
Module:FisherList's function main is invoked by Template:FisherList.
Module:FisherList requires Module:Mw.html extension.
Module:FisherList requires Module:ProfessionList.
Module:FisherList requires Module:Purge.
Module:FisherList requires strict.
This module is meant to be exclusively used by {{FisherList}}
to generate , see Template:FisherList/doc.
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 results = plist.generate_recipe_table(p.queryString,p.screenFunction)
results = p.formatResults(results)
return p.displayTable(results)
--for debugging
--return '<pre>'..mw.text.jsonEncode(results, mw.text.JSON_PRETTY)..'</pre>'
end
p.queryString = '[[Category:Fisher]] AND [[Category:Pages with activities]]'
function p.screenFunction(item)
return not item.passive
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
--look up how many actions per hour this type of node can do
local query = '[['..item.pageName..']]|?Variant of.Action per hour banking=productPerHour|?Variant of.Action per hour discarding=productPerHourDropping|?Variant of.Action per hour selling=productPerHourSelling'
local result = mw.smw.ask(query)
item.productPerHour = result and result[1] and (result[1].productPerHour or result[1].productPerHourSelling)
item.productPerHourDropping = result and result[1] and result[1].productPerHourDropping
-- profitability
item.profit = item.sellPrice
-- 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 sticky-header')
:tag('caption')
:wikitext('This list is updated dynamically. '..purge())
:done()
:tag('tr')
:tag('th')
:wikitext('[[File:Fisher 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('Fish')
:done()
:tag('th')
:wikitext('Fish/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.product,item.pageName))
:node(plist.two_column_image_text(item.tool,'File:'..item.tool..' (grade 1).png',item.tool,item.tool))
-- resource
: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))
-- 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