Module:Ships data - Revision history

76561197969631737: now multiplies by crew quantity when calculating stats_max as it should

2026-08-07T18:37:34Z

now multiplies by crew quantity when calculating stats_max as it should

← Older revision		Revision as of 18:37, 7 August 2026
Line 2,065:		Line 2,065:
	--#region: Private data enrichment functions		--#region: Private data enrichment functions

			--- Gets the quantity of a specified crew type for the given ship
			---@param ship ShipRecord
			---@param crew_type string
			---@return number\|nil
			local function compute_crew_qty_by_type(ship, crew_type)
			if not ship then return nil end
			if (not crew_type) or (type(crew_type) ~= "string") or (crew_type == "") then return nil end
			for _, crew_type_pair in ipairs(ship.crew_types) do
			if crew_type_pair.type == crew_type then
			return crew_type_pair.qty
			end
			end
			return 0
			end

			--- Compute the maximum stats for a ship.
			---@param ship ShipRecord
			---@return ShipStatAmount[]\|nil
	local function compute_stats_max(ship)		local function compute_stats_max(ship)
	if not ship then return nil end		if not ship then return nil end
Line 2,074:		Line 2,092:
	}		}
	end		end
	for _, crew_bonuses in pairs(ship.stats_crew_bonuses) do		for crew_type, crew_bonuses in pairs(ship.stats_crew_bonuses) do
	for index, bonus_pair in ipairs(crew_bonuses) do		for index, bonus_pair in ipairs(crew_bonuses) do
	assert(stats_max[index].stat == bonus_pair.stat, "stats_crew_bonuses order mismatch")		assert(stats_max[index].stat == bonus_pair.stat, "stats_crew_bonuses order mismatch")
	stats_max[index].qty = stats_max[index].qty + bonus_pair.qty		stats_max[index].qty = stats_max[index].qty
			+ bonus_pair.qty * compute_crew_qty_by_type(ship, crew_type)
	end		end
	end		end

76561197969631737: 76561197969631737 moved page Module:Ship data.lua to Module:Ships data without leaving a redirect: Misspelled title: Pluralized to match intent. Removed filename extension from Module name

2026-08-07T18:14:28Z

76561197969631737 moved page Module:Ship data.lua to Module:Ships data without leaving a redirect: Misspelled title: Pluralized to match intent. Removed filename extension from Module name

← Older revision		Revision as of 18:14, 7 August 2026
(No difference)

76561197969631737: formatting adjustments only

2026-08-07T18:12:15Z

formatting adjustments only

← Older revision		Revision as of 18:12, 7 August 2026
Line 10:		Line 10:
	end		end

	local NAME = "name"		local NAME = "name"
	local TIER = "tier"		local TIER = "tier"
	local PRINCIPLE_PATH = "principle_path"		local PRINCIPLE_PATH = "principle_path"
	local CLASS = "class"		local CLASS = "class"
	local HYBRID_PATH = "hybrid_path"		local HYBRID_PATH = "hybrid_path"
	local ICON_FILENAME = "icon_filename"		local ICON_FILENAME = "icon_filename"
	local PIER = "pier"		local PIER = "pier"
	local DESCRIPTION = "description"		local DESCRIPTION = "description"
	local CONSTRUCTION_COSTS = "construction_costs"		local CONSTRUCTION_COSTS = "construction_costs"
	local CREW_TYPES = "crew_types"		local CREW_TYPES = "crew_types"
	local STATS_BASE = "stats_base"		local STATS_BASE = "stats_base"
	local STATS_CREW_BONUSES = "stats_crew_bonuses"		local STATS_CREW_BONUSES = "stats_crew_bonuses"

Line 40:		Line 40:
	local REQUIRED_SHIP_FIELDS_ALLOWED_NAMES = build_allowed_set(REQUIRED_SHIP_FIELDS)		local REQUIRED_SHIP_FIELDS_ALLOWED_NAMES = build_allowed_set(REQUIRED_SHIP_FIELDS)

	local PLANKS = "Planks"		local PLANKS = "Planks"
	local ROPE = "Rope"		local ROPE = "Rope"
	local SAILS = "Sails"		local SAILS = "Sails"
	local FIGUREHEAD = "Figurehead"		local FIGUREHEAD = "Figurehead"
	local PITCH = "Pitch"		local PITCH = "Pitch"
	local FITTINGS = "Fittings"		local FITTINGS = "Fittings"
	local JOLLY_ROGER = "Jolly Roger"		local JOLLY_ROGER = "Jolly Roger"
	local NAVAL_GUN = "Naval Gun"		local NAVAL_GUN = "Naval Gun"
	local STEEL_CHAIN = "Steel Chain"		local STEEL_CHAIN = "Steel Chain"
	local SILVER_LINING = "Silver Lining"		local SILVER_LINING = "Silver Lining"
	local COPPER_LAMP = "Copper Lamp"		local COPPER_LAMP = "Copper Lamp"

	--- Ordered list of valid field names for ship construction costs.		--- Ordered list of valid field names for ship construction costs.
