Module:BuildingDataProxy - Revision history

76561198157077871 at 02:36, 5 August 2025

2025-08-05T02:36:04Z

← Older revision		Revision as of 02:36, 5 August 2025
Line 36:		Line 36:
	local function cacheModel(modelName)		local function cacheModel(modelName)

	--if DataModelsCache[modelName] == nil then		if DataModelsCache[modelName] == nil then
	DataModelsCache[modelName] = require(modelName)		DataModelsCache[modelName] = require(modelName)
	--end		end

	return DataModelsCache[modelName]		return DataModelsCache[modelName]

76561198157077871 at 02:31, 5 August 2025

2025-08-05T02:31:03Z

← Older revision		Revision as of 02:31, 5 August 2025
Line 36:		Line 36:
	local function cacheModel(modelName)		local function cacheModel(modelName)

	if DataModelsCache[modelName] == nil then		--if DataModelsCache[modelName] == nil then
	DataModelsCache[modelName] = require(modelName)		DataModelsCache[modelName] = require(modelName)
	end		--end

	return DataModelsCache[modelName]		return DataModelsCache[modelName]

76561198157077871 at 21:36, 27 February 2025

2025-02-27T21:36:50Z

← Older revision		Revision as of 21:36, 27 February 2025
Line 20:		Line 20:
	"Module:ExtractorsData",		"Module:ExtractorsData",
	"Module:MinesData",		"Module:MinesData",
			"Module:BlightPostsData"
	}		}

76561197969631737: added MinesData

2025-01-30T22:42:49Z

added MinesData

← Older revision		Revision as of 22:42, 30 January 2025
Line 19:		Line 19:
	"Module:FarmFieldsData",		"Module:FarmFieldsData",
	"Module:ExtractorsData",		"Module:ExtractorsData",
			"Module:MinesData",
	}		}

76561197969631737: updating with extractors (geyser pump)

2025-01-26T02:58:55Z

updating with extractors (geyser pump)

← Older revision		Revision as of 02:58, 26 January 2025
Line 18:		Line 18:
	"Module:WarehousesData",		"Module:WarehousesData",
	"Module:FarmFieldsData",		"Module:FarmFieldsData",
			"Module:ExtractorsData",
	}		}

Line 125:		Line 126:

	--endregion		--endregion



	return BuildingDataProxy		return BuildingDataProxy

76561197969631737: Undo revision 9914 by 76561197969631737 (talk)

2025-01-26T02:50:07Z

Undo revision 9914 by 76561197969631737 (talk)

← Older revision		Revision as of 02:50, 26 January 2025
Line 18:		Line 18:
	"Module:WarehousesData",		"Module:WarehousesData",
	"Module:FarmFieldsData",		"Module:FarmFieldsData",
	~~"Module:ExtractorsData",~~
	}		}

Line 126:		Line 125:

	--endregion		--endregion



	return BuildingDataProxy		return BuildingDataProxy

76561197969631737: adding farm fields and extractors (geyser pump)

2025-01-26T02:49:52Z

adding farm fields and extractors (geyser pump)

← Older revision		Revision as of 02:49, 26 January 2025
Line 18:		Line 18:
	"Module:WarehousesData",		"Module:WarehousesData",
	"Module:FarmFieldsData",		"Module:FarmFieldsData",
			"Module:ExtractorsData",
	}		}

Line 125:		Line 126:

	--endregion		--endregion



	return BuildingDataProxy		return BuildingDataProxy

76561197969631737: Updating to new secondary categories; removing unused functional types

2024-11-10T18:57:25Z

Updating to new secondary categories; removing unused functional types

@@ Line 24: / Line 24: @@
      DataModelsCache[moduleName] = nil
 end
 --endregion
@@ Line 69: / Line 44: @@
 ---
 ---@param functionName string the name of the function to call
----@param parameter string name or ID
+---@param parameter1 ?
 ---@return ? whatever the function returns
