Module:Building - Revision history

76561197969631737: small refactoring for readability

2025-11-12T02:10:58Z

small refactoring for readability

← Older revision		Revision as of 02:10, 12 November 2025
Line 220:		Line 220:
	end		end
	return nowrap(wikitext)		return nowrap(wikitext)
			end

			-- Increments recipe counters in compileRecipeBook
			---@param recipe Recipe
			---@param recipeCount integer
			---@param maxIngredients integer
			---@param numBuildings integer
			---@return integer recipeCount + 1
			---@return integer maxIngredients across all recipes so far
			---@return integer numBuildings + 1
			local function addToRecipeCounts(recipe, recipeCount, maxIngredients, numBuildings)
			recipeCount = recipeCount + 1
			maxIngredients = math.max(maxIngredients, Recipe.getNumIngredients(recipe))
			numBuildings = numBuildings + 1
			return recipeCount, maxIngredients, numBuildings
	end		end

Line 284:		Line 299:
	local numBuildings = 0		local numBuildings = 0
	for buildingID, building in pairs(buildingData) do		for buildingID, building in pairs(buildingData) do
	-- if no filter on buildings OR match		-- if no filter on buildings OR match, proceed to productID
	if not requiredBuildingID or buildingID == requiredBuildingID then		if not requiredBuildingID or buildingID == requiredBuildingID then
	for productID, recipeListByGrade in pairs(building._recipes) do		for productID, recipeListByGrade in pairs(building._recipes) do
	-- if no filter on product OR match		-- if no filter on product OR match, proceed to grade, stacksize, and ingredients
	if not requiredProductID or productID == requiredProductID then		if not requiredProductID or productID == requiredProductID then
	for grade, recipesByStacksize in pairs(recipeListByGrade) do		for grade, recipesByStacksize in pairs(recipeListByGrade) do
	for stacksize, recipe in pairs(recipesByStacksize) do		for stacksize, recipe in pairs(recipesByStacksize) do
	-- if no filter on ingredient OR match		-- if no filter on ingredient OR match, proceed to recipes
	if not requiredIngredientID or Recipe.isIngredientInOptions(recipe, requiredIngredientID) then		if not requiredIngredientID or Recipe.isIngredientInOptions(recipe, requiredIngredientID) then
			-- add to book if it's the first for this product
	if recipeBook[productID] == nil then		if recipeBook[productID] == nil then
	recipeBook[productID] = { [grade] = { [stacksize] = copy(recipe) } }		recipeBook[productID] = { [grade] = { [stacksize] = copy(recipe) } }
	recipeCount ~~= recipeCount + 1~~		recipeCount, maxIngredients, numBuildings = addToRecipeCounts(recipe, recipeCount, maxIngredients, numBuildings)
	maxIngredients = ~~math.max~~(maxIngredients, ~~Recipe.getNumIngredients(recipe)~~)
	~~numBuildings = numBuildings + 1~~
	else		else
			-- add to grade if the product's already there
	if recipeBook[productID][grade] == nil then		if recipeBook[productID][grade] == nil then
	recipeBook[productID][grade] = { [stacksize] = copy(recipe) }		recipeBook[productID][grade] = { [stacksize] = copy(recipe) }
	recipeCount ~~= recipeCount + 1~~		recipeCount, maxIngredients, numBuildings = addToRecipeCounts(recipe, recipeCount, maxIngredients, numBuildings)
	maxIngredients = ~~math.max~~(maxIngredients, ~~Recipe.getNumIngredients(recipe)~~)
	~~numBuildings = numBuildings + 1~~
	else		else
			-- add to stacksize if the product and grade are already there too
	if recipeBook[productID][grade][stacksize] == nil then		if recipeBook[productID][grade][stacksize] == nil then
	recipeBook[productID][grade][stacksize] = copy(recipe)		recipeBook[productID][grade][stacksize] = copy(recipe)
	recipeCount ~~= recipeCount + 1~~		recipeCount, maxIngredients, numBuildings = addToRecipeCounts(recipe, recipeCount, maxIngredients, numBuildings)
	maxIngredients = ~~math.max~~(maxIngredients, ~~Recipe.getNumIngredients(recipe)~~)
	~~numBuildings = numBuildings + 1~~
	else		else
	-- ~~Add~~ the building ~~ID to~~ the ~~recipe's list of buildings that can make it.~~		-- add the building if the product, grade, and stacksize are already there
	Recipe.addBuilding(recipeBook[productID][grade][stacksize], buildingID)		Recipe.addBuilding(recipeBook[productID][grade][stacksize], buildingID)
	recipeCount ~~= recipeCount + 1~~		recipeCount, maxIngredients, numBuildings = addToRecipeCounts(recipe, recipeCount, maxIngredients, numBuildings)
	maxIngredients = ~~math.max~~(maxIngredients, ~~Recipe.getNumIngredients(recipe)~~)
	~~numBuildings = numBuildings + 1~~
	end		end
	end		end

76561197969631737: added function to get the display name by ID

