Module:FarmsData - Revision history

76561197969631737: Now an instance override of BaseDataModel; functional change

2024-11-07T14:18:48Z

Now an instance override of BaseDataModel; functional change

@@ Line 1: / Line 1: @@
----@module FarmsData
+---@module FarmsData.lua
-local FarmsData = {}
+---
 local BaseDataModel = require("Module:BaseDataModel")
 local DATA_FILE = "Module:FarmsData/Farms.json"
 return farmsDataModel

76561197969631737: Updating to new data model!

2024-10-30T01:31:11Z

Updating to new data model!

Show changes

76561197969631737: added function to get all IDs; removed outdated comment at top

2024-10-14T20:26:19Z

added function to get all IDs; removed outdated comment at top

@@ Line 1: / Line 1: @@
 --- @module FarmsData
 local FarmsData = {}
@@ Line 112: / Line 5: @@
 --region Dependencies
 local CsvUtils = require("Module:CsvUtils")
@@ Line 141: / Line 36: @@
 --region Private constants
 local INDEX_ID = "id"
@@ Line 1,035: / Line 928: @@
 --region Public Building interface
 -- getCategory
 -- getCityScore
@@ Line 1,046: / Line 940: @@
 -- getSize (as "X x Y")
 -- getStorage
 function FarmsData.getCategory(id)

76561198045847734: Homestead has 4 recipes

2024-10-09T09:31:27Z

Homestead has 4 recipes

← Older revision		Revision as of 09:31, 9 October 2024
Line 258:		Line 258:

	-- A constant we'll need only within this function.		-- A constant we'll need only within this function.
	local MAX_RECIPES = 3		local MAX_RECIPES = 4
	local LOOKUP_RECIPE_BASE_STRING = "recipe"		local LOOKUP_RECIPE_BASE_STRING = "recipe"
	local LOOKUP_GOOD_BASE_STRING = "Good"		local LOOKUP_GOOD_BASE_STRING = "Good"

76561197969631737: Updated with common method names (like a building interface)

2024-10-09T01:54:48Z

Updated with common method names (like a building interface)

@@ Line 110: / Line 110: @@
 local CsvUtils = require("Module:CsvUtils")
@@ Line 378: / Line 385: @@
 	-- Now restructure to be more conducive.
 	farmsTable = restructureFarmsTable(originalFarmsTable, farmsHeaderLookup)
 end
@@ Line 1,014: / Line 1,030: @@
 end
---endregion
+function FarmsData.getName(id)
 return FarmsData

76561197969631737: Added two new methods to support getting names from the database

2023-11-28T04:39:33Z

Added two new methods to support getting names from the database

@@ Line 119: / Line 119: @@
 --- Main data tables, like this: table[ID] = table containing data for that ID
 local farmsTable
 --- Lookup map. Built once and reused on subsequent calls within this session,
@@ Line 326: / Line 329: @@
 	mapNamesToIDs = {}
 	local newFarmsTable = {}
@@ Line 350: / Line 354: @@
 		newFarmsTable[ newFarm[INDEX_ID] ] = newFarm
 		-- Also populate the map for looking up IDs with display names
@@ Line 385: / Line 391: @@
 --- @param displayName string plain-language name of the farm to find
 --- @return string ID of the farm found, or nil if not found
-local function findfarmIDByName(displayName)
+local function findFarmIDByName(displayName)
 	-- At runtime, this should never be nil or empty, so throw an error.
@@ Line 448: / Line 454: @@
 	end
-	local farmID = findfarmIDByName(displayName)
+	local farmID = findFarmIDByName(displayName)
 	if not farmID then
 		return nil
@@ Line 971: / Line 977: @@
 	return mapRecipeGoodIDsToFarmNames[productID]
 end
 --endregion
 return FarmsData

76561197969631737: Fixed a return value

2023-11-26T21:15:09Z

Fixed a return value

← Older revision		Revision as of 21:15, 26 November 2023
Line 807:		Line 807:

	if not farm then		if not farm then
	return ~~nil~~		return 0
	end		end

