Module:Resource data - Revision history

76561197969631737: now skips Coffee

2026-10-10T20:18:05Z

now skips Coffee

← Older revision		Revision as of 20:18, 10 October 2026
Line 242:		Line 242:
	["Food"] = true,		["Food"] = true,
	["Meal"] = true,		["Meal"] = true,
			-- these are blank
			["Coffee"] = true,
	}		}

76561197969631737: now correctly stores the codename for the resource

2026-10-10T03:57:37Z

now correctly stores the codename for the resource

← Older revision		Revision as of 03:57, 10 October 2026
Line 198:		Line 198:
	local function restructure_resource_record(record)		local function restructure_resource_record(record)
	local resource = {		local resource = {
	name = record.~~page_name~~,		name = record.Name,
	category = record.Type,		category = record.Type,
	produce_type = record.ProduceType,		produce_type = record.ProduceType,

76561197969631737: Added a function to get a resource's name with its codename

2026-10-10T03:34:59Z

Added a function to get a resource's name with its codename

@@ Line 3: / Line 3: @@
 =mw.dumpObject(p.get_resource("Power"))
 =mw.dumpObject(p.get_all_resources())
 ]]--
 local p = {}
@@ Line 58: / Line 59: @@
      TABLE = "Resources",
      WHERE_NAME = "page_name",
      ORDER_BY = "page_name",
      -- Commented out fields are not used in the current implementation.
      FIELDS = {
@@ Line 145: / Line 150: @@
+     {
        where = QUERIES.RESOURCES.WHERE_NAME .. '="' .. resource_name .. '"',
      })
    if not result or #result == 0 then return nil end
@@ Line 201: / Line 223: @@
 ---@field get_all_resources fun(): Resource[] gets all resources
 ---@field get_resource fun(resource_name: string): Resource|nil looks up a resource by name
 p.MAX_RESOURCE_LISTS = 5
@@ Line 236: / Line 259: @@
 ---@field peep_energy_added number|nil the amount of energy added per peep per second
 ---@field resource_list string[]|nil the defined resource lists for the resource
 --- Fetches a resource record from the database.

76561197969631737: fixed some skipped resource names; now skips the ones listed as Fake

2026-10-01T01:54:29Z

fixed some skipped resource names; now skips the ones listed as Fake

← Older revision		Revision as of 01:54, 1 October 2026
Line 206:		Line 206:
	p.SKIPPED_RESOURCE_NAMES = {		p.SKIPPED_RESOURCE_NAMES = {
	["Astrobaleenium_Ground"] = true,		["Astrobaleenium_Ground"] = true,
			["Crystal_Ground"] = true,
	["FieldSeed"] = true,		["FieldSeed"] = true,
	["Gold_Ground"] = true,		["Gold_Ground"] = true,
Line 212:		Line 213:
	["Peep"] = true,		["Peep"] = true,
	["Shell_Ground"] = true,		["Shell_Ground"] = true,
	["~~Trash_Compacted~~"] = true,		["Trash_Ground"] = true,
			-- these are listed as "Fake"
			["Beverage"] = true,
			["Drink"] = true,
			["Food"] = true,
			["Meal"] = true,

	}		}

76561197969631737: now skips things that aren't real resources

2026-10-01T01:35:03Z

now skips things that aren't real resources

@@ Line 103: / Line 103: @@
 --#region MARK: Cargo queries
 --- Queries cargo for all resource records.
@@ Line 117: / Line 130: @@
      })
    if not result or #result == 0 then return {} end
    return result
 end
@@ Line 133: / Line 147: @@
      })
    if not result or #result == 0 then return nil end
    return result[1]
 end
@@ Line 189: / Line 204: @@
 p.MAX_RESOURCE_LISTS = 5
 p.POWER_RESOURCE_NAME = "Power"
 ---@class Resource

76561197969631737: now just resource_list; unused field removed

