Module:GetRecipes: Difference between revisions

From Eco - English Wiki
[unchecked revision][unchecked revision]
No edit summary
No edit summary
Line 1: Line 1:
-- Module:GetRecipes (https://wiki.play.eco/en/Module:GetRecipes)
-- Module:GetRecipes (https://wiki.play.eco/en/Module:GetRecipes)
local p = {}
local p = {}


-- Grabs args from the parent frame
-- Grabs args from the parent frame
Line 18: Line 17:
     return args
     return args
end
end


-- Main entry point for the Module
-- Main entry point for the Module
Line 36: Line 34:
local productsList = completeList.products
local productsList = completeList.products
     local tableList = completeList.tables
     local tableList = completeList.tables
   
    -- groups no longer exists. Need to check all dependencies on this throughout other modules. Expecting implication to be removal of 'used in' table in the wiki.
    --local groupList = completeList.groups
      
      
     -- initialize a table to store recipes
     -- initialize a table to store recipes
     local recipes = {}
     local recipes = {}
local products = {}
local ingredients = {}
      
      
     -- load CraftingParser
     -- load CraftingParser
Line 48: Line 45:
     -- priority: item > table > group
     -- priority: item > table > group
     if item ~= nil then
     if item ~= nil then
      local products = productsList[item]
  local ingredients = ingredientsList[item]
if productsList[item] ~= nil then
for num = 1, #productsList do
if (productsList[item][num] ~= '' and recipeList[productsList[item][num]] ~= nil) then
products[num] = recipeList[productsList[item][num]]
end
end
end
if ingredientsList[item] ~= nil then
for num = 1, #ingredientsList do
if (ingredientsList[item][num] ~= '' and recipeList[ingredientsList[item][num]] ~= nil) then
ingredients[num] = recipeList[ingredientsList[item][num]]
end
end
end
          
          
       return parser.formattedItem( products, ingredients, item )
       return parser.formattedItem( products, ingredients, item )
          
          
     elseif table ~= nil then
     --elseif table ~= nil then
--GROUP deprecated
         --for num = 1, #tableList[table] do
         --if group ~= nil then
             --recipes[num] = recipeList[tableList[table][num]]
            --local count = 1
            --for num = 1, #tableList[table] do
                --for gnum = 1, #groupList[group] do
                    --if tableList[table][num] == groupList[group][gnum] then
                        --recipes[count] = recipeList[tableList[table][num]]
                        --count = count + 1
                    --end
                --end
             --end
        --else
            for num = 1, #tableList[table] do
                recipes[num] = recipeList[tableList[table][num]]
            end
         --end
         --end
         return parser.formattedTable( recipes, table )
 
    --GROUP deprecated
         --return parser.formattedTable( recipes, table )
    --elseif group ~= nil then
 
        --for num = 1, #groupList[group] do
            --recipes[num] = recipeList[groupList[group][num]]
        --end
        --return parser.formattedGroup( recipes, group )
     else
     else
         return 'Invalid use of parameters, please see [[Template:GetRecipes]].'
         return 'Invalid use of parameters, please see [[Template:GetRecipes]].'
     end
     end
end
end


return p
return p

Revision as of 06:18, 31 January 2021

Documentation

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:


-- Module:GetRecipes (https://wiki.play.eco/en/Module:GetRecipes)
local p = {}

-- Grabs args from the parent frame
-- Trims and parses the args into a table, then returns the table
function norm()
    local origArgs = mw.getCurrentFrame():getParent().args
    local args = {}
    
    for k, v in pairs( origArgs ) do
        v = mw.text.trim( tostring( v ) )
        if v ~= '' then
            args[k] = v
        end
    end
    
    return args
end

-- Main entry point for the Module
function p.main()
    -- get args from the Template
    local args = norm()
    
    -- assign variables for item, table, and group
    local item = args.item
    local table = args.table
    local group = args.group

    -- load list of recipes
    local completeList = require( "Module:CraftingRecipes" )
    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 > table > group
    if item ~= nil then
		
		if productsList[item] ~= nil then
			for num = 1, #productsList do
				if (productsList[item][num] ~= '' and recipeList[productsList[item][num]] ~= nil) then
					products[num] = recipeList[productsList[item][num]]
				end
			end			
		end
		
		if ingredientsList[item] ~= nil then
			for num = 1, #ingredientsList do
				if (ingredientsList[item][num] ~= '' and recipeList[ingredientsList[item][num]] ~= nil) then
					ingredients[num] = recipeList[ingredientsList[item][num]]
				end
			end
		end
        
       return parser.formattedItem( products, ingredients, item )
        
    --elseif table ~= nil then
        --for num = 1, #tableList[table] do
            --recipes[num] = recipeList[tableList[table][num]]
        --end

        --return parser.formattedTable( recipes, table )

    else
        return 'Invalid use of parameters, please see [[Template:GetRecipes]].'
    end
end

return p