Feature/105767 cubic meters cargo

Mammoth/Include/TSE.h

@@ -1467,6 +1467,7 @@ class CSpaceObject
 		void AddEffect (IEffectPainter *pPainter, int xOffset, int yOffset, int iTick = 0, int iRotation = 0);
 		void CalcInsideBarrier (void);
 		Metric CalculateItemMass (Metric *retrCargoMass = NULL) const;
+		Metric CalculateItemVolume (Metric *retrCargoVolume = NULL) const;
 		bool CanFireOnObjHelper (CSpaceObject *pObj) const;
 		void ClearCannotBeHit (void) { m_fCannotBeHit = false; }
 		void ClearInDamageCode (void) { m_fInDamage = false; }

Mammoth/Include/TSEAdventureDesc.h

@@ -38,6 +38,8 @@ class CEngineOptions
 		Metric GetDamageMethodAdjStationHullArmor (EDamageMethod iMethod) const { return GetDamageMethodAdj(m_DamageMethodStationAdj.Hull.Armor, iMethod); };
 		Metric GetDamageMethodMinDamage ()	const { return m_rDamageMethodAdjMinDamage; }
 		EDamageMethodSystem GetDamageMethodSystem () const { return m_iDamageMethodSystem; }
+		Metric GetItemDefaultDensity () const { return m_rDefaultItemDensity; }
+		Metric GetItemXMLMassToVolumeRatio () const { return m_rDefaultItemMassToVolume; }
 		const CMiningDamageLevelDesc* GetMiningMaxOreLevels () const { return &m_MiningDamageMaxOreLevels; }
 		const CDamageAdjDesc* GetShieldDamageAdj (int iLevel) const { if (iLevel < 1 || iLevel > MAX_ITEM_LEVEL) throw CException(ERR_FAIL); return &m_ShieldDamageAdj[iLevel - 1]; }
 		Metric GetShieldIdlePowerRatio () const { return m_rDefaultShieldIdlePowerRatio; }
@@ -169,6 +171,11 @@ class CEngineOptions
 		int m_iDefaultInteraction = -1;
 		int m_iDefaultShotHP = -1;
 
+		//	Default item legacy mass-volume conversions
+
+		Metric m_rDefaultItemDensity = 1.0;
+		Metric m_rDefaultItemMassToVolume = 1.0;
+
 		//	Default power consumption
 
 		Metric m_rDefaultShieldIdlePowerRatio = 0.125;

Mammoth/Include/TSEArmor.h

@@ -132,7 +132,7 @@ class CArmorClass
 		int CalcBalance (const CArmorItem &ArmorItem) const { CArmorItem::SBalance Balance; return CalcBalance(ArmorItem, Balance); }
 		Metric CalcBalanceDamageAdj (const CArmorItem &ArmorItem, const SScalableStats &Stats) const;
 		Metric CalcBalanceDamageEffectAdj (const CArmorItem &ArmorItem, const SScalableStats &Stats) const;
-		Metric CalcBalanceMass (const CArmorItem &ArmorItem, const SScalableStats &Stats, Metric *retrStdMass) const;
+		Metric CalcBalanceSize (const CArmorItem &ArmorItem, const SScalableStats &Stats, Metric *retrStdSize) const;
 		Metric CalcBalancePower (const CArmorItem &ArmorItem, const SScalableStats &Stats) const;
 		Metric CalcBalanceRegen (const CArmorItem &ArmorItem, const SScalableStats &Stats) const;
 		Metric CalcBalanceRepair (const CArmorItem &ArmorItem, const SScalableStats &Stats) const;

Mammoth/Include/TSEDesign.h

@@ -356,7 +356,7 @@ class CDesignType
 		size_t GetAllocMemoryUsage (void) const;
 		DWORD GetAPIVersion (void) const { return m_dwVersion; }
 		const CAchievementDataBlock &GetAchievementDefinitions () const { return (m_pExtra ? m_pExtra->Achievements : CAchievementDataBlock::Null()); }
-		const CArmorMassDefinitions &GetArmorMassDefinitions (void) const { return (m_pExtra ? m_pExtra->ArmorDefinitions : CArmorMassDefinitions::Null); }
+		const CArmorClassDefinitions &GetArmorMassDefinitions (void) const { return (m_pExtra ? m_pExtra->ArmorDefinitions : CArmorClassDefinitions::Null); }
 		const CString &GetAttributes (void) const { return m_sAttributes; }
 		TArray<CString> GetDataKeys (const EDesignDataTypes iDataType );
 		CString GetDataField (const CString &sField) const { CString sValue; FindDataField(sField, &sValue); return sValue; }