2026-10-01T01:22:41Z

now just resource_list; unused field removed

← Older revision		Revision as of 01:22, 1 October 2026
Line 173:		Line 173:
	peep_happiness_added = tonumber(record.PeepHappinessAdded),		peep_happiness_added = tonumber(record.PeepHappinessAdded),
	peep_energy_added = tonumber(record.PeepEnergyAdded),		peep_energy_added = tonumber(record.PeepEnergyAdded),
	~~defined_resource_lists~~ = {},		resource_list = {},
	}		}
	resource.resource_list = restructure_resource_list(record)		resource.resource_list = restructure_resource_list(record)
Line 203:		Line 203:
	---@field peep_happiness_added number\|nil the amount of happiness added per peep per second		---@field peep_happiness_added number\|nil the amount of happiness added per peep per second
	---@field peep_energy_added number\|nil the amount of energy added per peep per second		---@field peep_energy_added number\|nil the amount of energy added per peep per second
	---@field ~~defined_resource_list~~ string[]\|nil the defined resource lists for the resource		---@field resource_list string[]\|nil the defined resource lists for the resource

	--- Fetches a resource record from the database.		--- Fetches a resource record from the database.

76561197969631737: changed category to Type and removed type from use; added temperature

2026-10-01T01:19:40Z

changed category to Type and removed type from use; added temperature

← Older revision		Revision as of 01:19, 1 October 2026
Line 78:		Line 78:
	"PeepHappinessAdded",		"PeepHappinessAdded",
	-- "DontDrop",		-- "DontDrop",
	-- "ResourceTemperature",		"ResourceTemperature",
	-- "SummaryType",		-- "SummaryType",
	"ResourceCategory",		-- "ResourceCategory",
	-- "Renewable",		-- "Renewable",
	-- "KnownRecordName",		-- "KnownRecordName",
Line 162:		Line 162:
	local resource = {		local resource = {
	name = record.page_name,		name = record.page_name,
			category = record.Type,
			produce_type = record.ProduceType,
	display_name = record.DisplayNameTerm_en,		display_name = record.DisplayNameTerm_en,
	display_name_plural = record.DisplayNamePluralTerm_en,		display_name_plural = record.DisplayNamePluralTerm_en,
	icon = record.IconAddress,		icon = record.IconAddress,
	~~type = record.Type,~~
	~~produce_type = record.ProduceType,~~
	peep_carry_amount = tonumber(record.PeepCarryAmount),		peep_carry_amount = tonumber(record.PeepCarryAmount),
	known_at_start = record.KnownAtStart,		known_at_start = record.KnownAtStart,
			peep_temperature_effect = record.ResourceTemperature,
	peep_exhaustion_removed = tonumber(record.PeepExhaustionRemoved),		peep_exhaustion_removed = tonumber(record.PeepExhaustionRemoved),
	peep_happiness_added = tonumber(record.PeepHappinessAdded),		peep_happiness_added = tonumber(record.PeepHappinessAdded),
	peep_energy_added = tonumber(record.PeepEnergyAdded),		peep_energy_added = tonumber(record.PeepEnergyAdded),
	~~category = record.SummaryType,~~
	defined_resource_lists = {},		defined_resource_lists = {},
	}		}
Line 197:		Line 197:
	---@field display_name_plural string\|nil the plural display name of the resource		---@field display_name_plural string\|nil the plural display name of the resource
	---@field icon string\|nil the icon filename for the resource		---@field icon string\|nil the icon filename for the resource
	~~---@field type string\|nil the type of the resource~~
	---@field peep_carry_amount number\|nil how many a peep can carry at once		---@field peep_carry_amount number\|nil how many a peep can carry at once
	---@field known_at_start boolean\|nil whether the resource is known at start		---@field known_at_start boolean\|nil whether the resource is known at start
			---@field peep_temperature_effect string\|nil the temperature effect of the resource
	---@field peep_exhaustion_removed number\|nil the amount of exhaustion removed per peep per second		---@field peep_exhaustion_removed number\|nil the amount of exhaustion removed per peep per second
	---@field peep_happiness_added number\|nil the amount of happiness added per peep per second		---@field peep_happiness_added number\|nil the amount of happiness added per peep per second

