Module:BuildingData - Revision history

76561197969631737: added small camps; fixed some icon filenames missing extensions

2023-02-18T01:56:49Z

added small camps; fixed some icon filenames missing extensions

← Older revision		Revision as of 01:56, 18 February 2023
Line 95:		Line 95:

	-- Camps		-- Camps
			["small foragers' camp"] = { page="Small Foragers' Camp",
			iconfile="Small Foragers' Camp icon.png" },
	["foragers' camp"] = { page="Foragers' Camp",		["foragers' camp"] = { page="Foragers' Camp",
	iconfile="Forager's Camp icon" },		iconfile="Forager's Camp icon.png" },
	["harvesters' camp"] = { page="Harvesters' Camp",		["harvesters' camp"] = { page="Harvesters' Camp",
	iconfile="Harvester Camp icon.png" },		iconfile="Harvester Camp icon.png" },
			["small herbalists' camp"] = { page="Small Herbalists' Camp",
			iconfile="Small_Herbalists'_Camp_icon.png" },
	["herbalists' camp"] = { page="Herbalists' Camp",		["herbalists' camp"] = { page="Herbalists' Camp",
	iconfile="Herbalist's_Camp_icon.png" },		iconfile="Herbalist's_Camp_icon.png" },
	["stonecutters' camp"] = { page="Stonecutters' Camp",		["stonecutters' camp"] = { page="Stonecutters' Camp",
	iconfile="Stonecutter's Camp icon.png" },		iconfile="Stonecutter's Camp icon.png" },
			["small trappers' camp"] = { page="Small Trappers' Camp",
			iconfile="Small_Trappers'_Camp_icon.png" },
	["trappers' camp"] = { page="Trappers' Camp",		["trappers' camp"] = { page="Trappers' Camp",
	iconfile="Trapper's Camp icon.png" },		iconfile="Trapper's Camp icon.png" },
	["woodcutters' camp"] = { page="Woodcutters' Camp",		["woodcutters' camp"] = { page="Woodcutters' Camp",
	iconfile="Woodcutters Camp icon" },		iconfile="Woodcutters Camp icon.png" },

	-- Farms		-- Farms

76561197969631737: simplified the getter functions

2023-02-14T02:27:19Z

simplified the getter functions

← Older revision		Revision as of 02:27, 14 February 2023
Line 67:		Line 67:
	-- @key a lowercase version of the building name, with the same spaces,		-- @key a lowercase version of the building name, with the same spaces,
	-- apostrophes, singular, and spelling		-- apostrophes, singular, and spelling
			-- @field page the name of the wiki page, case-sensitive, but otherwise must be
			-- the same as the key
	-- @field iconfile a string of the filename.png of the icon used in the game,		-- @field iconfile a string of the filename.png of the icon used in the game,
	-- case-sensitive and must include extension, but without the "File:"		-- case-sensitive and must include extension, but without the "File:"
	~~-- @field page the name of the wiki page, case-sensitive, but otherwise must be~~
	~~-- the same as the key~~
	-- @field specialization[opt] a table of the specializations listed in the		-- @field specialization[opt] a table of the specializations listed in the
	-- in-game encyclopedia (use the constants, above), or omit if none		-- in-game encyclopedia (use the constants, above), or omit if none
Line 281:		Line 281:
	end		end

	-- normalize the name ~~and~~ try again		-- normalize the name to try again
	local buildingName = Utility.normalizeBuildingName(buildingName)		local buildingName = Utility.normalizeBuildingName(buildingName)

Line 331:		Line 331:
	return nil		return nil
	end		end

	~~local icon = "" -- this is our return variable~~

	-- Get the icon filename, if any. If the building doesn't have an icon,		-- Get the icon filename, if any. If the building doesn't have an icon,
	-- then return an empty string. Returning nil is reserved for when the		-- then return an empty string. Returning nil is reserved for when the
	-- building does not exist.		-- building does not exist.
	~~if tBuilding.iconfile then~~		return tBuilding.iconfile or ""
	~~--overwrite the~~ return ~~variable~~
	~~icon =~~ tBuilding.iconfile
	~~end~~

	~~-- At this point, it could be an empty string, signifying that the building~~
	~~-- exists but does not have an icon.~~
	~~return icon~~
	end		end

Line 438:		Line 429:
	return nil		return nil
	end		end

	~~local workerSlots = 0 -- this is our return variable~~

	-- Get the number of worker slots, if any. If there are none, then return		-- Get the number of worker slots, if any. If there are none, then return
	-- zero. Returning nil is reserved for when the building does not exist.		-- zero. Returning nil is reserved for when the building does not exist.
	~~if tBuilding.workers then~~		return tBuilding.workers or 0
	~~-- overwrite the~~ return ~~variable~~
	~~workerSlots =~~ tBuilding.workers
	~~end~~

	~~-- At this point, it could be zero, signifying that the building exists but~~
	~~-- has no worker slots.~~
	~~return workerSlots~~
	end		end