@@ -489,7 +489,7 @@ class CDesignType
 			CAttributeDataBlock InitGlobalData;			//	Initial global data
 			CLanguageDataBlock Language;				//	Language data
 			CXMLElement *pLocalScreens = NULL;			//	Local dock screen
-			CArmorMassDefinitions ArmorDefinitions;		//	Armor mass definitions
+			CArmorClassDefinitions ArmorDefinitions;		//	Armor mass definitions
 			CDisplayAttributeDefinitions DisplayAttribs;	//	Display attribute definitions
 			CItemEncounterDefinitions ItemEncounterDefinitions;	//	Item encounter definitions
 			CAchievementDataBlock Achievements;			//	Achievements defined by this type
@@ -1451,8 +1451,8 @@ class CDesignCollection
 		CAdventureDesc &GetAdventureDesc (void) { return (m_pAdventureDesc ? *m_pAdventureDesc : m_EmptyAdventure); }
 		DWORD GetAdventureUNID (void) const { return (m_pAdventureExtension ? m_pAdventureExtension->GetUNID() : 0); }
 		DWORD GetAPIVersion (void) const { return m_dwMinAPIVersion; }
-		CArmorMassDefinitions &GetArmorMassDefinitions (void) { return m_ArmorDefinitions; }
-		const CArmorMassDefinitions &GetArmorMassDefinitions (void) const { return m_ArmorDefinitions; }
+		CArmorClassDefinitions &GetArmorMassDefinitions (void) { return m_ArmorDefinitions; }
+		const CArmorClassDefinitions &GetArmorMassDefinitions (void) const { return m_ArmorDefinitions; }
 		int GetCount (void) const { return m_AllTypes.GetCount(); }
 		int GetCount (DesignTypes iType) const { return m_ByType[iType].GetCount(); }
 		const CDisplayAttributeDefinitions &GetDisplayAttributes (void) const { return m_DisplayAttribs; }
@@ -1517,7 +1517,7 @@ class CDesignCollection
 		CAdventureDesc *m_pAdventureDesc = NULL;
 		TSortMap<CString, const CEconomyType *> m_EconomyIndex;
 		CAchievementDefinitions m_AchievementDefinitions;
-		CArmorMassDefinitions m_ArmorDefinitions;
+		CArmorClassDefinitions m_ArmorDefinitions;
 		CDisplayAttributeDefinitions m_DisplayAttribs;
 		CItemEncounterDefinitions m_ItemEncounterDefinitions;
 		CGlobalEventCache *m_EventsCache[evtCount];

Mammoth/Include/TSEEngineDefs.h

@@ -323,6 +323,49 @@
 #define PROPERTY_CORE_HIDE_RADIATION_IMMUNE		CONSTLIT("core.hideRadiationImmune")
 #define PROPERTY_CORE_HIDE_SHATTER_IMMUNE		CONSTLIT("core.hideShatterImmune")
 
+//	core.item.xmlMassToRealVolume
+//
+//	Adventure Property: Evaluated at bind time. This property exists for adventures
+//	that balance cargo/mass divergently from pre-2.0 Stars of the Pilgrim, but still
+//	wish to convert items from old mods/extensions.
+//	This is relevant because in legacy Stars of the Pilgrim, cargo holds assumed items
+//	have a density much less than water, so the max mass of the cargo holds was divided
+//	by approximately 4. This computation converts the xml mass
+//	from kg to tons BEFORE applying this ratio.
+// 
+//	Notice: if this is not the inverse of core.item.defaultDensity, you will need to
+//	update your armor mass classes accordingly or switch to using armor size classes
+//	Notice: it is strongly recommended to switch to armor size classes instead of
+//	using the legacy armor mass classes
+//	
+//	Example values:
+//	1.0 = volume is set to the mass provided in the XML
+//	1.5 = volume is set to 1.5x the mass provided in the XML
+//	
+//	Default: 1.0
+//
+#define PROPERTY_CORE_ITEM_LEGACY_MASS_TO_VOLUME	CONSTLIT("core.item.xmlMassToRealVolume")
+
+//	core.item.defaultDensity
+//
+//	Adventure Property: Evaluated at bind time. This property allows adventures to
+//	assume a specific density for items that do not provide a volume. This calculation
+//	Is applied after core.item.legacyMassToValue to compute the actual mass the item
+//	should be converted to in this adventure.
+// 
+//	Notice: if this is not the inverse of core.item.defaultDensity, you will need to
+//	update your armor mass classes accordingly or switch to using armor size classes
+//	Notice: it is strongly recommended to switch to armor size classes instead of
+//	using the legacy armor mass classes
+//
+//	Example values:
+//	1.0 = mass is set to the computed volume (equal density to water)
+//	0.125 = mass is set to one quarter the computed volume
+// 
+//	Default: 1.0
+//
+#define PROPERTY_CORE_ITEM_DEFAULT_DENSITY			CONSTLIT("core.item.defaultDensity")
+
 //	core.item.shield.idlePowerAdj
 //
 //	Adventure Property: Evaluated at bind time. This property controls the

