Module:GetRecipes: Difference between revisions

From Eco - English Wiki
[unchecked revision][checked revision]
No edit summary
No edit summary
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
-- Module:GetRecipes (https://wiki.play.eco/en/Module:GetRecipes)
local p = {}
local p = {}
local Utils = require('Module:Utils')
local Utils = require('Module:Utils')


Line 10: Line 8:
   -- get args from the Template
   -- get args from the Template
   local args = Utils.normaliseArgs(frame)
   local args = Utils.normaliseArgs(frame)
 
 
   -- assign variables for item, table, and group
   return p.renderTable(args.item, args.tag, args.table, args.group)
  local item = args.item
end
  local tag = args.tag
 
  local craftTable = args.table
 
  local group = args.group
function p.renderTable(item, tag, craftTable, group)
 
   -- load list of recipes
   -- load list of recipes
   local completeList = require("Module:CraftingRecipes")
   local completeList = require("Module:RecipeData")
   local recipeList = completeList.recipes
   local recipeList = completeList.recipes
   local ingredientsList = completeList.ingredients
   local ingredientsList = completeList.ingredients
Line 32: Line 29:
   local parser = require("Module:CraftingParser")
   local parser = require("Module:CraftingParser")


   -- priority: item > table > group
   -- priority: item > tag > table > group
   if item ~= nil then
   if item ~= nil then
     local itemProducts
     local itemProducts
Line 45: Line 42:
     if itemProducts ~= nil then
     if itemProducts ~= nil then
       for _, itemProduct in pairs(itemProducts) do
       for _, itemProduct in pairs(itemProducts) do
         if (itemProduct ~= '' and recipeList[itemProduct] ~= nil) then
        -- HACK: Skill books don't show us as a product of research pages, only the skill name.
          table.insert(products, recipeList[itemProduct])
         if string.sub(item, string.len(item) - 9) == 'Skill Book' then
            if (itemProduct ~= '' and recipeList[itemProduct .. ' Skill Book'] ~= nil) then
                table.insert(products, recipeList[itemProduct .. ' Skill Book'])
            end
        elseif (itemProduct ~= '' and recipeList[itemProduct] ~= nil) then
            table.insert(products, recipeList[itemProduct])
         end
         end
       end
       end
Line 52: Line 54:


     local itemIngredients
     local itemIngredients
     if tag and (tag == 'true' or tag == true) then
 
       itemIngredients = {}  
    -- HACK Attempt to handle issue with tool recipes
        
     if ingredientsList[item] and #ingredientsList[item] == 1 and ingredientsList[item][1] == '' then
      -- Tags do not appear in the 'products' list, so have to process manually
       itemIngredients = {item}
       for recipeName, recipe in pairs(recipeList) do
    elseif ingredientsList[item] then
         local foundIngredient = false
       itemIngredients = ingredientsList[item]
        for _, variant in pairs(recipe.variants) do
    end
           for _, ingredient in pairs(variant.ingredients) do
 
            if ingredient[1] == 'TAG' and ingredient[2] == item then
    if itemIngredients ~= nil then
              foundIngredient = true
       for _, itemIngredient in pairs(itemIngredients) do
            end
         if itemIngredient ~= '' then
          if recipeList[itemIngredient] ~= nil then
            table.insert(ingredients, recipeList[itemIngredient])
           -- HACK: Skill books don't show us as a product of research pages, only the skill name.
          elseif recipeList[itemIngredient .. ' Skill Book'] ~= nil then
            table.insert(ingredients, recipeList[itemIngredient .. ' Skill Book'])
           end
           end
         end
         end
        if foundIngredient then
      end
          table.insert(itemIngredients, recipeName)
    end
    return parser.formattedItem(products, ingredients, item)
 
  elseif tag ~= nil then
    itemIngredients = {}   
     
    -- Tags do not appear in the 'products' list, so have to process manually
    for recipeName, recipe in pairs(recipeList) do
      local foundIngredient = false
      for _, variant in pairs(recipe.variants) do
        for _, ingredient in pairs(variant.ingredients) do
          if ingredient[1] == 'TAG' and ingredient[2] == tag then
            foundIngredient = true
          end
         end
         end
       end
       end
    else
       if foundIngredient then
      -- HACK Attempt to handle issue with tool recipes
         table.insert(itemIngredients, recipeName)
       if ingredientsList[item] and #ingredientsList[item] == 1 and ingredientsList[item][1] == '' then
        itemIngredients = {item}
      elseif ingredientsList[item] then
         itemIngredients = ingredientsList[item]
       end
       end
     end
     end


     if itemIngredients ~= nil then
     if itemIngredients ~= nil then
       for _, itemIngredient in ipairs(itemIngredients) do
       for _, itemIngredient in pairs(itemIngredients) do
         if itemIngredient ~= '' then
         if itemIngredient ~= '' then
        if recipeList[itemIngredient] ~= nil then
          if recipeList[itemIngredient] ~= nil then
          table.insert(ingredients, recipeList[itemIngredient])
    table.insert(ingredients, recipeList[itemIngredient])
        -- HACK: Skill books don't show us as a product of research pages, only the skill name.
          end
        elseif recipeList[itemIngredient .. ' Skill Book'] ~= nil then
        table.insert(ingredients, recipeList[itemIngredient .. ' Skill Book'])
        end
         end
         end
       end
       end
     end
     end
    mw.logObject(ingredients)
     return parser.formattedItem(products, ingredients, tag)
     return parser.formattedItem(products, ingredients, item)
      
      
   elseif craftTable ~= nil then
   elseif craftTable ~= nil then
     for num = 1, #tableList[craftTable] do
 
       recipes[num] = recipeList[tableList[craftTable][num]]
    if tableList[craftTable] == nil then
        return 'This object is not a crafting table and cannot craft any objects.'
    end
 
     for _, tbl in pairs(tableList[craftTable]) do
       table.insert(recipes, recipeList[tbl])
     end
     end
      
      

Latest revision as of 10:25, 25 June 2024

Documentation[edit source]

This module is called by Template:GetRecipes, and is the entry point for modules in the system that displays crafting recipes. It takes the item passed to the template, and uses Module:RecipeData to get every recipe related to the item. The resulting list of recipes is then passed to Module:CraftingParser, and the results from CraftingParser are returned to the template.

If the template is passed, this module creates a table using details from the following Modules:


local p = {}
local Utils = require('Module:Utils')

-- Main entry point for the Module
function p.main(frame)
  local test = ''

  -- get args from the Template
  local args = Utils.normaliseArgs(frame)

  return p.renderTable(args.item, args.tag, args.table, args.group) 
end


function p.renderTable(item, tag, craftTable, group)
  -- load list of recipes
  local completeList = require("Module:RecipeData")
  local recipeList = completeList.recipes
  local ingredientsList = completeList.ingredients
  local productsList = completeList.products
  local tableList = completeList.tables
  
  -- initialize a table to store recipes
  local recipes = {}
  local products = {}
  local ingredients = {}
  
  -- load CraftingParser
  local parser = require("Module:CraftingParser")

  -- priority: item > tag > table > group
  if item ~= nil then
    local itemProducts

    -- HACK Attempt to handle issue with tool recipes
    if productsList[item] and #productsList[item] == 1 and productsList[item][1] == '' then
      itemProducts = {item}
    elseif productsList[item] then
      itemProducts = productsList[item]
    end

    if itemProducts ~= nil then
      for _, itemProduct in pairs(itemProducts) do
         -- HACK: Skill books don't show us as a product of research pages, only the skill name.
        if string.sub(item, string.len(item) - 9) == 'Skill Book' then
            if (itemProduct ~= '' and recipeList[itemProduct .. ' Skill Book'] ~= nil) then
                table.insert(products, recipeList[itemProduct .. ' Skill Book'])
            end
        elseif (itemProduct ~= '' and recipeList[itemProduct] ~= nil) then
            table.insert(products, recipeList[itemProduct])
        end
      end
    end

    local itemIngredients

    -- HACK Attempt to handle issue with tool recipes
    if ingredientsList[item] and #ingredientsList[item] == 1 and ingredientsList[item][1] == '' then
      itemIngredients = {item}
    elseif ingredientsList[item] then
      itemIngredients = ingredientsList[item]
    end

    if itemIngredients ~= nil then
      for _, itemIngredient in pairs(itemIngredients) do
        if itemIngredient ~= '' then
          if recipeList[itemIngredient] ~= nil then
            table.insert(ingredients, recipeList[itemIngredient])
          -- HACK: Skill books don't show us as a product of research pages, only the skill name.
          elseif recipeList[itemIngredient .. ' Skill Book'] ~= nil then
            table.insert(ingredients, recipeList[itemIngredient .. ' Skill Book'])
          end
        end
      end
    end
    return parser.formattedItem(products, ingredients, item)

  elseif tag ~= nil then
    itemIngredients = {}    
      
    -- Tags do not appear in the 'products' list, so have to process manually
    for recipeName, recipe in pairs(recipeList) do
      local foundIngredient = false
      for _, variant in pairs(recipe.variants) do
        for _, ingredient in pairs(variant.ingredients) do
           if ingredient[1] == 'TAG' and ingredient[2] == tag then
             foundIngredient = true
           end
        end
      end
      if foundIngredient then
        table.insert(itemIngredients, recipeName)
      end
    end

    if itemIngredients ~= nil then
      for _, itemIngredient in pairs(itemIngredients) do
        if itemIngredient ~= '' then
          if recipeList[itemIngredient] ~= nil then
	    table.insert(ingredients, recipeList[itemIngredient])
          end
        end
      end
    end
    return parser.formattedItem(products, ingredients, tag)
    
  elseif craftTable ~= nil then

    if tableList[craftTable] == nil then
        return 'This object is not a crafting table and cannot craft any objects.'
    end

    for _, tbl in pairs(tableList[craftTable]) do
      table.insert(recipes, recipeList[tbl])
    end
    
    return parser.formattedTable(recipes, craftTable)
    
  else
    return 'Invalid use of parameters, please see [[Template:GetRecipes]].'
  end
end

return p