76561197969631737: changing category to SummaryType instead

2026-09-30T22:07:06Z

changing category to SummaryType instead

← Older revision		Revision as of 22:07, 30 September 2026
Line 172:		Line 172:
	peep_happiness_added = tonumber(record.PeepHappinessAdded),		peep_happiness_added = tonumber(record.PeepHappinessAdded),
	peep_energy_added = tonumber(record.PeepEnergyAdded),		peep_energy_added = tonumber(record.PeepEnergyAdded),
	~~resource_category~~ = record.~~ResourceCategory~~,		category = record.SummaryType,
	defined_resource_lists = {},		defined_resource_lists = {},
	}		}

76561197969631737: renamed ResourceRecord to Resource, renamed resource_category to category. reordered some fields

2026-09-30T21:58:47Z

renamed ResourceRecord to Resource, renamed resource_category to category. reordered some fields

← Older revision		Revision as of 21:58, 30 September 2026
Line 158:		Line 158:
	--- Restructures a resource record from the database into a more usable format.		--- Restructures a resource record from the database into a more usable format.
	---@param record CargoResourceRecord the resource record retrieved from the database		---@param record CargoResourceRecord the resource record retrieved from the database
	---@return ~~ResourceRecord~~		---@return Resource
	local function restructure_resource_record(record)		local function restructure_resource_record(record)
	local resource = {		local resource = {
Line 184:		Line 184:

	---@class ResourceDataModule		---@class ResourceDataModule
	---@field get_all_resources fun(): ~~ResourceRecord~~[] gets all resources		---@field get_all_resources fun(): Resource[] gets all resources
	---@field get_resource fun(resource_name: string): ~~ResourceRecord~~\|nil looks up a resource by name		---@field get_resource fun(resource_name: string): Resource\|nil looks up a resource by name

	p.MAX_RESOURCE_LISTS = 5		p.MAX_RESOURCE_LISTS = 5
	p.POWER_RESOURCE_NAME = "Power"		p.POWER_RESOURCE_NAME = "Power"

	---@class ~~ResourceRecord~~		---@class Resource
	---@field name string\|nil the in-game codename for the resource		---@field name string\|nil the in-game codename for the resource
			---@field category string\|nil the category of the resource
			---@field produce_type string\|nil the produce type of the resource
	---@field display_name string\|nil the display name of the resource		---@field display_name string\|nil the display name of the resource
	---@field display_name_plural string\|nil the plural display name of the resource		---@field display_name_plural string\|nil the plural display name of the resource
	---@field icon string\|nil the icon filename for the resource		---@field icon string\|nil the icon filename for the resource
	---@field type string\|nil the type of the resource		---@field type string\|nil the type of the resource
	~~---@field produce_type string\|nil the produce type of the resource~~		---@field peep_carry_amount number\|nil how many a peep can carry at once
	---@field peep_carry_amount number\|nil ~~the~~ peep carry ~~amount of the resource~~
	---@field known_at_start boolean\|nil whether the resource is known at start		---@field known_at_start boolean\|nil whether the resource is known at start
	---@field peep_exhaustion_removed number\|nil the amount of exhaustion removed per peep per second		---@field peep_exhaustion_removed number\|nil the amount of exhaustion removed per peep per second
	---@field peep_happiness_added number\|nil the amount of happiness added per peep per second		---@field peep_happiness_added number\|nil the amount of happiness added per peep per second
	---@field peep_energy_added number\|nil the amount of energy added per peep per second		---@field peep_energy_added number\|nil the amount of energy added per peep per second
	~~---@field resource_category string\|nil the category of the resource~~
	---@field defined_resource_list string[]\|nil the defined resource lists for the resource		---@field defined_resource_list string[]\|nil the defined resource lists for the resource

	--- Fetches a resource record from the database.		--- Fetches a resource record from the database.
	---@param resource_name string the in-game name of the resource to fetch		---@param resource_name string the in-game name of the resource to fetch
	---@return ~~ResourceRecord~~\|nil		---@return Resource\|nil
	function p.get_resource(resource_name)		function p.get_resource(resource_name)
	if not resource_name or resource_name == "" then return nil end		if not resource_name or resource_name == "" then return nil end
Line 217:		Line 217:

	--- Fetches all resource records from the database.		--- Fetches all resource records from the database.
	---@return ~~ResourceRecord~~[]		---@return Resource[]
	function p.get_all_resources()		function p.get_all_resources()
	local raw_records = query_all_resources()		local raw_records = query_all_resources()

76561197969631737: Added query all

2026-09-30T03:20:22Z

Added query all

← Older revision		Revision as of 03:20, 30 September 2026
Line 2:		Line 2:
	Test in Scribunto console with:		Test in Scribunto console with:
	=mw.dumpObject(p.get_resource("Power"))		=mw.dumpObject(p.get_resource("Power"))
			=mw.dumpObject(p.get_all_resources())
	]]--		]]--
	local p = {}		local p = {}