Mammoth/Include/TSEItemDefs.h

@@ -74,6 +74,7 @@ class CItemCriteria
 		bool MatchesItemCategory (const CItemType &ItemType) const;
 		bool MatchesLauncherMissilesOnly (void) const { return m_bLauncherMissileOnly; }
 		bool MatchesLevel (int iLevel) const { return m_LevelRange.Matches(iLevel); }
+		bool MatchesSize (Metric rSize) const { return m_SizeRange.Matches(rSize); }
 		bool MatchesMass (int iMassKg) const { return m_MassRange.Matches(iMassKg); }
 		bool MatchesNotInstalledOnly (void) const { return m_bNotInstalledOnly; }
 		bool MatchesPrice (CurrencyValue iValue) const { return m_PriceRange.Matches((int)iValue); }
@@ -110,8 +111,10 @@ class CItemCriteria
 
 		CIntegerRangeCriteria m_LevelRange;			//	Only items of this level
 		CIntegerRangeCriteria m_PriceRange;			//	Only items of this price
+		CDoubleRangeCriteria m_SizeRange;			//	Only items of this volume (in cubic meters (CBM))
 		CIntegerRangeCriteria m_MassRange;			//	Only items of this mass (in kg)
 		CIntegerRangeCriteria m_RepairLevelRange;	//	Only items of this repair level
+
 
 		CString m_sLookup;							//	Look up a shared criteria
 		ICCItemPtr m_pFilter;						//	Filter returns Nil for excluded items
@@ -316,48 +319,51 @@ class CDisplayAttributeDefinitions
 		TArray<SItemEntry> m_ItemAttribs;
 	};
 
-class CArmorMassDefinitions
+class CArmorClassDefinitions
 	{
 	public:
-		void Append (const CArmorMassDefinitions &Src);
+		void Append (const CArmorClassDefinitions &Src);
 		void DeleteAll (void) { m_Definitions.DeleteAll(); InvalidateIDIndex(); }
-		bool FindPreviousMassClass (const CString &sID, CString *retsPrevID = NULL, int *retiPrevMass = NULL) const;
+		bool FindPreviousArmorClass (const CString &sID, CString *retsPrevID = NULL, Metric *retrPrevSize = NULL) const;
 		Metric GetFrequencyMax (const CString &sID) const;
-		const CString &GetMassClassID (const CItem &Item) const;
-		const CString &GetMassClassLabel (const CString &sID) const;
-		int GetMassClassMass (const CString &sID) const;
+		const CString &GetArmorClassID (const CItem &Item) const;
+		const CString &GetArmorClassLabel (const CString &sID) const;
+		Metric GetArmorClassSize (const CString &sID) const;
 		ALERROR InitFromXML (SDesignLoadCtx &Ctx, CXMLElement *pDesc);
 		bool IsEmpty (void) const { return (m_Definitions.GetCount() == 0); }
-		void OnBindArmor (SDesignLoadCtx &Ctx, const CItem &Item, CString *retsMassClass = NULL);
+		void OnBindArmor (SDesignLoadCtx &Ctx, const CItem &Item, CString *retsArmorClass = NULL);
 		void OnInitDone (void);
 
-		static const CArmorMassDefinitions Null;
+		static const CArmorClassDefinitions Null;
 
 	private:
 
-		struct SArmorMassEntry
+		struct SArmorClassEntry
 			{
 			CString sDefinition;			//	Index to m_Definitions
 
 			CString sID;					//	Required ID
-			int iMaxMass = 0;				//	Maximum mass (kg)
+			Metric rMaxSize = 0;			//	Maximum size (cubic meters (CBM))
 			CString sText;					//	Text to display on item
+			CString sTextShort;				//	Text to display in size-constrained UIs
 
-			int iCount = 0;					//	Number of armor types for this mass
+			int iCount = 0;					//	Number of armor types for this class
 			};
 
-		struct SArmorMassDefinition
+		struct SArmorClassDefinition
 			{
 			CItemCriteria Criteria;			//	Criteria for armor
-			TSortMap<int, SArmorMassEntry> Classes;
+			TSortMap<int, SArmorClassEntry> Classes;
+			TSortMap<CString, int> Ids;
 			};
 
-		const SArmorMassEntry *FindMassEntry (const CItem &Item) const { return const_cast<CArmorMassDefinitions *>(this)->FindMassEntryActual(Item); }
-		SArmorMassEntry *FindMassEntryActual (const CItem &Item);
-		void InvalidateIDIndex (void) { m_ByID.DeleteAll(); }
+		const SArmorClassEntry *FindClassEntry (const CItem &Item) const { return const_cast<CArmorClassDefinitions *>(this)->FindClassEntryActual(Item); }
+		SArmorClassEntry *FindClassEntryActual (const CItem &Item);
+		void InvalidateIDIndex () { m_ByID.DeleteAll(); }
+		void CleanupDefinitions () { m_Definitions.DeleteAll(); }
 
-		TSortMap<CString, SArmorMassDefinition> m_Definitions;
-		TSortMap<CString, SArmorMassEntry *> m_ByID;
+		TSortMap<CString, SArmorClassDefinition> m_Definitions;
+		TSortMap<CString, SArmorClassEntry *> m_ByID;
 	};
 
 //	CItemEncounterDefinitions --------------------------------------------------