76561197969631737: Created a method to return the number of recipes at the farm

2023-11-26T05:13:56Z

Created a method to return the number of recipes at the farm

← Older revision		Revision as of 05:13, 26 November 2023
Line 790:		Line 790:

	return farm[INDEX_RECIPES]		return farm[INDEX_RECIPES]
			end



			---
			--- Retrieves the number of recipes for the farm specified by its
			--- plain language display name, in a table that looks like this:
			---
			--- Returns nil if the farm named was not found.
			---
			---@param displayName string the plain language name of the farm
			---@return number of recipe at the farm
			function FarmsData.getFarmNumberOfRecipes(displayName)

			local farm = FarmsData.getAllDataForFarm(displayName)

			if not farm then
			return nil
			end

			recipes = farm[INDEX_RECIPES]
			if not recipes then
			return 0
			end

			return #recipes
	end		end

76561197969631737: Now stores the right fields as actual numbers instead of strings of numbers

2023-11-26T04:14:31Z

Now stores the right fields as actual numbers instead of strings of numbers

← Older revision		Revision as of 04:14, 26 November 2023
Line 191:		Line 191:
	-- don't add subtables that would just contain nils		-- don't add subtables that would just contain nils
	local requiredGoods = {		local requiredGoods = {
	number1 and id1 and { [INDEX_CONSTRUCTION_GOODS_STACK_SIZE] = number1, [INDEX_CONSTRUCTION_GOODS_GOOD_ID] = id1 } or nil,		number1 and id1 and { [INDEX_CONSTRUCTION_GOODS_STACK_SIZE] = tonumber(number1), [INDEX_CONSTRUCTION_GOODS_GOOD_ID] = id1 } or nil,
	number2 and id2 and { [INDEX_CONSTRUCTION_GOODS_STACK_SIZE] = number2, [INDEX_CONSTRUCTION_GOODS_GOOD_ID] = id2 } or nil,		number2 and id2 and { [INDEX_CONSTRUCTION_GOODS_STACK_SIZE] = tonumber(number2), [INDEX_CONSTRUCTION_GOODS_GOOD_ID] = id2 } or nil,
	number3 and id3 and { [INDEX_CONSTRUCTION_GOODS_STACK_SIZE] = number3, [INDEX_CONSTRUCTION_GOODS_GOOD_ID] = id3 } or nil		number3 and id3 and { [INDEX_CONSTRUCTION_GOODS_STACK_SIZE] = tonumber(number3), [INDEX_CONSTRUCTION_GOODS_GOOD_ID] = id3 } or nil
	}		}

Line 279:		Line 279:
	if originalGoodID and originalGoodID ~= "" then		if originalGoodID and originalGoodID ~= "" then
	newRecipe[INDEX_RECIPE_GOOD_ID] = originalGoodID		newRecipe[INDEX_RECIPE_GOOD_ID] = originalGoodID
	newRecipe[INDEX_RECIPE_STACK_SIZE] = originalStackSize		newRecipe[INDEX_RECIPE_STACK_SIZE] = tonumber(originalStackSize)
	newRecipe[INDEX_RECIPE_GRADE] = originalFarm[originalGradeIndex]:match(PATTERN_CAPTURE_END_NUMBER)		newRecipe[INDEX_RECIPE_GRADE] = tonumber(originalFarm[originalGradeIndex]:match(PATTERN_CAPTURE_END_NUMBER))
	newRecipe[INDEX_RECIPE_PLANTING_TIME] = originalFarm[originalPlantingTimeIndex]		newRecipe[INDEX_RECIPE_PLANTING_TIME] = tonumber(originalFarm[originalPlantingTimeIndex])
	newRecipe[INDEX_RECIPE_HARVESTING_TIME] = originalFarm[originalHarvestingTimeIndex]		newRecipe[INDEX_RECIPE_HARVESTING_TIME] = tonumber(originalFarm[originalHarvestingTimeIndex])

	table.insert(recipes,newRecipe)		table.insert(recipes,newRecipe)
