Editing Module:LeatherworkerList

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
require('strict')
require('strict')
require('Module:Mw.html extension')
require('Module:Mw.html extension')
local recipe = require('Module:Infobox Recipe') -- to make use of its extensive material searching function
local lang = mw.getContentLanguage()
local plist = require('Module:ProfessionList')
local param = require( 'Module:Paramtest' )
local search = require('Module:RecipeTreeSearch')
local currency = require('Module:Currency')
local discount = require('Module:MerchantHideDiscount')
local discount = require('Module:MerchantHideDiscount')
local lang = mw.getContentLanguage()
local purge = require('Module:Purge')._purge


local p = {}
local p = {}
Line 12: Line 12:
function p.main()
function p.main()
-- main query returns only directly needed parameter needed for the row,
local queryString = '[[Category:Leatherworker]] AND [[Category:Pages with recipes]]'
-- other parameters are determined by subqueries of chained pages
local query = {
'[[-Sold item.Sold by::Leather stall]]',
'[[Recipe JSON::~*]]', -- the stall sells scraps and we need to ignore those
'?Uses facility #- = facility',
'?Profession Level A = lvl',
'? #- = name',
'?Recipe JSON = recipeJSON',
'?Activity XP = XP',
'?Activity duration = duration',
'?Value = sell',
'?Activity coins = coins',
'sort = Profession Level A',
'limit = 500'
}
local results = mw.smw.ask(query)
-- criterion for if an entry is a recipe, or a passive activity
local function screenFunction(item)
for _, item in ipairs(results) do
local product = (item.output and item.output[1] and item.output[1].name) or ''
item.passiveActivity = false -- no passives in this list
return string.find(product,'Leather') and (not item.passive)
end
end
local results = plist.generate_recipe_table(queryString,screenFunction)

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


Line 28: Line 42:
--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
local unpackJSON = mw.text.jsonDecode(item.recipeJSON)
-- sole hide material
item.outputQuantity = unpackJSON.output[1].quantity
item.material = (item.materials and item.materials[1] and item.materials[1].name) or ''

-- list of all pages to edit, if edit is needed
-- call the module:infobox recipe to extensively search for
-- all raw materials (to add to prices)
item.allPageEdits = { item.pageName }
-- all intermediate materials (for intermediate XP and duration)
for _,intermediate in ipairs(item.intermediateMaterials) do
local Materials = recipe._getTrueRawMaterials(unpackJSON.materials)
table.insert(item.allPageEdits,intermediate.name)
if next(Materials) ~= nil then
item.materials = Materials.rawMaterials
item.intermediates = Materials.intermediateMaterials
end
end
-- iterate through materials, adding buy price to running total (individuals not needed)
item.buy = 0
item.buyDiscount = 0
for _, material in ipairs(item.materials) do
--shamelessley lifted from Module:Products
-- poles will show as making 1 and using 0.5 log, which doesnt match the look of planks or staves
local shopPriceQuery = '[[:+]][[Sold item::' .. material.name .. ']]|?Shop buy price|mainlabel=' .. material.name
-- double them,
local shopPriceResult = mw.smw.ask(shopPriceQuery) or {}
if item.pageName and string.find(item.pageName,'Pole') then
local shopPrice = 0
item.output[1].quantity = item.output and item.output[1] and item.output[1].quantity and item.output[1].quantity * 2
item.buyPrice = item.buyPrice and item.buyPrice * 2
item.sellPrice = item.sellPrice and item.sellPrice * 2
item.profit = item.profit and item.profit * 2
item.xp = item.xp and item.xp * 2
item.duration = item.duration and item.duration * 2
if shopPriceResult[1] and shopPriceResult[1]["Shop buy price"] then
for j,jtem in ipairs(item.materials) do
shopPrice = tonumber(shopPriceResult[1]["Shop buy price"]) or 0
jtem.quantity = jtem.quantity and jtem.quantity * 2
else
item.buy = nil
end
end