Line 469:		Line 451:
	return nil		return nil
	end		end

	~~local rainType = "" -- this is our return variable~~

	-- Get the rain type, if any. If the building cannot have rain engines, then		-- Get the rain type, if any. If the building cannot have rain engines, then
	-- return an empty string. Returning nil is reserved for when the building		-- return an empty string. Returning nil is reserved for when the building
	-- does not exist.		-- does not exist.
	~~if tBuilding.raintype then~~		return tBuilding.raintype or ""
	~~-- overwrite the~~ return ~~variable~~
	~~rainType =~~ tBuilding.raintype
	~~end~~

	~~-- At this point, it could be an empty string, signifying that the building~~
	~~-- exists but does not use any rainwater.~~
	~~return rainType~~
	end		end

Line 492:		Line 465:
	-- Accepts the in-game name of the building and returns the corresponding		-- Accepts the in-game name of the building and returns the corresponding
	-- description text, as seen in the game.		-- description text, as seen in the game.
	-- @param the name of the building		-- @param buildingName the name of the building
	-- @return the description of the building, which might be an empty string, or		-- @return the description of the building, which might be an empty string, or
	-- nil if it doesn't exist		-- nil if it doesn't exist
Line 502:		Line 475:
	return nil		return nil
	end		end

	~~local desc = "" -- this is our return variable~~

	-- Get the description, if any. If the building doesn't have a description,		-- Get the description, if any. If the building doesn't have a description,
	-- then return an empty string. Returning nil is reserved for when the		-- then return an empty string. Returning nil is reserved for when the
	-- building does not exist.		-- building does not exist.
	~~if tBuilding.description then~~		return tBuilding.description or ""
	~~--overwrite the~~ return ~~variable~~
	~~desc =~~ tBuilding.description
	~~end~~

	~~-- At this point, it could be an empty string, signifying that the building~~
	~~-- exists but does not have a description.~~
	~~return desc~~
	end		end

76561197969631737: fixing error states

2023-02-13T22:38:07Z

fixing error states

← Older revision		Revision as of 22:38, 13 February 2023
Line 305:		Line 305:
	-- get the inner table for the building		-- get the inner table for the building
	local tBuilding = BuildingData.getData(buildingName)		local tBuilding = BuildingData.getData(buildingName)
			if not tBuilding then
			return nil
			end

	-- if the building didn't exist, then ~~this needs to return~~ nil ~~so it can't~~		-- if the building didn't exist, then nil was already returned, but if the
	-- ~~be used as a key again~~		-- page was undefined, this should return nil instead of an empty string
	return tBuilding.page ~~or nil~~		return tBuilding.page
	end		end

76561197969631737: fixing some scope problems

2023-02-13T22:31:45Z

fixing some scope problems