-local function federateFunction(functionName, parameter)
+local function federateFunction(functionName, parameter1, parameter2, parameter3)
      for _, modelName in ipairs(DATA_MODELS_NAMES_ARRAY) do
          local DataModel = cacheModel(modelName)
-         local result = DataModel[functionName](DataModel, parameter)
+         local result = DataModel[functionName](DataModel, parameter1, parameter2, parameter3)
          -- If we found it, return, otherwise keep going
          if result then
@@ Line 90: / Line 67: @@
 --region Public building interface
 function BuildingDataProxy.getID(displayName)
@@ Line 110: / Line 74: @@
 function BuildingDataProxy.getCategory(id)
      return federateFunction("getCategory", id)
 end
@@ Line 150: / Line 118: @@
 function BuildingDataProxy.getStorage(id)
      return federateFunction("getStorage", id)
 end
@@ Line 155: / Line 127: @@
 return BuildingDataProxy

76561197969631737: Updating to new data model!

2024-10-30T01:31:26Z

Updating to new data model!

← Older revision		Revision as of 01:31, 30 October 2024
Line 8:		Line 8:
	-- Just store the strings, and we'll load lazily at runtime as needed. The order of this array controls the load order of data models.		-- Just store the strings, and we'll load lazily at runtime as needed. The order of this array controls the load order of data models.
	local DATA_MODELS_NAMES_ARRAY = {		local DATA_MODELS_NAMES_ARRAY = {
	"Module:~~WorkshopsData2~~",		"Module:WorkshopsData",
	"Module:~~InstitutionsData2~~",		"Module:InstitutionsData",
	"Module:~~FarmsData2~~",		"Module:FarmsData",
	"Module:GatheringData",		"Module:GatheringData",
	"Module:FishingData",		"Module:FishingData",
	"Module:RainCollectorsData",		"Module:RainCollectorsData",
	"Module:~~CampsData2~~",		"Module:CampsData",
	"Module:HearthsData",		"Module:HearthsData",
	"Module:WarehousesData",		"Module:WarehousesData",
Line 32:		Line 32:

	local LOOKUP_DATA_MODEL_FUNCTIONAL_TYPES = {		local LOOKUP_DATA_MODEL_FUNCTIONAL_TYPES = {
	["Module:~~CampsData2~~"] = "Gathering Camp",		["Module:CampsData"] = "Gathering Camp",
	["Module:FarmFieldsData"] = "Farm",		["Module:FarmFieldsData"] = "Farm",
	["Module:~~FarmsData2~~"] = "Farm",		["Module:FarmsData"] = "Farm",
	["Module:FishingData"] = "Fishing Hut",		["Module:FishingData"] = "Fishing Hut",
	["Module:GatheringData"] = "Gathering Camp",		["Module:GatheringData"] = "Gathering Camp",
	["Module:HearthsData"] = "Hearth",		["Module:HearthsData"] = "Hearth",
	["Module:~~InstitutionsData2~~"] = "Service Building",		["Module:InstitutionsData"] = "Service Building",
	["Module:RainCollectorsData"] = "Extraction Building",		["Module:RainCollectorsData"] = "Extraction Building",
	["Module:WarehousesData"] = "Storage Building",		["Module:WarehousesData"] = "Storage Building",
	["Module:~~WorkshopsData2~~"] = "Production Building",		["Module:WorkshopsData"] = "Production Building",
	}		}

76561197969631737: Creating to lazily load and federate queries out to building data models

2024-10-29T03:17:14Z

Creating to lazily load and federate queries out to building data models

New page

---@module BuildingDataProxy
local BuildingDataProxy = {}

--region Dependencies

-- Just store the strings, and we'll load lazily at runtime as needed. The order of this array controls the load order of data models.
local DATA_MODELS_NAMES_ARRAY = {
"Module:WorkshopsData2",
"Module:InstitutionsData2",
"Module:FarmsData2",
"Module:GatheringData",
"Module:FishingData",
"Module:RainCollectorsData",
"Module:CampsData2",
"Module:HearthsData",
"Module:WarehousesData",
"Module:FarmFieldsData",
}

local DataModelsCache = {}
for _, moduleName in pairs(DATA_MODELS_NAMES_ARRAY) do
DataModelsCache[moduleName] = nil
end

--endregion

--region Private constants

local LOOKUP_DATA_MODEL_FUNCTIONAL_TYPES = {
["Module:CampsData2"] = "Gathering Camp",
["Module:FarmFieldsData"] = "Farm",
["Module:FarmsData2"] = "Farm",
["Module:FishingData"] = "Fishing Hut",
["Module:GatheringData"] = "Gathering Camp",
["Module:HearthsData"] = "Hearth",
["Module:InstitutionsData2"] = "Service Building",
["Module:RainCollectorsData"] = "Extraction Building",
["Module:WarehousesData"] = "Storage Building",
["Module:WorkshopsData2"] = "Production Building",
}

--endregion

--region Private member variables

--endregion

--region Private methods

local function cacheModel(modelName)

if DataModelsCache[modelName] == nil then
DataModelsCache[modelName] = require(modelName)
end

return DataModelsCache[modelName]
end

---fetchFromFunction
---Loops through the data models, calling the provided function on each in turn using the specified parameter (name or ID) until one of them returns a result. Returns nil if no data models found the specified name or ID.
---
---@param functionName string the name of the function to call
---@param parameter string name or ID
---@return ? whatever the function returns
local function federateFunction(functionName, parameter)

for _, modelName in ipairs(DATA_MODELS_NAMES_ARRAY) do
local DataModel = cacheModel(modelName)
local result = DataModel[functionName](DataModel, parameter)
-- If we found it, return, otherwise keep going
if result then
return result
end
end
-- nil if not found
return nil
end

--endregion

--region Public building interface

-- getID(displayName)
-- getCategory(id)
-- getCityScore(id)
-- getConstructionCosts(id) -- returns { [goodName] = stack size }
-- getConstructionTime(id)
-- getDescription(id)
-- getIcon(id)
-- isMovable(id)
-- getName(id)
-- getNumberOfWorkplaces(id)
-- getSize(id) -- returns string "X x Y"
-- getStorage(id)

function BuildingDataProxy.getID(displayName)
return federateFunction("getID", displayName)
end

function BuildingDataProxy.getCategory(id)
return federateFunction("getCategory", id)
end

function BuildingDataProxy.getCityScore(id)
return federateFunction("getCityScore", id)
end

function BuildingDataProxy.getConstructionCosts(id)
return federateFunction("getConstructionCosts", id)
end

function BuildingDataProxy.getConstructionTime(id)
return federateFunction("getConstructionTime", id)
end

function BuildingDataProxy.getDescription(id)
return federateFunction("getDescription", id)
end

function BuildingDataProxy.getIcon(id)
return federateFunction("getIcon", id)
end

function BuildingDataProxy.isMovable(id)
return federateFunction("isMovable", id)
end

function BuildingDataProxy.getName(id)
return federateFunction("getName", id)
end

function BuildingDataProxy.getNumberOfWorkplaces(id)
return federateFunction("getNumberOfWorkplaces", id)
end

function BuildingDataProxy.getSize(id)
return federateFunction("getSize", id)
end

function BuildingDataProxy.getStorage(id)
return federateFunction("getStorage", id)
end

--endregion

--region Public methods

---getFunctionalType
---Looks up a descriptive "functional type" for the specified building, based on the data model in which it was found. Used to augment the category with more information. Returns nil if the building is not found.
---
---@param id string the ID of the building
---@return string describing the functional type of the building
function BuildingDataProxy.getFunctionalType(id)

for _, modelName in ipairs(DATA_MODELS_NAMES_ARRAY) do
local DataModel = cacheModel(modelName)
local validName = DataModel:getName(id)
if validName then
return LOOKUP_DATA_MODEL_FUNCTIONAL_TYPES[modelName]
end
end

return nil
end

--endregion

return BuildingDataProxy