Mammoth/Include/TSEItemInlines.h

@@ -1,3 +1,4 @@
+#include "TSEItems.h"
 //	TSEItemInlines.h
 //
 //	Inline functions for various item classes.
@@ -27,6 +28,16 @@ inline const CObjectImageArray &CItem::GetImage (void) const
 	return (m_pItemType ? m_pItemType->GetImage() : CObjectImageArray::Null());
 	}
 
+//	GetVolume
+//
+//	Get the volume in cubic meters for a single instance of this item
+//
+inline Metric CItem::GetVolume() const
+	{
+	CItemCtx ItemCtx(*this);
+	return m_pItemType->GetVolume(ItemCtx);
+	}
+
 inline bool CItem::HasAttribute (const CString &sAttrib) const
 	{
 	return (m_pItemType ? m_pItemType->HasLiteralAttribute(sAttrib): false);
@@ -71,12 +82,12 @@ inline bool CDifferentiatedItem::AccumulateEnhancementDisplayAttributes (TArray<
 	return m_Item.AccumulateEnhancementDisplayAttributes(retList);
 	}
 
-inline ItemCategories CDifferentiatedItem::GetCategory (void) const
+inline ItemCategories CDifferentiatedItem::GetCategory () const
 	{
 	return m_Item.GetCategory();
 	}
 
-inline int CDifferentiatedItem::GetCharges (void) const
+inline int CDifferentiatedItem::GetCharges () const
 	{
 	return m_Item.GetCharges();
 	}
@@ -87,7 +98,7 @@ inline CCurrencyAndValue CDifferentiatedItem::GetCurrencyAndValue (bool bActual)
 	return GetType().GetCurrencyAndValue(ItemCtx, bActual);
 	}
 
-inline const CEconomyType &CDifferentiatedItem::GetCurrencyType (void) const
+inline const CEconomyType &CDifferentiatedItem::GetCurrencyType () const
 	{
 	const CEconomyType *pCurrency = GetType().GetCurrencyType();
 	if (pCurrency)
@@ -96,22 +107,27 @@ inline const CEconomyType &CDifferentiatedItem::GetCurrencyType (void) const
 		return GetType().GetUniverse().GetCreditCurrency();
 	}
 
-inline const CObjectImageArray &CDifferentiatedItem::GetImage (void) const
+inline const CObjectImageArray &CDifferentiatedItem::GetImage () const
 	{
 	return m_Item.GetImage();
 	}
 
-inline int CDifferentiatedItem::GetLevel (void) const
+inline int CDifferentiatedItem::GetLevel () const
 	{
 	return m_Item.GetLevel();
 	}
 
-inline int CDifferentiatedItem::GetMassKg (void) const
+inline int CDifferentiatedItem::GetMassKg () const
 	{
 	return m_Item.GetMassKg();
 	}
 