2025-11-04T01:13:47Z

added function to get the display name by ID

← Older revision		Revision as of 01:13, 4 November 2025
Line 241:		Line 241:
	data()		data()
	return mapNamesToIDs[displayName]		return mapNamesToIDs[displayName]
			end

			-- Gets the specified building's display name.
			---@param id BuildingID
			---@return BuildingName
			function Building.getName(id)
			return data()[id]._displayName
	end		end

76561197969631737: added a function to build stacks of building links

2025-11-03T21:54:45Z

added a function to build stacks of building links

← Older revision		Revision as of 21:54, 3 November 2025
Line 131:		Line 131:
	local icon = Wiki_Utility.renderIcon		local icon = Wiki_Utility.renderIcon
	local nowrap = Wiki_Utility.surroundWithNoWrap		local nowrap = Wiki_Utility.surroundWithNoWrap
	local ~~classes~~ = Wiki_Utility.surroundWithClasses		local wrapClasses = Wiki_Utility.surroundWithClasses
	local link = Wiki_Utility.renderWikiLink		local link = Wiki_Utility.renderWikiLink
	local NBSP = Wiki_Utility.NBSP		local NBSP = Wiki_Utility.NBSP
Line 192:		Line 192:
	---@param needsIcon boolean		---@param needsIcon boolean
	---@param needsText boolean		---@param needsText boolean
	---@param needsPlural boolean		---@param needsPlural boolean\|nil or nil for default (none)
	---@param pluralForm string\|nil the plural form specified by the author, or nil if `needsPlural` is false		---@param pluralForm string\|nil the plural form specified by the author, or nil if `needsPlural` is false
	---@return Wikitext wikitext		---@return Wikitext wikitext
Line 203:		Line 203:
	iconSize = "x" .. iconSize		iconSize = "x" .. iconSize
	end		end
	wikitext = wikitext .. ~~classes~~(icon(building._iconFilename, iconSize, building._displayName, building._displayName), "ats-link-building", sizeN and sizeN < 23 and "ats-flag-small" or nil)		wikitext = wikitext .. wrapClasses(icon(building._iconFilename, iconSize, building._displayName, building._displayName), "ats-link-building", sizeN and sizeN < 23 and "ats-flag-small" or nil)
	end		end
	if (needsIcon and isValidSize and sizeN >= MIN_ICON_SIZE) and needsText then		if (needsIcon and isValidSize and sizeN >= MIN_ICON_SIZE) and needsText then
