Module:WorkshopsData - Revision history

76561197969631737: Now an instance override of BaseDataModel; functional change

2024-11-08T03:41:27Z

Now an instance override of BaseDataModel; functional change

@@ Line 1: / Line 1: @@
----@module WorkshopsData
+---@module WorkshopsData.lua
-local WorkshopsData = {}
+---
--- Initialize a new instance of the BaseDataModel, configured to load the workshops data
 local BaseDataModel = require("Module:BaseDataModel")
 local DATA_FILE = "Module:WorkshopsData/Workshops.json"
-local workshopsDataModel = BaseDataModel.new(DATA_FILE)
+--Begin instance overrides
 return workshopsDataModel

76561197969631737: Updating to new data model!

2024-10-30T01:31:18Z

Updating to new data model!

Show changes

76561197969631737: adding deprecated flags next to public methods that shouldn't be used anymore

2024-10-20T01:50:36Z

adding deprecated flags next to public methods that shouldn't be used anymore

← Older revision		Revision as of 01:50, 20 October 2024
Line 278:		Line 278:

	--- DEPRECATED --- DO NOT USE ---		--- DEPRECATED --- DO NOT USE ---
			---@deprecated
	function WorkshopsData.getAllWorkshopRecipes(displayName)		function WorkshopsData.getAllWorkshopRecipes(displayName)

Line 302:		Line 303:

	--- DEPRECATED --- DO NOT USE ---		--- DEPRECATED --- DO NOT USE ---
			---@deprecated
	function WorkshopsData.getWorkshopIcon(displayName)		function WorkshopsData.getWorkshopIcon(displayName)

Line 323:		Line 325:

	--- DEPRECATED --- DO NOT USE ---		--- DEPRECATED --- DO NOT USE ---
			---@deprecated
	function WorkshopsData.getWorkshopNamesWithRecipeID(recipeID)		function WorkshopsData.getWorkshopNamesWithRecipeID(recipeID)

76561197969631737: Refactoring, removing unused methods that did not conform to building interface

2024-10-20T01:17:46Z

Refactoring, removing unused methods that did not conform to building interface

Show changes

76561197969631737: Adding getID to building interface; removing outdated comment at top

2024-10-14T20:20:49Z

Adding getID to building interface; removing outdated comment at top

@@ Line 1: / Line 1: @@
 --- @module WorkshopsData
 local WorkshopsData = {}
@@ Line 104: / Line 5: @@
 --region Dependencies
 local CsvUtils = require("Module:CsvUtils")
@@ Line 134: / Line 37: @@
 --region Private constants
 local INDEX_ID = "id"
@@ Line 967: / Line 868: @@
 --region Public Building interface
 -- getCategory
 -- getCityScore
@@ Line 978: / Line 880: @@
 -- getSize (as "X x Y")
 -- getStorage
 function WorkshopsData.getCategory(id)

76561197969631737: fixed typo on getnumberofworkplaces

2024-10-09T01:44:46Z

fixed typo on getnumberofworkplaces

← Older revision		Revision as of 01:44, 9 October 2024
Line 1,035:		Line 1,035:
	function WorkshopsData.getNumberOfWorkplaces(id)		function WorkshopsData.getNumberOfWorkplaces(id)
	load()		load()
	return workshopsTable[id] ~= nil and workshopsTable[id][INDEX_WORKPLACES]		return workshopsTable[id] ~= nil and #workshopsTable[id][INDEX_WORKPLACES]
	end		end

76561197969631737: Updated building interface with a couple more methods

2024-10-09T01:40:10Z

Updated building interface with a couple more methods

← Older revision		Revision as of 01:40, 9 October 2024
Line 962:		Line 962:
	end		end

			--endregion


	-- Building interface
	~~-- getName~~		--region Public Building interface
	-- getCategory		-- getCategory
			-- getCityScore
			-- getConstructionCosts (as [goodName] = stack size)
			-- getConstructionTime
	-- getDescription		-- getDescription
	-- getIcon		-- getIcon
			-- isMovable
			-- getName
	-- getNumberOfWorkplaces		-- getNumberOfWorkplaces
	~~-- getCityScore~~
	~~-- getConstructionTime~~
	-- getSize (as "X x Y")		-- getSize (as "X x Y")
	-- ~~getConstructionCosts~~ (as [~~goodName~~] = ~~stack size~~)		-- getStorage

			function WorkshopsData.getCategory(id)
			load()
			return workshopsTable[id] ~= nil and workshopsTable[id][INDEX_CATEGORY]
			end

			function WorkshopsData.getCityScore(id)
			load()
			return workshopsTable[id] ~= nil and workshopsTable[id][INDEX_CITY_SCORE]
			end

			function WorkshopsData.getConstructionCosts(id)

	~~function WorkshopsData.getName(id)~~
	load()		load()
	~~return~~ workshopsTable[id] ~= ~~nil and workshopsTable~~[id][~~INDEX_NAME~~]		GoodsData = require("Module:GoodsData")

			workshop = workshopsTable[id]
			if not workshop then
			return nil
			end

			local constructionCosts = {}
			for _, stacks in ipairs(workshop[INDEX_REQUIRED_GOODS]) do
			local goodName = GoodsData.getGoodNameByID(stacks[INDEX_CONSTRUCTION_GOODS_GOOD_ID])
			constructionCosts[goodName] = stacks[INDEX_CONSTRUCTION_GOODS_STACK_SIZE]
			end

			return constructionCosts
	end		end

	function WorkshopsData.~~getCategory~~(id)		function WorkshopsData.getConstructionTime(id)
	load()		load()
	return workshopsTable[id] ~= nil and workshopsTable[id][~~INDEX_CATEGORY~~]		return workshopsTable[id] ~= nil and workshopsTable[id][INDEX_CONSTRUCTION_TIME]
	end		end