item.buy = item.buy and item.buy + shopPrice * material.quantity
--with the merchant discount, buy price is sell price
local shopPriceQuery = '[[:+]][[Sold item::' .. material.name .. ']]|?Shop sell price|mainlabel=' .. material.name
local shopPriceResult = mw.smw.ask(shopPriceQuery) or {}
local shopPrice = 0
if shopPriceResult[1] and shopPriceResult[1]["Shop sell price"] then
shopPrice = tonumber(shopPriceResult[1]["Shop sell price"]) or 0
else
item.buyDiscount = nil
end

item.buyDiscount = item.buyDiscount and item.buyDiscount + shopPrice * material.quantity
end
end
-- iterate through intermediaries to add to XP and duration parameters
-- profitability
for _, intermediate in ipairs(item.intermediates) do
item.profitPerXP = item.profit and item.xp and item.profit / item.xp
-- look up activity XP and add it to running total
-- 40 seconds to buy new supplies and travel and deposit and everything, per 12 potions
local XPQuery = '[[Recipe output::' .. intermediate.name .. ']]|?Activity XP|mainlabel=' .. intermediate.name
local XPResult = mw.smw.ask(XPQuery) or {}
local XPIncrease = 0
if XPResult[1] and XPResult[1]["Activity XP"] then
XPIncrease = tonumber(XPResult[1]["Activity XP"]) or 0
else
XPIncrease = nil
end
-- need to look up both the amount of the item used in this recipe and created in its own recipe to know how much of this xp to use
local QTYused = intermediate.quantity

local QTYQuery = '[[Recipe output::' .. intermediate.name .. ']]|?Recipe JSON|mainlabel=' .. intermediate.name
local QTYResult = mw.smw.ask(QTYQuery) or {}
local QTYmade = 0
if QTYResult[1] and QTYResult[1]["Recipe JSON"] then
QTYmade = mw.text.jsonDecode(QTYResult[1]["Recipe JSON"]) or {}
end
QTYmade = QTYmade.output[1].quantity
item.XP = item.XP and XPIncrease and item.XP + XPIncrease * QTYused / QTYmade;
-- look up activity duration and add it to running total
local durationQuery = '[[Recipe output::' .. intermediate.name .. ']]|?Activity duration|mainlabel=' .. intermediate.name
local durationResult = mw.smw.ask(durationQuery) or {}
local durationIncrease = 0
if durationResult[1] and durationResult[1]["Activity duration"] then
durationIncrease = tonumber(durationResult[1]["Activity duration"]) or 0
else
durationIncrease = nil
end
item.duration = item.duration and durationIncrease and item.duration + durationIncrease * intermediate.quantity
end

-- direct values
item.sell = item.sell and item.outputQuantity and item.sell * item.outputQuantity
item.profit = item.sell and item.buy and item.sell - item.buy
item.profitDiscount = item.sell and item.buyDiscount and item.sell - item.buyDiscount
item.profitPerXP = item.profit and item.XP and math.floor(item.profit / item.XP * 100) / 100
item.profitPerXPDiscount = item.profitDiscount and item.XP and math.floor(item.profitDiscount / item.XP * 100) / 100
local hideName = string.gsub(item.name,'Leather','Hide')
item.discountLevel = discount[hideName]

-- a lot of downtime in leatherworker
-- 1min 40s to go from hide stall to tannery, run round the tannery, run to leather stall, then back to hide stall
local batchSize = 24
local batchSize = 24
local downtime = 100
local downtime = 100
Line 75: Line 165:


-- 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.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)
item.profitPerHourDiscount = item.profit and item.productPerHour and math.floor(item.profit * item.productPerHour)
-- discounted buy price is not provided by the search, have to do it manually
item.discountLevel = discount[item.material]
item.buyPriceDiscount = search.getShopSellPrice(item.material)
item.profitDiscount = item.sellPrice and item.buyPriceDiscount and item.sellPrice - item.buyPriceDiscount
item.profitPerHourDiscount = item.profitDiscount and item.productPerHour and math.floor(item.profitDiscount * item.productPerHour)
item.profitPerHourDiscount = item.profitDiscount and item.productPerHour and math.floor(item.profitDiscount * item.productPerHour)
end
end