Line 336:		Line 336:
	newFarm[INDEX_DESCRIPTION] = originalFarm[INDEX_ORIGINAL_DESCRIPTION]		newFarm[INDEX_DESCRIPTION] = originalFarm[INDEX_ORIGINAL_DESCRIPTION]
	newFarm[INDEX_CATEGORY] = originalFarm[INDEX_ORIGINAL_CATEGORY]		newFarm[INDEX_CATEGORY] = originalFarm[INDEX_ORIGINAL_CATEGORY]
	newFarm[INDEX_SIZE_X] = originalFarm[INDEX_ORIGINAL_SIZE_X]		newFarm[INDEX_SIZE_X] = tonumber(originalFarm[INDEX_ORIGINAL_SIZE_X])
	newFarm[INDEX_SIZE_Y] = originalFarm[INDEX_ORIGINAL_SIZE_Y]		newFarm[INDEX_SIZE_Y] = tonumber(originalFarm[INDEX_ORIGINAL_SIZE_Y])
	newFarm[INDEX_CITY_SCORE] = originalFarm[INDEX_ORIGINAL_CITY_SCORE]		newFarm[INDEX_CITY_SCORE] = tonumber(originalFarm[INDEX_ORIGINAL_CITY_SCORE])
	newFarm[INDEX_MOVABLE] = originalFarm[INDEX_ORIGINAL_MOVABLE] == "True"		newFarm[INDEX_MOVABLE] = originalFarm[INDEX_ORIGINAL_MOVABLE] == "True"
	newFarm[INDEX_INITIALLY_ESSENTIAL] = originalFarm[INDEX_ORIGINAL_ESSENTIAL] == "True"		newFarm[INDEX_INITIALLY_ESSENTIAL] = originalFarm[INDEX_ORIGINAL_ESSENTIAL] == "True"
	newFarm[INDEX_AREA] = originalFarm[INDEX_ORIGINAL_AREA]		newFarm[INDEX_AREA] = tonumber(originalFarm[INDEX_ORIGINAL_AREA])
	newFarm[INDEX_STORAGE] = originalFarm[INDEX_ORIGINAL_STORAGE]		newFarm[INDEX_STORAGE] = tonumber(originalFarm[INDEX_ORIGINAL_STORAGE])
	newFarm[INDEX_CONSTRUCTION_TIME] = originalFarm[INDEX_ORIGINAL_CONSTRUCTION_TIME]		newFarm[INDEX_CONSTRUCTION_TIME] = tonumber(originalFarm[INDEX_ORIGINAL_CONSTRUCTION_TIME])

	newFarm[INDEX_REQUIRED_GOODS] = makeRequiredGoodsSubtable(originalFarm, farmsHeaderLookup)		newFarm[INDEX_REQUIRED_GOODS] = makeRequiredGoodsSubtable(originalFarm, farmsHeaderLookup)

76561197969631737: a few typos in comments

2023-11-21T19:45:57Z

a few typos in comments

← Older revision		Revision as of 19:45, 21 November 2023
Line 378:		Line 378:
	---		---
	--- Uses the display name, which people are more familiar with, to find the		--- Uses the display name, which people are more familiar with, to find the
	--- encoded ID of the ~~institution~~. Useful for retrieving the data that is		--- encoded ID of the farm. Useful for retrieving the data that is
	--- indexed by ID.		--- indexed by ID.
	---		---
Line 853:		Line 853:

	---		---
	--- Retrieves the icon filename for the ~~institution~~ specified by its plain		--- Retrieves the icon filename for the farm specified by its plain
	--- language display name.		--- language display name.
	---		---
	--- Returns nil if the ~~institution~~ named was not found.		--- Returns nil if the farm named was not found.
	---		---
	---@param displayName string the plain language name of the ~~institution~~		---@param displayName string the plain language name of the farm
	---@return string the farm's icon filename, including the extension		---@return string the farm's icon filename, including the extension
	function FarmsData.getFarmIcon(displayName)		function FarmsData.getFarmIcon(displayName)