Editing Module:Infobox Recipe
Jump to navigation
Jump to search
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('Module:Mw.html extension') |
|||
local currency = require('Module:Currency') |
|||
local hc = require('Module:Param Parse').has_content |
|||
local yn = require('Module:Yesno') |
|||
local editButton = require('Module:Edit button') |
|||
local function currency_cell(amount) |
|||
return currency._cell(amount, { html = 'yes' }) |
|||
end |
|||
local p = {} |
local p = {} |
||
function p._main(frame) |
function p._main(frame) |
||
local args = frame:getParent().args |
local args = frame:getParent().args |
||
local mw = require('mw') |
|||
local currency = require('Module:Currency').parse |
|||
local parse = require('Module:Param Parse') |
|||
local yn = require('Module:Yesno') |
|||
--If set to true, will check if any of the items passed as a rawmaterialparam are actually intermediate materials. Will then change the display order of the infobox. |
--If set to true, will check if any of the items passed as a rawmaterialparam are actually intermediate materials. Will then change the display order of the infobox. |
||
local showFullRecipe = yn(args.showFull or 'no', false) |
local showFullRecipe = yn(args.showFull or 'no', false) |
||
--Get each of the rawmatX parameters from params and store their values in a new table |
--Get each of the rawmatX parameters from params and store their values in a new table |
||
local argsMaterials = p._extractRawMaterials(args) |
local argsMaterials = p._extractRawMaterials(args) |
||
--empty tables to hold materials |
--empty tables to hold materials |
||
local rawMaterials = {} |
local rawMaterials = {} |
||
local intermediateMaterials = {} |
local intermediateMaterials = {} |
||
--counter for total price of raw materials |
--counter for total price of raw materials |
||
local rawMaterialCost = 0 |
local rawMaterialCost = 0 |
||
--get the value for the output product |
--get the value for the output product |
||
local output1Value = |
local output1Value = args.output1 and mw.smw.ask('[[:+]][[' .. args.output1 .. ']]|?Value|limit=1') |
||
if args.output1 then |
|||
output1Value = mw.smw.ask('[[:+]][[' .. args.output1 .. ']]|?Value|limit=1') or 0 |
|||
end |
|||
--Calculate total value of output material(s) |
|||
local output1TotalValue = 0 |
local output1TotalValue = 0 |
||
mw.logObject(output1Value[1]['Value']) |
|||
if output1Value[1]['Value'] ~= nil then |
|||
output1TotalValue = output1Value[1]['Value'] * (tonumber(args.output1qty) or 1) |
|||
else |
|||
output1TotalValue = 0 |
|||
end |
|||
end |
end |
||
--Check if any of the raw mats provided are intermediate products, if they are, return their own raw materials |
--Check if any of the raw mats provided are intermediate products, if they are, return their own raw materials |
||
if showFullRecipe then |
if showFullRecipe then |
||
local |
local trueRawMaterials = p._getTrueRawMaterials(argsMaterials) |
||
if next( |
if next(trueRawMaterials) ~= nil then |
||
rawMaterials = |
rawMaterials = trueRawMaterials |
||
intermediateMaterials = |
intermediateMaterials = argsMaterials |
||
end |
end |
||
else |
else |
||
Line 58: | Line 41: | ||
end |
end |
||
--Simple query to get the shop buy price for the provided material, if no buy price is available returns 0 |
--Simple query to get the shop buy price for the provided material, if no buy price is available returns 0 |
||
local function getBuyPrice(material) |
local function getBuyPrice(material) |
||
Line 68: | Line 49: | ||
return 0 |
return 0 |
||
end |
end |
||
--If one of the raw materials provided as a param has been identified as an intermediate material then get the facility it is created at to display in the intermediate Ingredient row |
--If one of the raw materials provided as a param has been identified as an intermediate material then get the facility it is created at to display in the intermediate Ingredient row |
||
Line 81: | Line 60: | ||
return pageName |
return pageName |
||
end |
end |
||
--Set SMW properties |
--Set SMW properties |
||
if args.rawmat1 then |
|||
for _,material in ipairs(argsMaterials) do |
|||
mw.smw.set({ |
|||
["Uses item"] = |
["Uses item"] = args.rawmat1, |
||
}) |
|||
["Uses item_and_quantity"] = material.name .. ',' .. tostring(material.quantity) |
|||
end |
|||
if args.rawmat2 then |
|||
mw.smw.set({ |
|||
["Uses item"] = args.rawmat2, |
|||
}) |
|||
end |
|||
if args.rawmat3 then |
|||
mw.smw.set({ |
|||
["Uses item"] = args.rawmat3, |
|||
}) |
}) |
||
end |
end |
||
if args.facility then |
if args.facility then |
||
mw.smw.set({ |
mw.smw.set({ |
||
Line 98: | Line 83: | ||
end |
end |
||
--Creates a row suitable for the raw materials section of the infobox. Quantity is optional, if no value is provided it will default to 1 |
|||
local function createRawMaterialRow(item, quantity) |
|||
local materialBuyPrice = getBuyPrice(item) |
|||
--Creates a row suitable for the raw materials section of the infobox. |
|||
local function createRawMaterialRow(item) |
|||
local materialBuyPrice = getBuyPrice(item) * (item.quantity or 1) |
|||
rawMaterialCost = rawMaterialCost + materialBuyPrice |
rawMaterialCost = rawMaterialCost + materialBuyPrice |
||
local row = {} |
|||
return mw.html.create('tr') |
|||
table.insert(row, '| [[File:' .. item['name'] .. '.png|30px]]') |
|||
:tag('td') |
|||
table.insert(row, '| [[' .. item['name'] .. ']]') |
|||
table.insert(row, '| style="text-align: right;" | ' .. (quantity or 1)) |
|||
:wikitext('[[File:' .. item.name .. '.png|30px|link=' .. item.name .. ']]') |
|||
table.insert(row, '| style="text-align: right;" | ' .. currency(materialBuyPrice)) |
|||
:done() |
|||
table.insert(row, '|-') |
|||
return row |
|||
:css{ ['border-left'] = 'none' } |
|||
:wikitext('[[' .. item.name .. ']]') |
|||
:done() |
|||
:tag('td') |
|||
:css{ ['text-align'] = 'right' } |
|||
:wikitext(item.quantity or 1) |
|||
:done() |
|||
:wikitext(currency_cell(materialBuyPrice)) |
|||
:done() |
|||
end |
end |
||
--Creates a row suitable for the intermediate materials section of the infobox. Quantity is optional, if no value is provided it will default to 1 |
|||
local function createIntermediateMaterialRow(item, quantity) |
|||
local row = {} |
|||
--Creates a row suitable for the intermediate materials section of the infobox. |
|||
local facility = getFacility(item) |
|||
table.insert(row, '| [[File:' .. item .. '.png|30px]]') |
|||
local facility = getFacility(item.name) |
|||
table.insert(row, '| [[' .. item .. ']]') |
|||
return mw.html.create('tr') |
|||
table.insert(row, '| style="text-align: right;" | ' .. (quantity or 1)) |
|||
:tag('td') |
|||
table.insert(row, '| style="text-align: right;" | [[File:' .. facility .. '.png|30px]] [[' .. facility .. ']]') |
|||
:css{ ['border-right'] = 'none' } |
|||
table.insert(row, '|-') |
|||
:wikitext('[[File:' .. item.name .. '.png|30px|link=' .. item.name .. ']]') |
|||
return row |
|||
:done() |
|||
:tag('td') |
|||
:css{ ['border-left'] = 'none' } |
|||
:wikitext('[[' .. item.name .. ']]') |
|||
:done() |
|||
:tag('td') |
|||
:css{ ['text-align'] = 'right' } |
|||
:wikitext(item.quantity or 1) |
|||
:done() |
|||
:tag('td') |
|||
:attr{ colspan = '10' } |
|||
:css{ ['text-align'] = 'left' } |
|||
:wikitext('[[File:' .. facility .. '.png|30px|link=' .. facility .. ']] [[' .. facility .. ']]') |
|||
:done() |
|||
:done() |
|||
end |
end |
||
-- Recipe Table Head |
-- Recipe Table Head |
||
local out = |
local out = {} |
||
table.insert(out, '{| class="wikitable"') |
|||
table.insert(out, '! colspan="4" | Requirements') |
|||
:tag('tr') |
|||
table.insert(out, '|-') |
|||
:tag('th') |
|||
table.insert(out, '! colspan="2" | Facility') |
|||
:attr{ colspan = '13' } |
|||
table.insert(out, '| colspan="2" | ' .. (args.facility and '[[' .. args.facility .. ']]' or 'Unknown')) |
|||
:wikitext('Requirements') |
|||
table.insert(out, '|-') |
|||
:done() |
|||
table.insert(out, '! colspan="2" | Profession') |
|||
:done() |
|||
table.insert(out, '! Level') |
|||
:tag('tr') |
|||
table.insert(out, '! XP') |
|||
:tag('th') |
|||
table.insert(out, '|-') |
|||
:attr{ colspan = '2' } |
|||
table.insert(out, '| colspan="2" style="text-align:center;" | ' .. (args.profession and '[[' .. args.profession .. ']]' or 'Unknown')) |
|||
:wikitext('Facility') |
|||
table.insert(out, '| style="text-align: center;" | ' .. (args.level or 'Unknown')) |
|||
:done() |
|||
table.insert(out, '| style="text-align: center;" | ' .. (args.exp or 'Unknown')) |
|||
:tag('td') |
|||
table.insert(out, '|-') |
|||
:attr{ colspan = '11' } |
|||
:wikitext(hc(args.facility) and ('[[File:%s.png|link=%s|30px]] [[%s]]'):format(args.facility, args.facility, args.facility) or editButton("'''?''' (edit)")) |
|||
:done() |
|||
:done() |
|||
:tag('tr') |
|||
:tag('th') |
|||
:attr{ colspan = '2' } |
|||
:wikitext('Profession') |
|||
:done() |
|||
:tag('th') |
|||
:wikitext('Level') |
|||
:done() |
|||
:tag('th') |
|||
:attr{ colspan = '10' } |
|||
:wikitext('XP') |
|||
:done() |
|||
:done() |
|||
:tag('tr') |
|||
:tag('td') |
|||
:attr{ colspan = '2' } |
|||
:css{ ['text-align'] = 'center' } |
|||
:wikitext(hc(args.profession) and ('[[' .. args.profession .. ']]') or editButton("'''?''' (edit)")) |
|||
:done() |
|||
:tag('td') |
|||
:css{ ['text-align'] = 'center' } |
|||
:wikitext(hc(args.level) and (args.level) or editButton("'''?''' (edit)")) |
|||
:done() |
|||
:tag('td') |
|||
:attr{ colspan = '10' } |
|||
:css{ ['text-align'] = 'center' } |
|||
:wikitext(hc(args.exp) and (args.exp) or editButton("'''?''' (edit)")) |
|||
:done() |
|||
:done() |
|||
-- Add raw materials |
-- Add raw materials |
||
-- Headers |
-- Headers |
||
table.insert(out, '! colspan="2" | Raw Ingredient') |
|||
:tag('tr') |
|||
table.insert(out, '! Quantity') |
|||
:tag('th') |
|||
table.insert(out, '! Cost') |
|||
:attr{ colspan = '2' } |
|||
table.insert(out, '|-') |
|||
:wikitext('Raw Ingredient') |
|||
:done() |
|||
:tag('th') |
|||
:wikitext('Quantity') |
|||
:done() |
|||
:tag('th') |
|||
:attr{ colspan = '10' } |
|||
:wikitext('Cost') |
|||
:done() |
|||
:done() |
|||
-- Values |
-- Values |
||
for _, material in ipairs(rawMaterials) do |
for _, material in ipairs(rawMaterials) do |
||
local row = createRawMaterialRow(material) |
|||
for _, value in ipairs(row) do |
|||
table.insert(out, value) |
|||
end |
|||
end |
end |
||
-- Add total raw cost |
-- Add total raw cost |
||
table.insert(out, '! colspan="3" | Total Raw cost') |
|||
out |
|||
table.insert(out, '| style="text-align: right;" | ' .. currency(rawMaterialCost)) |
|||
:tag('tr') |
|||
table.insert(out, '|-') |
|||
:tag('th') |
|||
:attr{ colspan = '3' } |
|||
:wikitext('Total Raw cost') |
|||
:done() |
|||
:wikitext(currency_cell(rawMaterialCost)) |
|||
:done() |
|||
-- Add Intermediate steps if required |
-- Add Intermediate steps if required |
||
Line 234: | Line 149: | ||
if next(intermediateMaterials) ~= nil then |
if next(intermediateMaterials) ~= nil then |
||
-- Headers |
-- Headers |
||
table.insert(out, '! colspan="2" | Intermediate Ingredient') |
|||
out |
|||
table.insert(out, '! Quantity') |
|||
:tag('tr') |
|||
table.insert(out, '! Facility') |
|||
:tag('th') |
|||
table.insert(out, '|-') |
|||
:attr{ colspan = '2' } |
|||
:wikitext('Intermediate Ingredient') |
|||
:done() |
|||
:tag('th') |
|||
:wikitext('Quantity') |
|||
:done() |
|||
:tag('th') |
|||
:attr{ colspan = '10' } |
|||
:wikitext('Faciltity') |
|||
:done() |
|||
:done() |
|||
-- Values |
-- Values |
||
for _, material in ipairs(intermediateMaterials) do |
for _, material in ipairs(intermediateMaterials) do |
||
local row = createIntermediateMaterialRow(material['name']) |
|||
for _, value in ipairs(row) do |
|||
out:node(createIntermediateMaterialRow(material)) |
|||
table.insert(out, value) |
|||
end |
|||
end |
end |
||
end |
end |
||
Line 258: | Line 165: | ||
-- Add output data |
-- Add output data |
||
-- Headers |
-- Headers |
||
table.insert(out, '! colspan="2" | Output') |
|||
out |
|||
table.insert(out, '! Quantity') |
|||
:tag('tr') |
|||
table.insert(out, '! Value') |
|||
:tag('th') |
|||
table.insert(out, '|-') |
|||
:attr{ colspan = '2' } |
|||
:wikitext('Output') |
|||
:done() |
|||
:tag('th') |
|||
:wikitext('Quantity') |
|||
:done() |
|||
:tag('th') |
|||
:attr{ colspan = '10' } |
|||
:wikitext('Value') |
|||
:done() |
|||
:done() |
|||
:IF(args.output1) |
|||
-- Values |
-- Values |
||
table.insert(out, '| [[File:' .. args.output1 .. '.png|30px]]') |
|||
:tag('tr') |
|||
table.insert(out, '| ' .. (args.output1 and '[[' .. args.output1 .. ']]' or 'Unknown')) |
|||
:tag('td') |
|||
table.insert(out, '| style="text-align: right;" | ' .. (args.output1qty or 1)) |
|||
:css{ ['border-right'] = 'none' } |
|||
table.insert(out, '| style="text-align: right;" | ' .. currency(output1TotalValue)) |
|||
:wikitext('[[File:' .. args.output1 .. '.png|30px|link=' .. args.output1 .. ']]' or 'Unknown') |
|||
table.insert(out, '|-') |
|||
:done() |
|||
:tag('td') |
|||
:css{ ['border-left'] = 'none' } |
|||
:wikitext('[[' .. args.output1 .. ']]' or 'Unknown') |
|||
:done() |
|||
:tag('td') |
|||
:css{ ['text-align'] = 'right' } |
|||
:wikitext(args.output1qty or 1) |
|||
:done() |
|||
:wikitext(currency_cell(output1TotalValue)) |
|||
:done() |
|||
:END() |
|||
-- Add profit data |
-- Add profit data |
||
table.insert(out, '! colspan="3" | Profit') |
|||
:tag('tr') |
|||
table.insert(out, '| style="text-align: right;" | ' .. currency(output1TotalValue - rawMaterialCost)) |
|||
:tag('th') |
|||
table.insert(out, '|}') |
|||
:attr{ colspan = '3' } |
|||
:wikitext('Profit') |
|||
:done() |
|||
:wikitext(currency_cell(output1TotalValue - rawMaterialCost)) |
|||
:done() |
|||
return out |
return table.concat(out, '\n') |
||
end |
end |
||
function p._extractRawMaterials(args) |
function p._extractRawMaterials(args) |
||
Line 321: | Line 201: | ||
end |
end |
||
--This function takes a table containing the raw materials params received from the calling template. |
|||
--For each of the raw materials, a query will be executed to see if it has the property 'Uses item'. |
|||
--If it does, that means that the 'raw material' is actually an 'intermediate material' as it is itself created. |
|||
--The materials required to create this intermediate material will be retrieved and added to the rawMaterials table. |
|||
--This allows for a full recipe to be shown where only intermediate ingredients were provided. |
|||
function p._getTrueRawMaterials(argsMaterials) |
function p._getTrueRawMaterials(argsMaterials) |
||
local queryResult = {} |
|||
for _, item in pairs(argsMaterials) do |
|||
local intermediateMaterials = {} |
|||
if item["name"] then |
|||
local result = mw.smw.ask('[[:+]][[' .. item["name"] .. ']]|?Uses item') |
|||
if result and result[1] and result[1]["Uses item"] then |
|||
local function _processMaterial(material, quantity) |
|||
local usesItems = result[1]["Uses item"] |
|||
if material then |
|||
local result = mw.smw.ask('[[:+]][[' .. material .. ']]|?Uses item|?Uses item_and_quantity') |
|||
if result and result[1] and result[1]["Uses item"] then |
|||
-- The item is an intermediate material, add it to intermediateMaterials |
|||
table.insert(intermediateMaterials, { ["name"] = material, ["quantity"] = quantity }) |
|||
-- Add the raw materials used by this intermediate material to rawMaterials |
|||
local usesItems = result[1]["Uses item"] |
|||
local quantities = result[1]["Uses item and quantity"] |
|||
-- If usesItems is a table (multiple items), iterate and add each to queryResult |
|||
if type(usesItems) == "table" then |
|||
if type(usesItems) == "table" then |
|||
for index, usedItem in ipairs(usesItems) do |
|||
for _, usedItem in ipairs(usesItems) do |
|||
local pageName = usedItem:gsub("%[%[", ""):gsub("%]%]", ""):gsub("|.*", ""):gsub("^:", "") |
|||
local pageName = usedItem:gsub("%[%[", ""):gsub("%]%]", ""):gsub("|.*", ""):gsub("^:", "") |
|||
local qty = 1 |
|||
table.insert(queryResult, { ["name"] = pageName, ["quantity"] = 1 }) |
|||
if quantities and type(quantities) == "table" then |
|||
end |
|||
local quantityString = quantities[index] |
|||
else |
|||
local _, q = quantityString:match("(.-),(%d+)") |
|||
-- If usesItems is a single item, add it directly |
|||
qty = tonumber(q) or 1 |
|||
local pageName = usesItems:gsub("%[%[", ""):gsub("%]%]", ""):gsub("|.*", ""):gsub("^:", "") |
|||
end |
|||
table.insert(queryResult, { ["name"] = pageName, ["quantity"] = 1 }) |
|||
_processMaterial(pageName, qty) |
|||
end |
|||
end |
|||
end |
|||
else |
|||
end |
|||
local pageName = usesItems:gsub("%[%[", ""):gsub("%]%]", ""):gsub("|.*", ""):gsub("^:", "") |
|||
end |
|||
local qty = 1 |
|||
return queryResult |
|||
if quantities and type(quantities) == "string" then |
|||
local _, q = quantities:match("(.-),(%d+)") |
|||
qty = tonumber(q) or 1 |
|||
end |
|||
_processMaterial(pageName, qty) |
|||
end |
|||
else |
|||
-- The item is a raw material, add it to rawMaterials |
|||
table.insert(rawMaterials, { ["name"] = material, ["quantity"] = quantity }) |
|||
end |
|||
end |
|||
end |
|||
-- Iterate over the initial argsMaterials |
|||
for _, item in pairs(argsMaterials) do |
|||
if item["name"] then |
|||
_processMaterial(item["name"], item["quantity"]) |
|||
end |
|||
end |
|||
return { rawMaterials = rawMaterials, intermediateMaterials = intermediateMaterials } |
|||
end |
end |
||
function p._reverseTable(t) |
|||
local reversed = {} |
|||
for i = #t, 1, -1 do |
|||
table.insert(reversed, t[i]) |
|||
end |
|||
return reversed |
|||
end |
|||
return p |
return p |