Line 92: Line 175:
-- 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')
Line 109: Line 183:
:tag('th')
:tag('th')
:attr{ colspan = '3' }
:attr{ colspan = '3' }
:wikitext('Products')
:wikitext('Product')
:done()
:done()
:tag('th')
:tag('th')
:attr{ colspan = '3' }
:wikitext('Materials')
:wikitext('Materials')
:done()
:done()
Line 137: Line 210:
: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
local row = out:tag('tr')
local row = out:tag('tr')
:IF(item.lvl)
--level
:IF(item.level)
:tag('td')
:tag('td')
:css{ ['text-align'] = 'center' }
:css{ ['text-align'] = 'center' }
:wikitext(item.level)
:wikitext(item.lvl)
:done()
:done()
:ELSE()
:ELSE()
:node(unknown_value_cell)
:node(plist.unknown_value_edit_cell(item.pageName,1))
:END()
:END()

:tag('td')
:css{ ['border-right'] = '0', ['padding-right'] = '0', ['text-align'] = 'right' }
:attr{ ['data-sort-value'] = item.name }
:wikitext(item.outputQuantity .. ' &times;')
:done()
:tag('td')
:addClass('plinkt-image no-border')
:css{ ['border-left'] = '0', ['padding-left'] = '0' }
:wikitext('[[File:' .. item.name .. '.png|link=' .. item.name .. '|30px]]')
:done()
:tag('td')
:addClass('plinkt-link no-border')
:wikitext('[[' .. item.name .. ']]')
:done()
:IF(not(item.passiveActivity))
-- recipe

:node(plist.three_column_image_text(item.product,1,'File:' .. item.product .. '.png',item.product,item.product))
local materialCell = row:tag('td')
for i, _ in ipairs(item.materials) do
materialCell:wikitext(item.materials[i].quantity .. '&times; [[File:' .. item.materials[i].name .. '.png|30px|link=' .. item.materials[i].name .. ']] [[' .. item.materials[i].name .. ']]<br>')
end
row
-- materials

:node(plist.three_column_image_text(item.material,1,'File:' .. item.material .. '.png',item.material,item.material))
:ELSE()
:tag('td')
:addClass('table-na')
:attr{ colspan = '21' }
:wikitext('N/A')
:done()
:END()
:node(plist.currency_cell(item.profit))
:node(plist.currency_cell(item.profitPerHour))
:node(currency_cell(item.profit))
:node(currency_cell(item.profitPerHour))
:tag('td')
:tag('td')
Line 164: Line 268:
:wikitext(item.discountLevel)
:wikitext(item.discountLevel)
:done()
:done()
:node(plist.currency_cell(item.profitPerHourDiscount))
:node(currency_cell(item.profitPerHourDiscount))


-- XP
:IF(item.XP)
:IF(item.xp)
:tag('td')
:tag('td')
:wikitext(item.xp and lang:formatNum(tonumber(item.xp)))
:wikitext(item.XP and lang:formatNum(tonumber(item.XP)))
:done()
:done()
:ELSE()
:ELSE()
:node(unknown_value_cell)
:node(plist.unknown_value_edit_cell(item.allPageEdits,1))
:END()
:END()

:IF(item.XPPerHour)
-- XP per hour
:IF(item.xpPerHour)
:tag('td')
:tag('td')
:wikitext(item.xpPerHour and lang:formatNum(tonumber(item.xpPerHour)))
:wikitext(item.XPPerHour and lang:formatNum(tonumber(item.XPPerHour)))
:done()
:done()
:ELSE()
:ELSE()
:node(plist.unknown_value_cell(1))
:node(unknown_value_cell)
:END()
:END()

:done()
:done()
end
end
Please note that all contributions to Brighter Shores Wiki are considered to be released under the CC BY-NC-SA 3.0 (see Brighter Shores:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

Templates used on this page:

This page is a member of a hidden category:

Retrieved from ‘https://brightershoreswiki.org/w/Module:LeatherworkerList’