Module:Recipe: Difference between revisions

From Subnautica Wiki
(thanks to BryghtShadow, adding search function for finding by name; adding some more documentation; removing disambiguations from pagenames)
m (fixing the search function call)
Line 37: Line 37:
-- First, get the ID of the product item provided by template; pagename used by default
-- First, get the ID of the product item provided by template; pagename used by default
local id = args[1] or mw.title.getCurrentTitle().text
local id = args[1] or mw.title.getCurrentTitle().text
local itemID = getItemID(itemID)
local itemID = p.getItemID(itemID)
if not itemID then error("Could not find recipe for item: " .. id) end
if not itemID then error("Could not find recipe for item: " .. id) end

Revision as of 01:17, 9 June 2022

This module standardizes the display of crafting recipes and makes it easy to display a specified item's recipe or all recipes that use a specified ingredient. See Template:RecipeNew for more information. Thanks to BryghtShadow for helping out with the loops!


--[[
	This module standardizes the display of crafting recipes
	and makes it easy to display a specified item's recipe
	or all recipes that use a specified ingredient.
	Thanks to User:BryghtShadow for helping out with the loops!
--]]

-- <nowiki>
local p = {}
local data = mw.loadData('Module:Recipe/data')
local getArgs = require('Dev:Arguments').getArgs

function p.getItemID(id)
	-- removing disambiguations from pagenames
	id = string.gsub(id, " %(Subnautica%)", "")
	id = string.gsub(id, " %(Below Zero%)", "")
	
	-- if item ID is provided directly...
	if data[id] then
		return id
	end
	
	-- ...otherwise try to find by item name
	for k, v in pairs(data) do
		if v.name == id then -- item found
			return k
		end
	end
	
	return nil -- Could not find item
end

function p.main(frame)
	local args = getArgs(frame)
	local output = ""
	
	-- First, get the ID of the product item provided by template; pagename used by default
	local id = args[1] or mw.title.getCurrentTitle().text
	local itemID = p.getItemID(itemID)
	if not itemID then error("Could not find recipe for item: " .. id) end
	
	-- Item is found, start processing it
	if data[itemID].original then
		-- If the item is made as part of a different item's recipe
		error ("No standalone recipe for item: " .. itemID .. " (use " .. data[itemID].original .. "' instead)")
	else
		if data[itemID].recipe then
			-- Recipe is found, start creating the output
			for i,v in ipairs(data[itemID].recipe) do 
				output = output .. "[[File:" .. data[v[1]].image .. "|50px]] " .. data[v[1]].name .. " -- x" .. v[2] .. "<br>"
			end
			return output
		else
			-- If there is no recipe for the item
			error ("Cannot craft item: '" .. itemID .. "' (use Template:Uses instead)")
		end
	end
end

return p
-- </nowiki>