← Older revision		Revision as of 22:31, 13 February 2023
Line 169:		Line 169:
	cost={ {5,C_PLANK}, {2,C_BRICK} },		cost={ {5,C_PLANK}, {2,C_BRICK} },
	workers=2,		workers=2,
			raintype=R_CLEAR,
	description="Can produce: Crystalized Dew (★★), Cosmetics (★★), Wine (★★). Can use: Clearance Water. Can't be moved. Size: 3x2." },		description="Can produce: Crystalized Dew (★★), Cosmetics (★★), Wine (★★). Can use: Clearance Water. Can't be moved. Size: 3x2." },
	["apothecary"] = { page="Apothecary",		["apothecary"] = { page="Apothecary",
Line 175:		Line 176:
	cost={ {5,C_PLANK}, {2,C_BRICK} },		cost={ {5,C_PLANK}, {2,C_BRICK} },
	workers=2,		workers=2,
			raintype=R_CLEAR,
	description="Can produce: Cosmetics (★★), Incense (★★), Biscuits (★★). Can use: Clearance Water. Can't be moved. Size: 3x3." },		description="Can produce: Cosmetics (★★), Incense (★★), Biscuits (★★). Can use: Clearance Water. Can't be moved. Size: 3x3." },
	["artisan"] = { page="Artisan",		["artisan"] = { page="Artisan",
Line 285:		Line 287:
	-- exist, this will return nil anyway		-- exist, this will return nil anyway
	return tBuildingData[buildingName] or nil		return tBuildingData[buildingName] or nil
			end



			---
			-- Getter method for the page name for a building.
			--
			-- Accepts the in-game name of the building and returns the corresponding name
			-- of the page in the wiki for the building. If the buildingName argument is
			-- formatted exactly as in the game, this will return a string matching the
			-- argument. Since normalization is performed, this can be used to ensure proper
			-- formatting of the building's name.
			-- @param buildingName the name of the building
			-- @return the name of the page on the wiki, or nil if it doens't exist
			function BuildingData.getPagename(buildingName)

			-- get the inner table for the building
			local tBuilding = BuildingData.getData(buildingName)

			-- if the building didn't exist, then this needs to return nil so it can't
			-- be used as a key again
			return tBuilding.page or nil
	end		end

Line 300:		Line 324:

	-- get the inner table for the building		-- get the inner table for the building
	local tBuilding = getData(buildingName)		local tBuilding = BuildingData.getData(buildingName)
	if not tBuilding then		if not tBuilding then
	return nil		return nil
Line 318:		Line 342:
	-- exists but does not have an icon.		-- exists but does not have an icon.
	return icon		return icon
	~~end~~



	~~---~~
	~~-- Getter method for the page name for a building.~~
	--
	~~-- Accepts the in-game name of the building and returns the corresponding name~~
	~~-- of the page in the wiki for the building. If the buildingName argument is~~
	~~-- formatted exactly as in the game, this will return a string matching the~~
	~~-- argument. Since normalization is performed, this can be used to ensure proper~~
	~~-- formatting of the building's name.~~
	~~-- @param buildingName the name of the building~~
	~~-- @return the name of the page on the wiki, or nil if it doens't exist~~
	~~function BuildingData.getPagename(buildingName)~~

	~~-- get the inner table for the building~~
	~~local tBuilding = getData(buildingName)~~

	~~-- if the building didn't exist, then this needs to return nil so it can't~~
	~~-- be used as a key again~~
	~~return tBuilding.page or nil~~
	end		end

Line 356:		Line 358:

	-- get the inner table for the building		-- get the inner table for the building
	local tBuilding = getData(buildingName)		local tBuilding = BuildingData.getData(buildingName)

	-- if the building didn't exist, return nil		-- if the building didn't exist, return nil
Line 395:		Line 397:

	-- get the inner table for the building		-- get the inner table for the building
	local tBuilding = getData(buildingName)		local tBuilding = BuildingData.getData(buildingName)

	-- if the building didn't exist, return nil		-- if the building didn't exist, return nil
Line 429:		Line 431:

	-- get the inner table for the building		-- get the inner table for the building
	local tBuilding = getData(buildingName)		local tBuilding = BuildingData.getData(buildingName)
	if not tBuilding then		if not tBuilding then
	return nil		return nil
Line 460:		Line 462:

	-- get the inner table for the building		-- get the inner table for the building
	local tBuilding = getData(buildingName)		local tBuilding = BuildingData.getData(buildingName)
	if not tBuilding then		if not tBuilding then
	return nil		return nil
Line 493:		Line 495:

	-- get the inner table for the building		-- get the inner table for the building
	local tBuilding = getData(buildingName)		local tBuilding = BuildingData.getData(buildingName)
	if not tBuilding then		if not tBuilding then
	return nil		return nil

76561197969631737: added a few more getters, and improved commenting. adding more details to buildings as I have time

2023-02-13T14:53:36Z

added a few more getters, and improved commenting. adding more details to buildings as I have time

Show changes

76561197969631737: improving commenting

2023-02-13T05:29:33Z

improving commenting

Show changes

76561197969631737: changed function scope

2023-02-12T18:11:56Z

changed function scope

← Older revision		Revision as of 18:11, 12 February 2023
Line 191:		Line 191:

	-- normalize input		-- normalize input
	local strArg = ~~BuildingData~~.~~normalizeName~~(strArg)		local strArg = Utility.normalizeBuildingName(strArg)

	-- Get it from the big table below and return it.		-- Get it from the big table below and return it.

76561197969631737: extracted normalize methods to new Utility module

2023-02-12T18:09:03Z

extracted normalize methods to new Utility module

Show changes

76561197969631737: moving requires to global variables

2023-02-12T17:43:51Z

moving requires to global variables

← Older revision		Revision as of 17:43, 12 February 2023
Line 16:		Line 16:
	-- @module BuildingData		-- @module BuildingData
	local BuildingData = {}		local BuildingData = {}



	--		--
	-- ~~Class Variables~~		-- Dependencies
	--		--
	~~local~~ RecipeData = RecipeData or require("Module:RecipeData") -- used to get recipe data		RecipeData = RecipeData or require("Module:RecipeData") -- used to get recipe data


Line 49:		Line 47:
	local R_CLEAR = "Clearance Water"		local R_CLEAR = "Clearance Water"
	local R_STORM = "Storm Water"		local R_STORM = "Storm Water"



			--
			-- Class Variables
			--

76561197969631737: trying a require or to avoid loop

2023-02-12T17:35:11Z

trying a require or to avoid loop

← Older revision		Revision as of 17:35, 12 February 2023
Line 22:		Line 22:
	-- Class Variables		-- Class Variables
	--		--
	local RecipeData = require("Module:RecipeData") -- used to get recipe data		local RecipeData = RecipeData or require("Module:RecipeData") -- used to get recipe data