Line 7:		Line 8:


	--#region Cargo~~-related type definitions and constants~~		--#region MARK: Cargo types

	--- Cargo row from querying Resources; all values are strings at runtime.		--- Cargo row from querying Resources; all values are strings at runtime.
Line 47:		Line 48:
	---@field DefinedResourceLists_5 string\|nil		---@field DefinedResourceLists_5 string\|nil

			--#endregion



			--#region MARK: Cargo consts

	local QUERIES = {		local QUERIES = {
Line 52:		Line 58:
	TABLE = "Resources",		TABLE = "Resources",
	WHERE_NAME = "page_name",		WHERE_NAME = "page_name",
	ORDER_BY = "~~sort_order~~",		ORDER_BY = "page_name",
	-- Commented out fields are not used in the current implementation.		-- Commented out fields are not used in the current implementation.
	FIELDS = {		FIELDS = {
Line 96:		Line 102:


	--#region Cargo queries		--#region MARK: Cargo queries

			--- Queries cargo for all resource records.
			---@return CargoResourceRecord[]
			local function query_all_resources()
			local cargo = mw.ext.cargo
			if not cargo then return {} end
			local result = cargo.query(
			QUERIES.RESOURCES.TABLE,
			table.concat(QUERIES.RESOURCES.FIELDS, ","),
			{
			limit = 150,
			orderBy = QUERIES.RESOURCES.ORDER_BY,
			})
			if not result or #result == 0 then return {} end
			return result
			end

	--- Queries cargo for the resource record with the given name.		--- Queries cargo for the resource record with the given name.
Line 118:		Line 140:


	--#region Local ~~helper functions~~		--#region MARK: Local helpers

	--- Makes an array out of multiple optional fields from a resource record.		--- Makes an array out of multiple optional fields from a resource record.
Line 159:		Line 181:


	--#region Public interface		--#region MARK: Public interface

	---@class ResourceDataModule		---@class ResourceDataModule
Line 192:		Line 214:
	local record = restructure_resource_record(raw_record)		local record = restructure_resource_record(raw_record)
	return record		return record
			end

			--- Fetches all resource records from the database.
			---@return ResourceRecord[]
			function p.get_all_resources()
			local raw_records = query_all_resources()
			if not raw_records or #raw_records == 0 then return {} end
			local records = {}
			for _, raw_record in ipairs(raw_records) do
			local record = restructure_resource_record(raw_record)
			table.insert(records, record)
			end
			return records
	end		end