Add Passengers/Occupants Cameo Display

CREDITS.md

@@ -821,3 +821,4 @@ This page lists all the individual contributions to the project by their author.
   - Multiplayer gamespeed fix for RealTimeTimers
   - Revert Ares patch to allow OpenTopped transport customization
   - Fix for units with Fly, Jumpjet or Rocket locomotors crashing off-map not being cleaned up
+- **ABCZ (CZHczhABCZ)** - Unit passengers display

Phobos.vcxproj

@@ -45,6 +45,7 @@
     <ClCompile Include="src\Commands\SaveVariablesToFile.cpp" />
     <ClCompile Include="src\Commands\ToggleDesignatorRange.cpp" />
     <ClCompile Include="src\Commands\ToggleDigitalDisplay.cpp" />
+    <ClCompile Include="src\Commands\ToggleUnitPassengers.cpp" />
     <ClCompile Include="src\Commands\ToggleMessageList.cpp" />
     <ClCompile Include="src\Commands\ToggleSWSidebar.cpp" />
     <!-- src\Ext -->
@@ -303,6 +304,7 @@
     <ClInclude Include="src\Commands\SaveVariablesToFile.h" />
     <ClInclude Include="src\Commands\ToggleDesignatorRange.h" />
     <ClInclude Include="src\Commands\ToggleDigitalDisplay.h" />
+    <ClInclude Include="src\Commands\ToggleUnitPassengers.h" />
     <ClInclude Include="src\Commands\ToggleMessageList.h" />
     <ClInclude Include="src\Commands\ToggleSWSidebar.h" />
     <!-- src\Ext -->

docs/User-Interface.md

