Recipient-specific message and EVA on superweapon activation (Phobos-developers#2196)

Adds recipient-specific message and EVA tags for superweapons:

```ini
[SOMESW]                        ; SuperWeaponType
Message.Activated.Owner=        ; CSF entry key
Message.Activated.Allies=       ; CSF entry key
Message.Activated.Enemies=      ; CSF entry key

EVA.Activated.Owner=            ; EVA entry
EVA.Activated.Allies=           ; EVA entry
EVA.Activated.Enemies=          ; EVA entry
```

- Superweapons can now display messages and play EVA voices for specific
recipient groups when activated.
- `Message.Activated.Owner` and `EVA.Activated.Owner` are shown / played
only for the player who activates the superweapon.
- `Message.Activated.Allies` and `EVA.Activated.Allies` are shown /
played only for allies of the player who activates the superweapon,
excluding the activating player.
- `Message.Activated.Enemies` and `EVA.Activated.Enemies` are shown /
played only for enemies of the player who activates the superweapon.
- Unlike `Message.Activated` and `EVA.Activated`, these are not
broadcast to all players.

---------

Co-authored-by: Noble_Fish <1065703286@qq.com>
Co-authored-by: Noble Fish <89088785+DeathFishAtEase@users.noreply.github.com>

Author: Flactine

CREDITS.md

@@ -822,6 +822,7 @@ This page lists all the individual contributions to the project by their author.
 - **Flactine**
   - Add target filtering options to attacheffect system
   - Add veterancy-based target filtering for weapons and warheads
+  - Recipient-specific message and EVA on superweapon activation
 - **tyuah8**:
   - Drive/Jumpjet/Ship/Teleport locomotor did not power on when it is un-piggybacked bugfix
   - Destroyed unit leaves sensors bugfix

docs/New-or-Enhanced-Logics.md

@@ -1212,6 +1212,26 @@ EMPulse.SuspendOthers=false  ; boolean
 `Type=EMPulse` superweapon and any associated keys are [Ares features](https://ares-developers.github.io/Ares-docs/new/superweapons/types/empulse.html).
 ```
 
+### Recipient-specific message and EVA on superweapon activation
+
+- Superweapons can now display messages and play EVA voices for specific recipient groups when activated.
+  - `Message.Activated.Owner` and `EVA.Activated.Owner` are shown / played only for the player who activates the superweapon.
+  - `Message.Activated.Allies` and `EVA.Activated.Allies` are shown / played only for allies of the player who activates the superweapon, excluding the activating player.
+  - `Message.Activated.Enemies` and `EVA.Activated.Enemies` are shown / played only for enemies of the player who activates the superweapon.
+  - Unlike `Message.Activated` and `EVA.Activated`, these are not broadcast to all players.
+
+In `rulesmd.ini`:
+```ini
+[SOMESW]                        ; SuperWeaponType
+Message.Activated.Owner=        ; CSF entry key
+Message.Activated.Allies=       ; CSF entry key
+Message.Activated.Enemies=      ; CSF entry key
+
+EVA.Activated.Owner=            ; EVA entry
+EVA.Activated.Allies=           ; EVA entry
+EVA.Activated.Enemies=          ; EVA entry
+```
+
 ### LimboDelivery
 
 - Superweapons can now deliver off-map buildings that act as if they were on the field.

docs/Whats-New.md

@@ -599,6 +599,7 @@ HideShakeEffects=false           ; boolean
 - [Tank Bunker foundation and state update delay improvements](Fixed-or-Improved-Logics.md#tank-bunker-improvements) (by Starkku)
 - [Custom cruise missiles](New-or-Enhanced-Logics.md#custom-cruise-missiles) (by Noble_Fish)
 - [Allow chat box in singleplayer](User-Interface.md#allow-chat-box-in-singleplayer) (by TaranDahl)
+- [Firer-only message and EVA on superweapon activated](New-or-Enhanced-Logics.md#recipient-specific-message-and-eva-on-superweapon-activation) (by Flactine)
 
 #### Vanilla fixes:
 - Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)

src/Ext/SWType/Body.cpp

@@ -100,6 +100,12 @@ void SWTypeExt::ExtData::Serialize(T& Stm)
 		.Process(this->SW_Link_RollChances)
 		.Process(this->Message_LinkedSWAcquired)
 		.Process(this->EVA_LinkedSWAcquired)
+		.Process(this->Message_Activated_Owner)
+		.Process(this->Message_Activated_Allies)
+		.Process(this->Message_Activated_Enemies)
+		.Process(this->EVA_Activated_Owner)
+		.Process(this->EVA_Activated_Allies)
+		.Process(this->EVA_Activated_Enemies)
 		;
 }
 
@@ -236,6 +242,13 @@ void SWTypeExt::ExtData::LoadFromINIFile(CCINIClass* const pINI)
 	this->EVA_LinkedSWAcquired.Read(exINI, pSection, "EVA.LinkedSWAcquired");
 	this->SW_Link_RollChances.Read(exINI, pSection, "SW.Link.RollChances");
 
+	this->Message_Activated_Owner.Read(exINI, pSection, "Message.Activated.Owner");
+	this->Message_Activated_Allies.Read(exINI, pSection, "Message.Activated.Allies");
+	this->Message_Activated_Enemies.Read(exINI, pSection, "Message.Activated.Enemies");
+	this->EVA_Activated_Owner.Read(exINI, pSection, "EVA.Activated.Owner");
+	this->EVA_Activated_Allies.Read(exINI, pSection, "EVA.Activated.Allies");
+	this->EVA_Activated_Enemies.Read(exINI, pSection, "EVA.Activated.Enemies");
+
 	// SW.Link.RandomWeights
 	for (size_t i = 0; ; ++i)
 	{

src/Ext/SWType/Body.h

@@ -112,6 +112,12 @@ class SWTypeExt
 		ValueableVector<float> SW_Link_RollChances;
 		Valueable<CSFText> Message_LinkedSWAcquired;
 		NullableIdx<VoxClass> EVA_LinkedSWAcquired;
+		Valueable<CSFText> Message_Activated_Owner;
+		Valueable<CSFText> Message_Activated_Allies;
+		Valueable<CSFText> Message_Activated_Enemies;
+		ValueableIdx<VoxClass> EVA_Activated_Owner;
+		ValueableIdx<VoxClass> EVA_Activated_Allies;
+		ValueableIdx<VoxClass> EVA_Activated_Enemies;
 
 		ExtData(SuperWeaponTypeClass* OwnerObject) : Extension<SuperWeaponTypeClass>(OwnerObject)
 			, TypeID { "" }
@@ -195,6 +201,12 @@ class SWTypeExt
 			, SW_Link_RandomWeightsData {}
 			, Message_LinkedSWAcquired {}
 			, EVA_LinkedSWAcquired {}
+			, Message_Activated_Owner {}
+			, Message_Activated_Allies {}
+			, Message_Activated_Enemies {}
+			, EVA_Activated_Owner { -1 }
+			, EVA_Activated_Allies { -1 }
+			, EVA_Activated_Enemies { -1 }
 		{ }
 
 		// Ares 0.A functions
@@ -221,6 +233,9 @@ class SWTypeExt
 
 		void ApplyLinkedSW(SuperClass* pSW);
 
+		void ApplyActivatedMessage(SuperClass* pSW) const;
+		void ApplyActivatedEva(SuperClass* pSW) const;
+
 		virtual void LoadFromINIFile(CCINIClass* pINI) override;
 		virtual void Initialize() override;
 

src/Ext/SWType/FireSuperWeapon.cpp

@@ -37,6 +37,10 @@ void SWTypeExt::FireSuperWeaponExt(SuperClass* pSW, const CellStruct& cell)
 	if (static_cast<int>(pType->Type) == 28 && !pTypeExt->EMPulse_TargetSelf) // Ares' Type=EMPulse SW
 		pTypeExt->HandleEMPulseLaunch(pSW, cell);
 
+	pTypeExt->ApplyActivatedMessage(pSW);
+
+	pTypeExt->ApplyActivatedEva(pSW);
+
 	auto& sw_ext = HouseExt::ExtMap.Find(pHouse)->SuperExts[pType->ArrayIndex];
 	sw_ext.ShotCount++;
 
@@ -483,3 +487,40 @@ void SWTypeExt::ExtData::ApplyLinkedSW(SuperClass* pSW)
 		MessageListClass::Instance.PrintMessage(this->Message_LinkedSWAcquired.Get(), RulesClass::Instance->MessageDelay, HouseClass::CurrentPlayer->ColorSchemeIndex, true);
 	}
 }
+
+void SWTypeExt::ExtData::ApplyActivatedMessage(SuperClass* pSW) const
+{
+	const auto pHouse = pSW->Owner;
+
+	const auto pMessage = pHouse->IsControlledByCurrentPlayer()
+		? &this->Message_Activated_Owner
+		: (pHouse->IsAlliedWith(HouseClass::CurrentPlayer)
+			? &this->Message_Activated_Allies
+			: &this->Message_Activated_Enemies);
+
+	if (pMessage->Get().empty())
+		return;
+		
+	MessageListClass::Instance.PrintMessage(
+		pMessage->Get(),
+		RulesClass::Instance->MessageDelay,
+		pHouse->ColorSchemeIndex,
+		true
+	);
+}
+
+void SWTypeExt::ExtData::ApplyActivatedEva(SuperClass* pSW) const
+{
+	const auto pHouse = pSW->Owner;
+
+	const auto pEva = pHouse->IsControlledByCurrentPlayer()
+		? &this->EVA_Activated_Owner
+		: (pHouse->IsAlliedWith(HouseClass::CurrentPlayer)
+			? &this->EVA_Activated_Allies
+			: &this->EVA_Activated_Enemies);
+
+	if (pEva->Get() == -1)
+		return;
+
+	VoxClass::PlayIndex(pEva->Get(), -1, -1);
+}