Line 77:		Line 77:
	local RENEGADES = "Renegades"		local RENEGADES = "Renegades"
	local MARAUDERS = "Marauders"		local MARAUDERS = "Marauders"
	local CORSAIRS = "Corsairs"		local CORSAIRS = "Corsairs"

	--- Ordered list of valid field names for ship crew types.		--- Ordered list of valid field names for ship crew types.
Line 94:		Line 94:
	local VALID_SHIP_CREW_TYPES_ALLOWED_NAMES = build_allowed_set(VALID_SHIP_CREW_TYPES)		local VALID_SHIP_CREW_TYPES_ALLOWED_NAMES = build_allowed_set(VALID_SHIP_CREW_TYPES)

	local HEALTH = "Health"		local HEALTH = "Health"
	local CREW = "Crew"		local CREW = "Crew"
	local SUPPLIES = "Supplies"		local SUPPLIES = "Supplies"
	local GUN_DAMAGE = "Gun Damage"		local GUN_DAMAGE = "Gun Damage"
	local BOARDING_DAMAGE = "Boarding Damage"		local BOARDING_DAMAGE = "Boarding Damage"
	local SPEED = "Speed"		local SPEED = "Speed"
	local MANOEUVRABILITY = "Manoeuvrability"		local MANOEUVRABILITY = "Manoeuvrability"
	local ARMOUR = "Armour"		local ARMOUR = "Armour"

	--- Ordered list of valid field names for ship stats.		--- Ordered list of valid field names for ship stats.
Line 116:		Line 116:
	local REQUIRED_SHIP_STATS_ALLOWED_NAMES = build_allowed_set(REQUIRED_SHIP_STATS)		local REQUIRED_SHIP_STATS_ALLOWED_NAMES = build_allowed_set(REQUIRED_SHIP_STATS)

	local SPECIAL = "Special"		local SPECIAL = "Special"
	local PROWLER = "Prowler"		local PROWLER = "Prowler"
	local PROWLER_PLUS = "Prowler+"		local PROWLER_PLUS = "Prowler+"
	local DESTROYER = "Destroyer"		local DESTROYER = "Destroyer"
	local DESTROYER_PLUS = "Destroyer+"		local DESTROYER_PLUS = "Destroyer+"
	local HUNTER = "Hunter"		local HUNTER = "Hunter"
	local HUNTER_PLUS = "Hunter+"		local HUNTER_PLUS = "Hunter+"
	local REAVER = "Reaver"		local REAVER = "Reaver"
	local REAVER_PLUS = "Reaver+"		local REAVER_PLUS = "Reaver+"

	--- Set of valid class names.		--- Set of valid class names.
Line 140:		Line 140:
	local VALID_CLASSES_ALLOWED_NAMES = build_allowed_set(VALID_CLASSES)		local VALID_CLASSES_ALLOWED_NAMES = build_allowed_set(VALID_CLASSES)

	local NONE = "None"		local NONE = "None"
	local NOTORIETY = "Notoriety"		local NOTORIETY = "Notoriety"
	local EMPIRE = "Empire"		local EMPIRE = "Empire"
	local SEAFARING = "Seafaring"		local SEAFARING = "Seafaring"
	local WEALTH = "Wealth"		local WEALTH = "Wealth"

	--- Set of valid Principle Paths.		--- Set of valid Principle Paths.
Line 156:		Line 156:
	local VALID_PRINCIPLE_PATHS_ALLOWED_NAMES = build_allowed_set(VALID_PRINCIPLE_PATHS)		local VALID_PRINCIPLE_PATHS_ALLOWED_NAMES = build_allowed_set(VALID_PRINCIPLE_PATHS)

	local SHALLOW_PIER = "Shallow Pier"		local SHALLOW_PIER = "Shallow Pier"
	local TRADE_PIER = "Trade Pier"		local TRADE_PIER = "Trade Pier"
	local DEEP_WATER_PIER = "Deep-water Pier"		local DEEP_WATER_PIER = "Deep-water Pier"

Line 169:		Line 169:

	local RESOURCE = "resource"		local RESOURCE = "resource"
	local TYPE = "type"		local TYPE = "type"
	local STAT = "stat"		local STAT = "stat"
	local QTY = "qty"		local QTY = "qty"

	local all_fields_are_required = true		local all_fields_are_required = true

76561197969631737: reliability and API updates

2026-08-07T14:30:51Z

reliability and API updates

Show changes

76561197969631737: now uses mw.log instead of print

2026-08-06T02:23:24Z

now uses mw.log instead of print

← Older revision		Revision as of 02:23, 6 August 2026
Line 258:		Line 258:
	seen[index] = true		seen[index] = true
	end		end
	~~print~~('ships_data validated successfully')		---@diagnostic disable-next-line: undefined-global
			mw.log('ships_data.lua validated successfully')
	end		end

76561197969631737: refactored with some constants for more reliable data validation

2026-08-06T02:20:31Z

refactored with some constants for more reliable data validation

Show changes

76561197969631737: Created to serve up ship data through public api (see bottom of module file for functions)

2026-08-05T23:23:56Z

Created to serve up ship data through public api (see bottom of module file for functions)

Show changes