@@ -487,6 +487,41 @@ In `RA2MD.INI`:
 ShowPowerPlantEnhancerRange=false  ; boolean
 ```
 
+### Unit Passengers Display
+
+- You can now configure the game to display the passengers contained within a vehicle above it when selected. Each passenger type is shown as its Cameo icon with a count number in the upper-right corner.
+- Two activation modes:
+  - **Permanent mode**: Set `ShowUnitPassengers=true` (global) or `ShowPassengers=true` (per-vehicle) to always show the display, regardless of the hotkey state.
+  - **Toggleable mode**: Set `ShowUnitPassengers.Toggleable=true` (global) and use the [Toggle Unit Passengers](#toggle-unit-passengers) hotkey to switch the display on/off. Per-vehicle `ShowPassengers.Toggleable` can override the global setting.
+- When the feature is toggled via the hotkey, a message is shown in the top-left corner of the screen. The message text can be customized via CSF labels.
+- Icons are arranged in horizontal rows from left to right, with the bottom row fixed at the bottom boundary. If the number of passenger types exceeds `Passengers.PerRow`, additional rows are drawn above the bottom row.
+
+In `rulesmd.ini`:
+```ini
+[AudioVisual]
+ShowUnitPassengers=false              ; boolean, permanently shows passengers for all vehicles (ignores hotkey). Defaults to false
+ShowUnitPassengers.Toggleable=false   ; boolean, allows hotkey to toggle the display. Defaults to false
+ShowUnitPassengers.EnabledMessage=    ; CSF entry key, message shown when the feature is enabled via hotkey
+ShowUnitPassengers.DisabledMessage=   ; CSF entry key, message shown when the feature is disabled via hotkey
+
+[SOMETECHNO]                          ; TechnoType
+ShowPassengers=                       ; boolean, permanently show/hide for this vehicle (overrides global). Not set = follow global
+ShowPassengers.Toggleable=            ; boolean, override global toggleable setting for this vehicle. Not set = follow global
+Passengers.PerRow=5                   ; integer, max icons per row before wrapping, defaults to 5
+Passengers.BottomOffset=0,0           ; X,Y, bottom boundary offset from selection bracket, defaults to 0,0
+```
+
+In `RA2MD.CSF`:
+
+; Hotkey UI labels
+TXT_UNIT_PASSENGERS       Toggle Unit Passengers
+TXT_UNIT_PASSENGERS_DESC  Show/hide unit passengers display.
+
+; Optional: customize the enabled/disabled messages
+; (must match the labels set in ShowUnitPassengers.EnabledMessage / DisabledMessage)
+MSG:UnitPassengersEnabled   Unit Passengers display: Enabled
+MSG:UnitPassengersDisabled  Unit Passengers display: Disabled
+
 ## Hotkey Commands
 
 ### `[ ]` Display Damage Numbers
@@ -519,6 +554,11 @@ ShowPowerPlantEnhancerRange=false  ; boolean
 - Switches on/off [digital display types](#digital-display).
 - For localization add `TXT_DIGITAL_DISPLAY` and `TXT_DIGITAL_DISPLAY_DESC` into your `.csf` file.
 
+### `[ ]` Toggle Unit Passengers
+
+- Switches on/off [unit passengers display](#unit-passengers-display).
+- For localization add `TXT_UNIT_PASSENGERS` and `TXT_UNIT_PASSENGERS_DESC` into your `.csf` file.
+
 ### `[ ]` Next Idle Harvester
 
 - Selects and centers the camera on the next TechnoType that is counted via the [harvester counter](#harvester-counter) and is currently idle.

docs/Whats-New.md

@@ -29,6 +29,11 @@ This serves as a changelog for when you just need to drop the new version in wit
 
 ### Version TBD (develop branch nightly builds)
 
+#### New:
+
+- New unit passengers display feature - show passenger cameo icons and counts above vehicles when selected (see [User Interface](User-Interface.md#unit-passengers-display))
+- New hotkey `Toggle Unit Passengers` to enable/disable the passengers display, with customizable CSF messages
+- New INI tags: `[AudioVisual] -> ShowUnitPassengers`, `ShowUnitPassengers.Toggleable`, `ShowUnitPassengers.EnabledMessage`, `ShowUnitPassengers.DisabledMessage`, `[TechnoType] -> ShowPassengers`, `ShowPassengers.Toggleable`, `Passengers.PerRow`, `Passengers.BottomOffset`
 - `Splits.TargetCellRange` < 0 now applies special behaviour where the projectile does not consider nearby cells as additional targets if there are not enough techno targets to match `Cluster` count at all.
 - Combat light customizations introduced a bug that removed vanilla behaviour of ignoring detail level / framerate checks for colored combat light. This bug has been fixed but the previous behaviour can be restored by setting `CombatLightDetailLevel.CheckColored` on Warhead or globally under `[AudioVisual]`.
 - `[TechnoType] -> WarpAway=` has now been changed to set the animation when units are erased to maintain semantic consistency with `[General] -> WarpAway=`. The animation that was originally controlled by `[TechnoType] -> WarpAway=`, which played instead of `[General] -> WarpOut=` when a Techno is chronowarped by chronosphere, now needs to be specified using `[TechnoType] -> Chronoshift.WarpOut=`, which defaults to the value of `[TechnoType] -> WarpOut=`.

src/Commands/Commands.cpp

@@ -7,6 +7,7 @@
 #include "FrameByFrame.h"
 #include "FrameStep.h"
 #include "ToggleDigitalDisplay.h"
+#include "ToggleUnitPassengers.h"
 #include "ToggleDesignatorRange.h"
 #include "SaveVariablesToFile.h"
 #include "ToggleSWSidebar.h"
@@ -27,6 +28,7 @@ DEFINE_HOOK(0x533066, CommandClassCallback_Register, 0x6)
 	MakeCommand<NextIdleHarvesterCommandClass>();
 	MakeCommand<QuickSaveCommandClass>();
 	MakeCommand<ToggleDigitalDisplayCommandClass>();
+	MakeCommand<ToggleUnitPassengersCommandClass>();
 	MakeCommand<ToggleDesignatorRangeCommandClass>();
 	MakeCommand<ToggleMessageListCommandClass>();
 	MakeCommand<ToggleSWSidebar>();

src/Commands/ToggleUnitPassengers.cpp

@@ -0,0 +1,56 @@
+#include "ToggleUnitPassengers.h"
+
+#include <Utilities/GeneralUtils.h>
+#include <Ext/Rules/Body.h>
+#include <MessageListClass.h>
+#include <HouseClass.h>
+
+const char* ToggleUnitPassengersCommandClass::GetName() const
+{
+	return "Toggle Unit Passengers";
+}
+
+const wchar_t* ToggleUnitPassengersCommandClass::GetUIName() const
+{
+	return GeneralUtils::LoadStringUnlessMissing("TXT_UNIT_PASSENGERS", L"Toggle Unit Passengers");
+}
+
+const wchar_t* ToggleUnitPassengersCommandClass::GetUICategory() const
+{
+	return CATEGORY_INTERFACE;
+}
+
+const wchar_t* ToggleUnitPassengersCommandClass::GetUIDescription() const
+{
+	return GeneralUtils::LoadStringUnlessMissing("TXT_UNIT_PASSENGERS_DESC", L"Show/hide unit passengers display.");
+}
+
+void ToggleUnitPassengersCommandClass::Execute(WWKey eInput) const
+{
+	Phobos::Config::UnitPassengers_Enable = !Phobos::Config::UnitPassengers_Enable;
+
+	auto PrintMessage = [](const wchar_t* pMessage)
+	{
+		MessageListClass::Instance.PrintMessage(
+			pMessage,
+			RulesClass::Instance->MessageDelay,
+			HouseClass::CurrentPlayer->ColorSchemeIndex,
+			true
+		);
+	};
+
+	const auto pRulesExt = RulesExt::Global();
+
+	if (Phobos::Config::UnitPassengers_Enable)
+	{
+		const auto& msg = pRulesExt->ShowUnitPassengers_EnabledMessage;
+		if (msg.isset())
+			PrintMessage(GeneralUtils::LoadStringUnlessMissing(msg.Get().Label, L"Unit Passengers display: Enabled"));
+	}
+	else
+	{
+		const auto& msg = pRulesExt->ShowUnitPassengers_DisabledMessage;
+		if (msg.isset())
+			PrintMessage(GeneralUtils::LoadStringUnlessMissing(msg.Get().Label, L"Unit Passengers display: Disabled"));
+	}
+}

src/Commands/ToggleUnitPassengers.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include "Commands.h"
+
+class ToggleUnitPassengersCommandClass : public CommandClass
+{
+public:
+	virtual const char* GetName() const override;
+	virtual const wchar_t* GetUIName() const override;
+	virtual const wchar_t* GetUICategory() const override;
+	virtual const wchar_t* GetUIDescription() const override;
+	virtual void Execute(WWKey eInput) const override;
+};

src/Ext/Rules/Body.cpp

@@ -366,6 +366,10 @@ void RulesExt::ExtData::LoadBeforeTypeData(RulesClass* pThis, CCINIClass* pINI)
 	this->SortCameoByName.Read(exINI, GameStrings::General, "SortCameoByName");
 
 	this->MergeBuildingDamage.Read(exINI, GameStrings::CombatDamage, "MergeBuildingDamage");
+	this->ShowUnitPassengers.Read(exINI, GameStrings::AudioVisual, "ShowUnitPassengers");
+	this->ShowUnitPassengers_Toggleable.Read(exINI, GameStrings::AudioVisual, "ShowUnitPassengers.Toggleable");
+	this->ShowUnitPassengers_EnabledMessage.Read(exINI, GameStrings::AudioVisual, "ShowUnitPassengers.EnabledMessage");
+	this->ShowUnitPassengers_DisabledMessage.Read(exINI, GameStrings::AudioVisual, "ShowUnitPassengers.DisabledMessage");
 
 	this->ApplyPerTargetEffectsOnDetonate.Read(exINI, GameStrings::CombatDamage, "ApplyPerTargetEffectsOnDetonate");
 
@@ -769,6 +773,10 @@ void RulesExt::ExtData::Serialize(T& Stm)
 		.Process(this->MindControl_Permanent_ReplaceSilent)
 		.Process(this->TeamDelays_DynamicType)
 		.Process(this->TeamDelays_Count)
+		.Process(this->ShowUnitPassengers)
+		.Process(this->ShowUnitPassengers_Toggleable)
+		.Process(this->ShowUnitPassengers_EnabledMessage)
+		.Process(this->ShowUnitPassengers_DisabledMessage)
 		;
 }
 

src/Ext/Rules/Body.h

@@ -194,6 +194,11 @@ class RulesExt
 
 		Valueable<bool> MergeBuildingDamage;
 
+		Valueable<bool> ShowUnitPassengers;
+		Valueable<bool> ShowUnitPassengers_Toggleable;
+		Nullable<CSFText> ShowUnitPassengers_EnabledMessage;
+		Nullable<CSFText> ShowUnitPassengers_DisabledMessage;
+
 		Valueable<double> DamageOwnerMultiplier;
 		Valueable<double> DamageAlliesMultiplier;
 		Valueable<double> DamageEnemiesMultiplier;
@@ -664,9 +669,12 @@ class RulesExt
 			, DiscardOn_MoveBasedOnDestination { false }
 			, RemoveMindControl_Silent { false }
 			, MindControl_Permanent_ReplaceSilent { false }
-
 			, TeamDelays_DynamicType { DynamicTeamDelayType::StartingPoint }
 			, TeamDelays_Count {}
+			, ShowUnitPassengers { false }
+			, ShowUnitPassengers_Toggleable { false }
+			, ShowUnitPassengers_EnabledMessage {}
+			, ShowUnitPassengers_DisabledMessage {}
 		{ }
 
 		virtual ~ExtData() = default;

src/Ext/Techno/Body.Visuals.cpp

@@ -3,6 +3,7 @@
 #include <Ext/Anim/Body.h>
 #include <Ext/SWType/Body.h>
 #include <Ext/House/Body.h>
+#include <ObjectClass.h>
 
 void TechnoExt::DrawSelfHealPips(TechnoClass* pThis, Point2D* pLocation, RectangleStruct* pBounds)
 {
@@ -873,3 +874,122 @@ void TechnoExt::ShowPromoteAnim(TechnoClass* pThis)
 	else if (!eliteAnims.empty())
 		AnimExt::CreateRandomAnim(eliteAnims, pThis->GetCenterCoords(), pThis, pThis->Owner, true, true);
 }
+
+void TechnoExt::DrawUnitPassengers(TechnoClass* pThis)
+{
+	if (ObjectClass::CurrentObjects.Count != 1)
+		return;
+
+	if (ObjectClass::CurrentObjects.GetItem(0) != pThis)
+		return;
+
+	const auto whatAmI = pThis->WhatAmI();
+	if (whatAmI != AbstractType::Unit && whatAmI != AbstractType::Aircraft)
+		return;
+
+	const auto pType = pThis->GetTechnoType();
+	const auto pTypeExt = TechnoTypeExt::ExtMap.Find(pType);
+	const auto pRulesExt = RulesExt::Global();
+
+	bool shouldShow = false;
+
+	if (pTypeExt->ShowPassengers.isset())
+	{
+		shouldShow = pTypeExt->ShowPassengers.Get();
+	}
+	else if (pRulesExt->ShowUnitPassengers)
+	{
+		shouldShow = true;
+	}
+	else
+	{
+		const bool toggleable = pTypeExt->ShowPassengers_Toggleable.Get(pRulesExt->ShowUnitPassengers_Toggleable);
+		if (toggleable && Phobos::Config::UnitPassengers_Enable)
+			shouldShow = true;
+	}
+
+	if (!shouldShow)
+		return;
+
+	if (pThis->Passengers.NumPassengers <= 0)
+		return;
+
+	std::map<TechnoTypeClass*, int> passengerCounts;
+	for (auto pPassenger = pThis->Passengers.GetFirstPassenger(); pPassenger; pPassenger = abstract_cast<FootClass*>(pPassenger->NextObject))
+	{
+		passengerCounts[pPassenger->GetTechnoType()]++;
+	}
+
+	if (passengerCounts.empty())
+		return;
+
+	const auto bracketPos = GetFootSelectBracketPosition(pThis, Anchor(HorizontalPosition::Center, VerticalPosition::Top));
+	const auto& bottomOffset = pTypeExt->Passengers_BottomOffset;
+	Point2D basePos = bracketPos;
+	basePos.X += bottomOffset.Get().X;
+	basePos.Y += bottomOffset.Get().Y + pType->PixelSelectionBracketDelta;
+
+	const double scale = 1.0;
+
+	const int perRow = pTypeExt->Passengers_PerRow;
+	const int iconWidth = static_cast<int>(60 * scale);
+	const int iconHeight = static_cast<int>(48 * scale);
+	const int hGap = 2;
+	const int vGap = 2;
+
+	const int count = static_cast<int>(passengerCounts.size());
+	const int rows = (count + perRow - 1) / perRow;
+
+	const auto pSurface = DSurface::Composite;
+	RectangleStruct bounds = DSurface::Composite->GetRect();
+
+	int idx = 0;
+	for (const auto& item : passengerCounts)
+	{
+		const auto pPassengerType = item.first;
+		const int passengerCount = item.second;
+
+		const int row = idx / perRow;
+		const int col = idx % perRow;
+
+		const int itemsInThisRow = (row == rows - 1 && count % perRow != 0) ? (count % perRow) : perRow;
+		const int rowWidth = itemsInThisRow * (iconWidth + hGap) - hGap;
+		const int startX = basePos.X - rowWidth / 2;
+
+		const int y = basePos.Y - iconHeight - (rows - 1 - row) * (iconHeight + vGap);
+
+		Point2D iconPos = { startX + col * (iconWidth + hGap), y };
+
+		SHPStruct* pCameo = pPassengerType->GetCameo();
+		if (pCameo)
+		{
+			pSurface->DrawSHP(
+				FileSystem::CAMEO_PAL,
+				pCameo,
+				0,
+				&iconPos,
+				&bounds,
+				BlitterFlags::bf_400 | BlitterFlags::Alpha,
+				0, 0,
+				ZGradient::Ground,
+				1000, 0, nullptr, 0, 0, 0
+			);
+
+			wchar_t countText[16];
+			_snwprintf_s(countText, _countof(countText), _TRUNCATE, L"%d", passengerCount);
+
+			Point2D textPos = { iconPos.X + iconWidth - 4, iconPos.Y + 2 };
+
+			pSurface->DrawTextA(
+				countText,
+				&bounds,
+				&textPos,
+				Drawing::RGB_To_Int({ 0, 255, 0 }),
+				0,
+				TextPrintType::Center | TextPrintType::FullShadow
+			);
+		}
+
+		idx++;
+	}
+}

src/Ext/Techno/Body.h

@@ -296,6 +296,7 @@ class TechnoExt
 	static Point2D GetBuildingSelectBracketPosition(TechnoClass* pThis, BuildingSelectBracketPosition bracketPosition);
 	static void DrawSelectBox(TechnoClass* pThis, const Point2D* pLocation, const RectangleStruct* pBounds, bool drawBefore = false);
 	static void ProcessDigitalDisplays(TechnoClass* pThis);
+	static void DrawUnitPassengers(TechnoClass* pThis);
 	static void GetValuesForDisplay(TechnoClass* pThis, TechnoTypeClass* pType, DisplayInfoType infoType, int& value, int& maxValue, int infoIndex);
 	static void GetDigitalDisplayFakeHealth(TechnoClass* pThis, int& value, int& maxValue);
 	static void CreateDelayedFireAnim(TechnoClass* pThis, AnimTypeClass* pAnimType, int weaponIndex, bool attach, bool center, bool removeOnNoDelay, bool onTurret, CoordStruct firingCoords);

src/Ext/Techno/Hooks.Pips.cpp

@@ -93,6 +93,7 @@ DEFINE_HOOK(0x6F65D1, TechnoClass_DrawHealthBar_Buildings, 0x6)
 	}
 
 	TechnoExt::ProcessDigitalDisplays(pThis);
+	TechnoExt::DrawUnitPassengers(pThis);
 
 	return 0;
 }
@@ -123,6 +124,7 @@ DEFINE_HOOK(0x6F683C, TechnoClass_DrawHealthBar_Units, 0x7)
 	}
 
 	TechnoExt::ProcessDigitalDisplays(pThis);
+	TechnoExt::DrawUnitPassengers(pThis);
 
 	if (pExt->TypeExtData->HealthBar_HidePips)
 	{