Module:RecipeController - Revision history

76561198157077871: Now possible to have 8 ingredient options

2025-08-06T00:20:09Z

Now possible to have 8 ingredient options

← Older revision		Revision as of 00:20, 6 August 2025
Line 658:		Line 658:
	error("Cannot construct new Recipe with an empty options list (at index " .. i .. ")")		error("Cannot construct new Recipe with an empty options list (at index " .. i .. ")")
	end		end
	if #optionsArray > 6 then		if #optionsArray > 8 then
	error("Cannot construct new Recipe with an options array larger than 6 subtables (at index " .. i .. ")")		error("Cannot construct new Recipe with an options array larger than 8 subtables (at index " .. i .. ")")
	end		end
	for j, option in ipairs(optionsArray) do		for j, option in ipairs(optionsArray) do

76561198157077871 at 21:50, 27 February 2025

2025-02-27T21:50:25Z

← Older revision		Revision as of 21:50, 27 February 2025
Line 18:		Line 18:
	require("Module:RainCollectorsData"),		require("Module:RainCollectorsData"),
	require("Module:WorkshopsData"),		require("Module:WorkshopsData"),
			require("Module:BlightPostsData")
	}		}

76561197969631737: added MinesData

2025-01-30T22:42:18Z

added MinesData

← Older revision		Revision as of 22:42, 30 January 2025
Line 10:		Line 10:
	local DataModelsWithRecipes = {		local DataModelsWithRecipes = {
	require("Module:ExtractorsData"),		require("Module:ExtractorsData"),
			require("Module:MinesData"),
	require("Module:CampsData"),		require("Module:CampsData"),
	require("Module:FarmsData"),		require("Module:FarmsData"),

76561197969631737: adding extractors data for geyser pump

2025-01-26T02:57:29Z

adding extractors data for geyser pump

← Older revision		Revision as of 02:57, 26 January 2025
Line 9:		Line 9:

	local DataModelsWithRecipes = {		local DataModelsWithRecipes = {
			require("Module:ExtractorsData"),
	require("Module:CampsData"),		require("Module:CampsData"),
	require("Module:FarmsData"),		require("Module:FarmsData"),
Line 172:		Line 173:
	---@return table the same recipeObjectTable, but with new and updated entries		---@return table the same recipeObjectTable, but with new and updated entries
	local function compileRecipeLists(DataModel, recipeObjectTable, rawRecipeTable)		local function compileRecipeLists(DataModel, recipeObjectTable, rawRecipeTable)

			--Skip when nothing to add.
			if not rawRecipeTable or #rawRecipeTable < 1 then
			return recipeObjectTable
			end

	for _, pair in ipairs(rawRecipeTable) do		for _, pair in ipairs(rawRecipeTable) do
Line 180:		Line 186:
	local buildingName = BuildingDataProxy.getName(buildingID)		local buildingName = BuildingDataProxy.getName(buildingID)

	-- Services identify their need by name, but goods to not. If it's a service, this is a simple renaming.		--Services identify their need by name, but goods to not. If it's a service, this is a simple renaming.
	local productName = productID		local productName = productID
	local isService = DataModel:isRecipeProvidingService(pair)		local isService = DataModel:isRecipeProvidingService(pair)
Line 187:		Line 193:
	end		end

	-- Now that we have everything extracted from rawRecipeTable for this pair, load it into recipeObjectTable, whether as a new Recipe object or adding a building to an existing Recipe object if one already exists. Recipes are uniquely identified by the 3-way combination of product, grade, and product amount.		--Now that we have everything extracted from rawRecipeTable for this pair, load it into recipeObjectTable, whether as a new Recipe object or adding a building to an existing Recipe object if one already exists. Recipes are uniquely identified by the 3-way combination of product, grade, and product amount.
	if not recipeObjectTable[productName] then		if not recipeObjectTable[productName] then
	recipeObjectTable[productName] = {}		recipeObjectTable[productName] = {}
	end		end
	-- Transform the grade values to store them in a natural order.		--Transform the grade values to store them in a natural order.
	if not recipeObjectTable[productName][STORE_GRADES[grade]] then		if not recipeObjectTable[productName][STORE_GRADES[grade]] then
	recipeObjectTable[productName][STORE_GRADES[grade]] = {}		recipeObjectTable[productName][STORE_GRADES[grade]] = {}
	end		end
	if not recipeObjectTable[productName][STORE_GRADES[grade]][productAmount] then		if not recipeObjectTable[productName][STORE_GRADES[grade]][productAmount] then
	-- Create a new Recipe object at this place in the table.		--Create a new Recipe object at this place in the table.
	recipeObjectTable[productName][STORE_GRADES[grade]][productAmount] = RecipeController.Recipe.new( { buildingName }, grade, time, isService, productID, productAmount, ingredientsTable)		recipeObjectTable[productName][STORE_GRADES[grade]][productAmount] = RecipeController.Recipe.new( { buildingName }, grade, time, isService, productID, productAmount, ingredientsTable)
	else		else
	-- Add the building to the existing Recipe object at this place in the table.		--Add the building to the existing Recipe object at this place in the table.
	recipeObjectTable[productName][STORE_GRADES[grade]][productAmount]:addBuilding(buildingName)		recipeObjectTable[productName][STORE_GRADES[grade]][productAmount]:addBuilding(buildingName)
	end		end
Line 216:		Line 222:
	---@param requiredIngredient string the name of the ingredient, or nil if any		---@param requiredIngredient string the name of the ingredient, or nil if any
	---@return table a 3-factor compiled table of Recipe objects, [product][grade][amount]		---@return table a 3-factor compiled table of Recipe objects, [product][grade][amount]
	local function getRecipesFromAllDataModels(requiredProduct, requiredBuilding, requiredIngredient)		local function getRecipesFromAllDataModels(requiredProduct, requiredBuilding, requiredIngredient)

	--Resolve names to IDs, start them all as nil as wildcards.		--Resolve names to IDs, start them all as nil as wildcards.
Line 241:		Line 247:
	end		end

	~~recipeObjectArray~~ = {}		recipeObjectTable = {}
	for _, dataModel in ipairs(DataModelsWithRecipes) do		for _, dataModel in ipairs(DataModelsWithRecipes) do
	local newRecipeList = getRawRecipes(dataModel, productID, buildingID, ingredientID)		local newRecipeList = getRawRecipes(dataModel, productID, buildingID, ingredientID)
	~~recipeObjectArray~~ = compileRecipeLists(dataModel, ~~recipeObjectArray~~, newRecipeList)		recipeObjectTable = compileRecipeLists(dataModel, recipeObjectTable, newRecipeList)
	end		end

	return ~~recipeObjectArray~~		return recipeObjectTable
	end		end

76561197969631737: Undo revision 9913 by 76561197969631737 (talk)

2025-01-26T02:50:31Z

Undo revision 9913 by 76561197969631737 (talk)

← Older revision		Revision as of 02:50, 26 January 2025
Line 9:		Line 9:

	local DataModelsWithRecipes = {		local DataModelsWithRecipes = {
	~~require("Module:ExtractorsData"),~~
	require("Module:CampsData"),		require("Module:CampsData"),
	require("Module:FarmsData"),		require("Module:FarmsData"),

76561197969631737: adding extractors data for geyser pump

2025-01-26T02:48:07Z

adding extractors data for geyser pump

← Older revision		Revision as of 02:48, 26 January 2025
Line 9:		Line 9:

	local DataModelsWithRecipes = {		local DataModelsWithRecipes = {
			require("Module:ExtractorsData"),
	require("Module:CampsData"),		require("Module:CampsData"),
	require("Module:FarmsData"),		require("Module:FarmsData"),

76561197969631737: Swapping out old ServicesRecipesData model for new data model; now calls new service link view template

2024-11-09T20:29:56Z

Swapping out old ServicesRecipesData model for new data model; now calls new service link view template

← Older revision		Revision as of 20:29, 9 November 2024
Line 19:		Line 19:

	local GoodsData = require("Module:GoodsData")		local GoodsData = require("Module:GoodsData")
	~~local BaseDataModel = require("Module:BaseDataModel")~~		--For looking up services
	--~~TODO Replace with a method from a non~~-~~deprecated module~~		local InstitutionsData = require("Module:InstitutionsData")
	local ~~ServicesRecipesData~~ = require("Module:~~ServicesRecipesData~~")

	local VIEW_TEMPLATE_START = "Recipe/view"		local VIEW_TEMPLATE_START = "Recipe/view"
Line 29:		Line 28:
	local VIEW_BUILDING_LINK = "Building_link/view"		local VIEW_BUILDING_LINK = "Building_link/view"
	local VIEW_RESOURCE_LINK = "Resource_link/view"		local VIEW_RESOURCE_LINK = "Resource_link/view"
			--This doesn't use the view version because we don't want to hardcode the icon filename.
	local TEMPLATE_SERVICE_LINK = "Service_link"		local TEMPLATE_SERVICE_LINK = "Service_link"

Line 92:		Line 92:
	---Extracts a handful of values from the provided recipe pair.		---Extracts a handful of values from the provided recipe pair.
	---		---
	---@param DataModel BaseDataModel a ~~required~~ data model that implements the recipe query interface~~, passed in for code reuse~~		---@param DataModel BaseDataModel a data model that implements the recipe query interface
	---@param recipeData table pair of recipe data retrieved from a data model		---@param recipeData table pair of recipe data retrieved from a data model
	---@return string, number, number, string, number building ID, efficiency grade, production time, product ID, and product amount (respectively)		---@return string, number, number, string, number building ID, efficiency grade, production time, product ID, and product amount (respectively)
Line 109:		Line 109:
	---Extracts values from the provided recipe pair and builds an ingredients table for use in a Recipe object.		---Extracts values from the provided recipe pair and builds an ingredients table for use in a Recipe object.
	---		---
	---@param DataModel BaseDataModel a ~~required~~ data model that implements the recipe query interface~~, passed in for code reuse~~		---@param DataModel BaseDataModel a data model that implements the recipe query interface
	---@param recipeData table pair of recipe data retrieved from a data model		---@param recipeData table pair of recipe data retrieved from a data model
	---@return table nested ingredients, options (ID and amount)		---@return table nested ingredients, options (ID and amount)
Line 136:		Line 136:
	---Benchmarking: ~0.0003 seconds		---Benchmarking: ~0.0003 seconds
	---		---
	---@param DataModel ~~table~~ a ~~required~~ data model that implements the recipe query interface~~, passed in for code reuse~~		---@param DataModel BaseDataModel a data model that implements the recipe query interface
	---@param productID string the ID of the product, or nil if any		---@param productID string the ID of the product, or nil if any
	---@param buildingID string the ID of the building, or nil if any		---@param buildingID string the ID of the building, or nil if any
Line 167:		Line 167:
	---Adds the second list to the first, but restructures into Recipe objects along the way.		---Adds the second list to the first, but restructures into Recipe objects along the way.
	---		---
	~~---~~---@param DataModel ~~table~~ a ~~required~~ data model that implements the recipe query interface~~, passed in for code reuse~~		---@param DataModel BaseDataModel a data model that implements the recipe query interface
	---@param recipeObjectTable table 3-factor array of Recipe objects, by product, grade, amount		---@param recipeObjectTable table 3-factor array of Recipe objects, by product, grade, amount
	---@param rawRecipeTable table list of recipe pairs, as gotten from a data model		---@param rawRecipeTable table list of recipe pairs, as gotten from a data model
Line 226:		Line 226:
	productID = GoodsData.getGoodID(requiredProduct)		productID = GoodsData.getGoodID(requiredProduct)
	-- If it's not a good, then it might be a service, which has ID == name, so set it directly to the name if it's a valid service name		-- If it's not a good, then it might be a service, which has ID == name, so set it directly to the name if it's a valid service name
	if not productID and ~~ServicesRecipesData.isValidName(requiredProduct)~~ then		local list = InstitutionsData:getIDsAndRecipesWhereProductID(requiredProduct)
	~~--TODO: Replace this with a method from a non-deprecated module~~		if not productID and #list > 0 then
	productID = requiredProduct		productID = requiredProduct
	end		end
Line 401:		Line 401:
	if recipe[INDEX_RECIPE_IS_SERVICE] then		if recipe[INDEX_RECIPE_IS_SERVICE] then
	local serviceLinkArgs = {}		local serviceLinkArgs = {}
	~~--TODO update service link view and here~~		serviceLinkArgs["name"] = recipe[INDEX_RECIPE_PRODUCT_NAME]
	serviceLinkArgs["~~service~~"] = recipe[INDEX_RECIPE_PRODUCT_NAME]		serviceLinkArgs["size"] = VIEW_TABLE_PRODUCT_ICON_SIZE
	serviceLinkArgs[2] = VIEW_TABLE_PRODUCT_ICON_SIZE
	-- Redundant to label the resource if the author required it--the image alt-text and link still work with name.		-- Redundant to label the resource if the author required it--the image alt-text and link still work with name.
	if requiredProduct then		if requiredProduct then
Line 529:		Line 528:
	title = TEMPLATE_SERVICE_LINK,		title = TEMPLATE_SERVICE_LINK,
	args = {		args = {
	["~~service~~"] = recipe[INDEX_RECIPE_PRODUCT_NAME],		["name"] = recipe[INDEX_RECIPE_PRODUCT_NAME],
	["~~iconsize~~"] = "small",		["size"] = "small",
	}		}
	}		}
Line 702:		Line 701:
	return 0		return 0
	end		end

	return #self[INDEX_RECIPE_INGREDIENTS]		return #self[INDEX_RECIPE_INGREDIENTS]
	end		end

76561197969631737: Prepping for better module inheritance and robustness. no functional changes yet

2024-11-05T19:25:25Z

Prepping for better module inheritance and robustness. no functional changes yet

← Older revision		Revision as of 19:25, 5 November 2024
Line 182:		Line 182:
	-- Services identify their need by name, but goods to not. If it's a service, this is a simple renaming.		-- Services identify their need by name, but goods to not. If it's a service, this is a simple renaming.
	local productName = productID		local productName = productID
	local isService = ~~BaseDataModel.~~isRecipeProvidingService(pair)		local isService = DataModel:isRecipeProvidingService(pair)
	if not isService then		if not isService then
	productName = GoodsData.getName(productID)		productName = GoodsData.getName(productID)

76561197969631737: Prepping for better module inheritance and robustness. no functional changes yet

2024-11-05T19:21:24Z

Prepping for better module inheritance and robustness. no functional changes yet

← Older revision		Revision as of 19:21, 5 November 2024
Line 92:		Line 92:
	---Extracts a handful of values from the provided recipe pair.		---Extracts a handful of values from the provided recipe pair.
	---		---
			---@param DataModel BaseDataModel a required data model that implements the recipe query interface, passed in for code reuse
	---@param recipeData table pair of recipe data retrieved from a data model		---@param recipeData table pair of recipe data retrieved from a data model
	---@return string, number, number, string, number building ID, efficiency grade, production time, product ID, and product amount (respectively)		---@return string, number, number, string, number building ID, efficiency grade, production time, product ID, and product amount (respectively)
	local function getFlatRecipeValues(recipeData)		local function getFlatRecipeValues(DataModel, recipeData)
	local buildingID = ~~BaseDataModel.~~getRecipeBuildingID(recipeData)
	local grade = ~~BaseDataModel.~~getRecipeGrade(recipeData)		local buildingID = DataModel:getRecipeBuildingID(recipeData)
	local time = ~~BaseDataModel.~~getRecipeTime(recipeData)		local grade = DataModel:getRecipeGrade(recipeData)
	local productID = ~~BaseDataModel.~~getRecipeProductID(recipeData)		local time = DataModel:getRecipeTime(recipeData)
	local productAmount = ~~BaseDataModel.~~getRecipeProductAmount(recipeData)		local productID = DataModel:getRecipeProductID(recipeData)
			local productAmount = DataModel:getRecipeProductAmount(recipeData)

	return buildingID, grade, time, productID, productAmount		return buildingID, grade, time, productID, productAmount
Line 107:		Line 109:
	---Extracts values from the provided recipe pair and builds an ingredients table for use in a Recipe object.		---Extracts values from the provided recipe pair and builds an ingredients table for use in a Recipe object.
	---		---
			---@param DataModel BaseDataModel a required data model that implements the recipe query interface, passed in for code reuse
	---@param recipeData table pair of recipe data retrieved from a data model		---@param recipeData table pair of recipe data retrieved from a data model
	---@return table nested ingredients, options (ID and amount)		---@return table nested ingredients, options (ID and amount)
	local function buildingIngredientsTable(recipeData)		local function buildingIngredientsTable(DataModel, recipeData)

	local ingredientsTable = {}		local ingredientsTable = {}
	for i = 1, ~~BaseDataModel.~~getRecipeNumIngredientSlots(recipeData) do		for i = 1, DataModel:getRecipeNumIngredientSlots(recipeData) do

	if not ingredientsTable[i] then		if not ingredientsTable[i] then
	ingredientsTable[i] = {}		ingredientsTable[i] = {}
	end		end
	for j = 1, ~~BaseDataModel.~~getRecipeIngredientNumOptions(recipeData, i) do		for j = 1, DataModel:getRecipeIngredientNumOptions(recipeData, i) do
	ingredientsTable[i][j] = {		ingredientsTable[i][j] = {
	[INDEX_OPTION_ID] = ~~BaseDataModel.~~getRecipeIngredientOptionIDAt(recipeData, i, j),		[INDEX_OPTION_ID] = DataModel:getRecipeIngredientOptionIDAt(recipeData, i, j),
	[INDEX_OPTION_AMOUNT] = ~~BaseDataModel.~~getRecipeIngredientOptionAmountAt(recipeData, i, j),		[INDEX_OPTION_AMOUNT] = DataModel:getRecipeIngredientOptionAmountAt(recipeData, i, j),
	}		}
	end		end
Line 164:		Line 167:
	---Adds the second list to the first, but restructures into Recipe objects along the way.		---Adds the second list to the first, but restructures into Recipe objects along the way.
	---		---
			------@param DataModel table a required data model that implements the recipe query interface, passed in for code reuse
	---@param recipeObjectTable table 3-factor array of Recipe objects, by product, grade, amount		---@param recipeObjectTable table 3-factor array of Recipe objects, by product, grade, amount
	---@param rawRecipeTable table list of recipe pairs, as gotten from a data model		---@param rawRecipeTable table list of recipe pairs, as gotten from a data model
	---@return table the same recipeObjectTable, but with new and updated entries		---@return table the same recipeObjectTable, but with new and updated entries
	local function compileRecipeLists(recipeObjectTable, rawRecipeTable)		local function compileRecipeLists(DataModel, recipeObjectTable, rawRecipeTable)

	for _, pair in ipairs(rawRecipeTable) do		for _, pair in ipairs(rawRecipeTable) do

	local buildingID, grade, time, productID, productAmount = getFlatRecipeValues(pair)		local buildingID, grade, time, productID, productAmount = getFlatRecipeValues(DataModel, pair)
	local ingredientsTable = buildingIngredientsTable(pair)		local ingredientsTable = buildingIngredientsTable(DataModel, pair)

	local buildingName = BuildingDataProxy.getName(buildingID)		local buildingName = BuildingDataProxy.getName(buildingID)
Line 240:		Line 244:
	for _, dataModel in ipairs(DataModelsWithRecipes) do		for _, dataModel in ipairs(DataModelsWithRecipes) do
	local newRecipeList = getRawRecipes(dataModel, productID, buildingID, ingredientID)		local newRecipeList = getRawRecipes(dataModel, productID, buildingID, ingredientID)
	recipeObjectArray = compileRecipeLists(recipeObjectArray, newRecipeList)		recipeObjectArray = compileRecipeLists(dataModel, recipeObjectArray, newRecipeList)
	end		end

76561197969631737: Validating service names so that the table returns an error for invalid product and service names

2024-10-31T21:26:48Z

Validating service names so that the table returns an error for invalid product and service names

← Older revision		Revision as of 21:26, 31 October 2024
Line 20:		Line 20:
	local GoodsData = require("Module:GoodsData")		local GoodsData = require("Module:GoodsData")
	local BaseDataModel = require("Module:BaseDataModel")		local BaseDataModel = require("Module:BaseDataModel")
			--TODO Replace with a method from a non-deprecated module
			local ServicesRecipesData = require("Module:ServicesRecipesData")

	local VIEW_TEMPLATE_START = "Recipe/view"		local VIEW_TEMPLATE_START = "Recipe/view"
Line 72:		Line 74:

	local MARKUP_NEWLINE_FORCED = "\n<!-- -->\n"		local MARKUP_NEWLINE_FORCED = "\n<!-- -->\n"

			local ERROR_MESSAGE_EMPTY_PARAMETERS = "You must specify a product, building, or ingredient. Please see the template documentation for how to use the parameters"

	--endregion		--endregion
Line 151:		Line 155:
	rawRecipeList = DataModel:getIDsAndRecipesWhereBuildingID(buildingID)		rawRecipeList = DataModel:getIDsAndRecipesWhereBuildingID(buildingID)
	else		else
	error(~~"You must specify a product, building, or ingredient. Please see the template documentation for how to use the parameters"~~)		error(ERROR_MESSAGE_EMPTY_PARAMETERS)
	end		end

Line 217:		Line 221:
	if requiredProduct then		if requiredProduct then
	productID = GoodsData.getGoodID(requiredProduct)		productID = GoodsData.getGoodID(requiredProduct)
	-- If it's not a good, then it's a service, which has ID == name, so set it directly to the name		-- If it's not a good, then it might be a service, which has ID == name, so set it directly to the name if it's a valid service name
	if not productID then		if not productID and ServicesRecipesData.isValidName(requiredProduct) then
			--TODO: Replace this with a method from a non-deprecated module
	productID = requiredProduct		productID = requiredProduct
	end		end