Line 241:		Line 241:
	data()		data()
	return mapNamesToIDs[displayName]		return mapNamesToIDs[displayName]
			end

			-- Renders a table of building links.
			---@param buildingIDs BuildingID[] array of building IDs
			---@param iconSize string\|nil size of the icon including any units, e.g., `20em` or `x16px` or assumes `px` if no units, or nil if not relevant
			---@vararg string\|nil additional classes to add to the table, if any
			---@return Wikitext wikitext
			function Building.tableStack(buildingIDs, iconSize, ...)
			local classes = {...}
			local wikitext = "{\|" .. ((#classes > 0) and ("class=" .. table.concat(classes, " ")) or "") .. "\n"
			for _, buildingID in ipairs(buildingIDs) do
			local building = data()[buildingID]
			if not building then return "[Building table stack ID not found: " .. buildingID .. "]" end
			wikitext = wikitext .. "\|-\n"
			wikitext = wikitext .. "\| " .. buildingLink(building, iconSize or standards.medium, true, true) .. "\n"
			end
			return wikitext .. "\|}"
	end		end

76561197969631737: compiling recipes now makes deep copies that can be manipulated (like buildings added, # operator used); docs improvements

2025-11-03T18:30:49Z

compiling recipes now makes deep copies that can be manipulated (like buildings added, # operator used); docs improvements

← Older revision		Revision as of 18:30, 3 November 2025
Line 6:		Line 6:
	---@class Building		---@class Building
	---@field _id BuildingID Unique ID code of the building.		---@field _id BuildingID Unique ID code of the building.
	---@field _displayName ~~string~~ The display name in-game.		---@field _displayName BuildingName The display name in-game.
	---@field _description string The in-game descriptive text, including sprite icons, newlines, and escape characters.		---@field _description string The in-game descriptive text, including sprite icons, newlines, and escape characters.
	---@field _iconFilename Filename The file name of the icon, including its extension.		---@field _iconFilename Filename The file name of the icon, including its extension.
Line 27:		Line 27:
	-- A unique identifier for a building.		-- A unique identifier for a building.
	---@alias BuildingID string		---@alias BuildingID string

			-- The display name of a building.
			---@alias BuildingName string

	-- An ID and amount of a good (e.g., for construction or upgrades).		-- An ID and amount of a good (e.g., for construction or upgrades).
	---@alias RequiredGoodPair {_id: ResourceID, _amount: ~~integer~~}		---@alias RequiredGoodPair {_id: ResourceID, _amount: Amount}

	-- An ID of a water type.		-- An ID of a water type.
Line 123:		Line 126:

	local Recipe = require("Module:Recipe")		local Recipe = require("Module:Recipe")
			local copy = Recipe.copy

	local Wiki_Utility = require("Module:Wiki_Utility")		local Wiki_Utility = require("Module:Wiki_Utility")
Line 149:		Line 153:
	---@type table<BuildingID, Building>		---@type table<BuildingID, Building>
	local buildingData		local buildingData
	---@type table<~~string~~, BuildingID>		---@type table<BuildingName, BuildingID>
	local mapNamesToIDs		local mapNamesToIDs

Line 173:		Line 177:

	-- Finds a building by its display name.		-- Finds a building by its display name.
	---@param buildingName ~~string~~ display name ~~of the building~~		---@param buildingName BuildingName display name
	---@return Building\|nil foundBuilding		---@return Building\|nil foundBuilding
	local function findName(buildingName)		local function findName(buildingName)
Line 232:		Line 236:

	-- Finds a building's ID by its display name.		-- Finds a building's ID by its display name.
	---@param displayName ~~string~~		---@param displayName BuildingName
	---@return BuildingID\|nil		---@return BuildingID\|nil
	function Building.getID(displayName)		function Building.getID(displayName)
Line 266:		Line 270:
	if not requiredIngredientID or Recipe.isIngredientInOptions(recipe, requiredIngredientID) then		if not requiredIngredientID or Recipe.isIngredientInOptions(recipe, requiredIngredientID) then
	if recipeBook[productID] == nil then		if recipeBook[productID] == nil then
	recipeBook[productID] = { [grade] = { [stacksize] = recipe } }		recipeBook[productID] = { [grade] = { [stacksize] = copy(recipe) } }
	recipeCount = recipeCount + 1		recipeCount = recipeCount + 1
	maxIngredients = math.max(maxIngredients, Recipe.getNumIngredients(recipe))		maxIngredients = math.max(maxIngredients, Recipe.getNumIngredients(recipe))
Line 272:		Line 276:
	else		else
	if recipeBook[productID][grade] == nil then		if recipeBook[productID][grade] == nil then
	recipeBook[productID][grade] = { [stacksize] = recipe }		recipeBook[productID][grade] = { [stacksize] = copy(recipe) }
	recipeCount = recipeCount + 1		recipeCount = recipeCount + 1
	maxIngredients = math.max(maxIngredients, Recipe.getNumIngredients(recipe))		maxIngredients = math.max(maxIngredients, Recipe.getNumIngredients(recipe))
Line 278:		Line 282:
	else		else
	if recipeBook[productID][grade][stacksize] == nil then		if recipeBook[productID][grade][stacksize] == nil then
	recipeBook[productID][grade][stacksize] = recipe		recipeBook[productID][grade][stacksize] = copy(recipe)
	recipeCount = recipeCount + 1		recipeCount = recipeCount + 1
	maxIngredients = math.max(maxIngredients, Recipe.getNumIngredients(recipe))		maxIngredients = math.max(maxIngredients, Recipe.getNumIngredients(recipe))

76561197969631737: removed unnecessary function that did not use a proper public interface

2025-11-02T20:34:50Z

removed unnecessary function that did not use a proper public interface

@@ Line 309: / Line 309: @@
 function Building.buildingLinkByID(buildingID, iconSize, needsIcon, needsText)
    return buildingLink(data()[buildingID], iconSize, needsIcon, needsText, false, nil)
 end

76561197969631737: added short function to check IDs

2025-11-02T20:22:57Z

added short function to check IDs

← Older revision		Revision as of 20:22, 2 November 2025
Line 223:		Line 223:

	--#region Public Methods		--#region Public Methods

			-- Checks if the given ID is a valid building ID.
			---@param id BuildingID
			---@return boolean
			function Building.isBuilding(id)
			return data()[id] ~= nil
			end

	-- Finds a building's ID by its display name.		-- Finds a building's ID by its display name.

76561197969631737: updated for support for recipes; small refactors (trying again now that Module:Recipe is live)

2025-10-31T01:22:16Z

updated for support for recipes; small refactors (trying again now that Module:Recipe is live)

Show changes

76561197969631737: Undo revision 11333 by 76561197969631737 (talk)

2025-10-31T01:20:17Z

Undo revision 11333 by 76561197969631737 (talk)

Show changes

76561197969631737: updated for support for recipes; small refactors

2025-10-31T01:19:24Z

updated for support for recipes; small refactors

Show changes

76561197969631737: Removing glade events from building data files--we'll host those separately

2025-10-30T01:56:47Z

Removing glade events from building data files--we'll host those separately

← Older revision		Revision as of 01:56, 30 October 2025
Line 117:		Line 117:
	"Module:Hearth/hearths_data",		"Module:Hearth/hearths_data",
	"Module:Warehouse/warehouses_data",		"Module:Warehouse/warehouses_data",
	"Module:Farm/farm_fields_data",		"Module:Farm/farm_fields_data"
	~~"Module:Glade/glade_events_data",~~
	}		}