Line 995:		Line 1,023:
	end		end

	function WorkshopsData.~~getNumberOfWorkplaces~~(id)		function WorkshopsData.isMovable(id)
	load()		load()
	return workshopsTable[id] ~= nil and #workshopsTable[id][~~INDEX_WORKPLACES~~]		return workshopsTable[id] ~= nil and workshopsTable[id][INDEX_MOVABLE]
	end		end

	function WorkshopsData.~~getCityScore~~(id)		function WorkshopsData.getName(id)
	load()		load()
	return workshopsTable[id] ~= nil and workshopsTable[id][~~INDEX_CITY_SCORE~~]		return workshopsTable[id] ~= nil and workshopsTable[id][INDEX_NAME]
	end		end

	function WorkshopsData.~~getConstructionTime~~(id)		function WorkshopsData.getNumberOfWorkplaces(id)
	load()		load()
	return workshopsTable[id] ~= nil and workshopsTable[id][~~INDEX_CONSTRUCTION_TIME~~]		return workshopsTable[id] ~= nil and workshopsTable[id][INDEX_WORKPLACES]
	end		end

Line 1,015:		Line 1,043:
	workshop = workshopsTable[id]		workshop = workshopsTable[id]
	if not workshop then		if not workshop then
	return ~~false~~		return nil
	end		end

Line 1,021:		Line 1,049:
	end		end

	function WorkshopsData.~~getConstructionCosts~~(id)		function WorkshopsData.getStorage(id)

	load()		load()
	~~GoodsData = require("Module:GoodsData")~~		return workshopsTable[id] ~= nil and workshopsTable[id][INDEX_STORAGE_CAP]

	~~workshop =~~ workshopsTable[id]
	~~if not workshop then~~
	~~return false~~
	~~end~~

	~~local constructionCosts~~ = {}
	~~for _, stacks in ipairs(workshop~~[~~INDEX_REQUIRED_GOODS~~]~~) do~~
	~~local goodName = GoodsData.getGoodNameByID(stacks~~[~~INDEX_CONSTRUCTION_GOODS_GOOD_ID~~])
	~~constructionCosts[goodName] = stacks[INDEX_CONSTRUCTION_GOODS_STACK_SIZE]~~
	~~end~~

	~~return constructionCosts~~
	end		end



	--endregion		--endregion

	return WorkshopsData		return WorkshopsData

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

2024-10-08T22:16:16Z

Updated with common method names (like a building interface)

@@ Line 102: / Line 102: @@
 local CsvUtils = require("Module:CsvUtils")
@@ Line 362: / Line 369: @@
 	-- Now restructure to be more conducive.
 	workshopsTable = restructureWorkshopsTable(originalWorkshopsTable, workshopsHeaderLookup)
 end
@@ Line 935: / Line 951: @@
 		loadData()
 	end
 	local idsTable = {}
 	local i = 1
@@ Line 942: / Line 958: @@
 		i = i + 1
 	end
 	return idsTable
 end

76561197969631737: added function to get all IDs

2024-10-07T01:36:44Z

added function to get all IDs

@@ Line 928: / Line 928: @@
 	return #workshopsNames
 end
 --endregion
 return WorkshopsData

76561197969631737: need to load the data first

2023-11-28T04:29:25Z

need to load the data first

← Older revision		Revision as of 04:29, 28 November 2023
Line 904:		Line 904:
	if not index then		if not index then
	return nil		return nil
			end

			if not workshopsTable then
			loadData()
	end		end

Line 917:		Line 921:
	---@return number of records		---@return number of records
	function WorkshopsData.getNumberOfWorkshopsInDatabase()		function WorkshopsData.getNumberOfWorkshopsInDatabase()

			if not workshopsTable then
			loadData()
			end

	return #workshopsNames		return #workshopsNames