-inline int CDifferentiatedItem::GetMinLevel (void) const
+inline Metric CDifferentiatedItem::GetVolume () const
+	{
+	return m_Item.GetVolume();
+	}
+
+inline int CDifferentiatedItem::GetMinLevel () const
 	{
 	return GetType().GetMinLevel();
 	}
@@ -139,17 +155,17 @@ inline ICCItemPtr CDifferentiatedItem::GetPropertyKeys () const
 	return m_Item.GetItemPropertyKeys(CCX, ItemCtx, false);
 	}
 
-inline int CDifferentiatedItem::GetVariantNumber (void) const
+inline int CDifferentiatedItem::GetVariantNumber () const
 	{
 	return m_Item.GetVariantNumber();
 	}
 
-inline const CItemType &CDifferentiatedItem::GetType (void) const
+inline const CItemType &CDifferentiatedItem::GetType () const
 	{
 	return *m_Item.GetType();
 	}
 
-inline CItemType &CDifferentiatedItem::GetType (void)
+inline CItemType &CDifferentiatedItem::GetType ()
 	{
 	return *m_Item.GetType();
 	}
@@ -159,22 +175,22 @@ inline bool CDifferentiatedItem::IsDamaged (int *retiDamagedHP) const
 	return m_Item.IsDamaged(retiDamagedHP);
 	}
 
-inline bool CDifferentiatedItem::IsDisrupted (void) const
+inline bool CDifferentiatedItem::IsDisrupted () const
 	{
 	return m_Item.IsDisrupted();
 	}
 
-inline bool CDifferentiatedItem::IsEnhanced (void) const
+inline bool CDifferentiatedItem::IsEnhanced () const
 	{
 	return m_Item.IsEnhanced();
 	}
 
-inline bool CDifferentiatedItem::IsLauncher (void) const
+inline bool CDifferentiatedItem::IsLauncher () const
 	{
 	return m_Item.IsLauncher();
 	}
 
-inline bool CDifferentiatedItem::IsWeapon (void) const
+inline bool CDifferentiatedItem::IsWeapon () const
 	{
 	return m_Item.IsWeapon();
 	}
@@ -191,12 +207,12 @@ inline int CArmorClass::GetInstallCost (const CArmorItem &ArmorItem) const
 	const SScalableStats &Stats = GetScaledStats(ArmorItem); return (int)m_pItemType->GetCurrencyType()->Exchange(Stats.InstallCost);
 	}
 
-inline CString CArmorClass::GetName (void) const
+inline CString CArmorClass::GetName () const
 	{
 	return m_pItemType->GetNounPhrase();
 	}
 
-inline DWORD CArmorClass::GetUNID (void)
+inline DWORD CArmorClass::GetUNID ()
 	{
 	return m_pItemType->GetUNID();
 	}

Mammoth/Include/TSEItemType.h

@@ -118,6 +118,7 @@ class CItemType : public CDesignType
 		bool GetUseDesc (SUseDesc *retDesc = NULL) const;
 		int GetValue (CItemCtx &Ctx, bool bActual = false) const { return (int)GetCurrencyAndValue(Ctx, bActual).GetValue(); }
 		int GetValueBonusPerCharge (void) const { return m_iExtraValuePerCharge; }
+		Metric GetVolume (CItemCtx &Ctx) const;
 		CWeaponFireDesc *GetWeaponFireDesc (CItemCtx &Ctx, CString *retsError = NULL) const;
 		bool HasOnRefuelCode (void) const { return FindEventHandlerItemType(evtOnRefuel); }
 		bool HasOnInstallCode (void) const { return FindEventHandlerItemType(evtOnInstall); }
@@ -195,6 +196,7 @@ class CItemType : public CDesignType
 		int m_iMaxLevel;                        //  Max level, for scalable items
 		CCurrencyAndValue m_iValue;				//	Value in some currency
 		int m_iMass;							//	Mass in kilograms
+		Metric m_rVolume;						//	Volume in Cubic meters
 		FrequencyTypes m_Frequency;				//	Frequency
 		DiceRange m_NumberAppearing;			//	Number appearing
 
@@ -207,6 +209,7 @@ class CItemType : public CDesignType
 
 		int m_iExtraMassPerCharge;				//	Extra mass per charge (in kilos)
 		int m_iExtraValuePerCharge;				//	Extra value per charge (may be negative)
+		Metric m_rExtraVolumePerCharge;			//	Extra volume per charge (in cubic meters)
 
 		//	Components
 		IItemGenerator *m_pComponents;			//	Table to generate item components (may be NULL)