Offline power plant indicator

CREDITS.md

@@ -323,6 +323,7 @@ This page lists all the individual contributions to the project by their author.
   - Sound entry on unit's creation
   - Auto-deploy/Deploy block on ammo change
   - Flashing Technos on selecting
+  - Offline power plant indicator
 - **ZivDero**
   - Allow giving ownership of buildings to players in Skirmish and MP using <Player @ A-H>
   - Re-enable the Veinhole Monster and Weeds from TS

docs/Fixed-or-Improved-Logics.md

@@ -348,6 +348,26 @@ In `rulesmd.ini`:
 SellBuildupLength=23  ; integer, number of buildup frames to play
 ```
 
+### Offline power plant indicator
+
+- If `DrawPowerOffline` is set, indicator will appear on power plants when being offline, for example, drained by floating disk, infiltrated or disabled when using ForceShield.
+- `DrawPowerOffline.Offset` is used to adjust position of indicator.
+- `DrawPowerOffline.Shape` is a name of shape used to draw indicator. `POWEROFF.SHP` is used by default if not set.
+- `DrawPowerOffline.Palette` is a name of palette used to draw indicator. `MOUSEPAL.PAL` is used by default if not set.
+- `DisablePowerOfflineIcon` is used to disable indicator per building type.
+
+In `rulesmd.ini`:
+```ini
+[AudioVisual]
+DrawPowerOffline=false          ; boolean
+DrawPowerOffline.Shape=         ; shape name without .shp extension
+DrawPowerOffline.Palette=       ; palette name with .pal extension
+DrawPowerOffline.Offset=0,0     ; integer, offset
+
+[SOMEBUILDING]
+DisablePowerOfflineIcon=false   ; boolean
+```
+
 ## Particle systems
 
 ### Fire particle target coordinate adjustment when firer rotates

docs/Whats-New.md

@@ -369,6 +369,7 @@ New:
 - Reloading ammo in transports (by Starkku)
 - Dump variables to file on scenario end / hotkey (by Morton)
 - "House owns TechnoType" and "House doesn't own TechnoType" trigger events
+- Offline power plant indicator (by Fryone)
 - Allow toggling `Infantry/UnitsGainSelfHeal` for `MultiplayPassive=true` houses (by Starkku)
 - Customizable straight trajectory detonation & snap distance and pass-through option (by Starkku)
 - Airstrike & spy plane fixed spawn distance & height (by Starkku)

src/Ext/Building/Body.cpp

@@ -328,6 +328,16 @@ bool BuildingExt::HandleInfiltrate(BuildingClass* pBuilding, HouseClass* pInfilt
 	return true;
 }
 
+void BuildingExt::DrawOfflinePlantIndicator(Point2D* pPosition, RectangleStruct* pBounds, int drawSpeed)
+{
+	SHPStruct* pSHP = RulesExt::Global()->DrawPowerOffline_Shape ? RulesExt::Global()->DrawPowerOffline_Shape : FileSystem::POWEROFF_SHP;
+	ConvertClass* pPalette = RulesExt::Global()->DrawPowerOffline_Palette.GetOrDefaultConvert(FileSystem::MOUSE_PAL);
+	Point2D nPoint = *pPosition + RulesExt::Global()->DrawPowerOffline_Offset;
+
+	const int frame = (pSHP->Frames * (Unsorted::CurrentFrame % drawSpeed)) / drawSpeed;
+	DSurface::Temp->DrawSHP(pPalette, pSHP, frame, &nPoint, pBounds, BlitterFlags(0xE00), 0, 0, ZGradient::Ground, 1000, 0, 0, 0, 0, 0);
+}
+
 // =============================
 // load / save
 

src/Ext/Building/Body.h

@@ -104,4 +104,6 @@ class BuildingExt
 	static bool DoGrindingExtras(BuildingClass* pBuilding, TechnoClass* pTechno, int refund);
 	static bool HandleInfiltrate(BuildingClass* pBuilding, HouseClass* pInfiltratorHouse);
 	static bool CanUndeployOnSell(BuildingClass* pThis);
+
+	static void DrawOfflinePlantIndicator(Point2D* pPosition, RectangleStruct* pBounds, int drawSpeed);
 };

src/Ext/Building/Hooks.cpp

@@ -418,3 +418,42 @@ DEFINE_HOOK(0x4511D6, BuildingClass_AnimationAI_SellBuildup, 0x7)
 
 	return pTypeExt->SellBuildupLength == pThis->Animation.Value ? Continue : Skip;
 }
+
+// Addition to Ares' Extras
+DEFINE_HOOK(0x6F5347, TechnoClass_DrawExtras_OfflinePlants, 0x7)
+{
+	GET(TechnoClass*, pThis, EBP);
+	GET_STACK(RectangleStruct*, pRect, 0xA0);
+
+	const auto pBld = abstract_cast<BuildingClass*>(pThis);
+	auto exit = [R, pRect]()
+	{
+		R->ESI(pRect);
+		return 0x6F534E;
+	};
+
+	if (!pBld)
+		return exit();
+
+	if (!RulesExt::Global()->DrawPowerOffline)
+		return exit();
+
+	const auto pTypeExt = BuildingTypeExt::ExtMap.Find(pBld->Type);
+	bool showLowPower = (pTypeExt->DisablePowerOfflineIcon == false)
+		&& (pBld->Type->PowerBonus > 0)
+		&& (pBld->Factory == nullptr)
+		&& (pBld->IsPowerOnline() == false || pBld->IsBeingDrained())
+		&& (pBld->IsBeingWarpedOut() == false)
+		&& (pBld->WarpingOut == false)
+		&& ((pBld->GetCurrentMission() != Mission::Selling) && (pBld->GetCurrentMission() != Mission::Construction))
+		&& (pBld->CloakState == CloakState::Uncloaked);
+
+	if (!showLowPower || MapClass::Instance->GetCellAt(pBld->GetMapCoords())->IsShrouded())
+		return exit();
+
+	Point2D nPoint = TacticalClass::Instance->CoordsToClient(pBld->GetCenterCoords()).first;
+	const int speed = Math::max(GameOptionsClass::Instance->GetAnimSpeed(14) / 4, 2);
+	BuildingExt::DrawOfflinePlantIndicator(&nPoint, pRect, speed);
+
+	return exit();
+}

src/Ext/BuildingType/Body.cpp

@@ -147,6 +147,7 @@ void BuildingTypeExt::ExtData::LoadFromINIFile(CCINIClass* const pINI)
 
 	this->ConsideredVehicle.Read(exINI, pSection, "ConsideredVehicle");
 	this->SellBuildupLength.Read(exINI, pSection, "SellBuildupLength");
+	this->DisablePowerOfflineIcon.Read(exINI, pSection, "DisablePowerOfflineIcon");
 
 	if (pThis->NumberOfDocks > 0)
 	{
@@ -259,6 +260,7 @@ void BuildingTypeExt::ExtData::Serialize(T& Stm)
 		.Process(this->ZShapePointMove_OnBuildup)
 		.Process(this->SellBuildupLength)
 		.Process(this->AircraftDockingDirs)
+		.Process(this->DisablePowerOfflineIcon)
 		;
 }
 

src/Ext/BuildingType/Body.h

@@ -61,6 +61,7 @@ class BuildingTypeExt
 		Nullable<bool> ConsideredVehicle;
 		Valueable<bool> ZShapePointMove_OnBuildup;
 		Valueable<int> SellBuildupLength;
+		Valueable<bool> DisablePowerOfflineIcon;
 
 		std::vector<OptionalStruct<DirType, true>> AircraftDockingDirs;
 
@@ -101,6 +102,7 @@ class BuildingTypeExt
 			, ZShapePointMove_OnBuildup { false }
 			, SellBuildupLength { 23 }
 			, AircraftDockingDirs {}
+			, DisablePowerOfflineIcon { false }
 		{ }
 
 		// Ares 0.A functions

src/Ext/Rules/Body.cpp

@@ -125,6 +125,11 @@ void RulesExt::ExtData::LoadBeforeTypeData(RulesClass* pThis, CCINIClass* pINI)
 	this->HeightShadowScaling.Read(exINI, GameStrings::AudioVisual, "HeightShadowScaling");
 	this->HeightShadowScaling_MinScale.Read(exINI, GameStrings::AudioVisual, "HeightShadowScaling.MinScale");
 
+	this->DrawPowerOffline.Read(exINI, GameStrings::AudioVisual, "DrawPowerOffline");
+	this->DrawPowerOffline_Offset.Read(exINI, GameStrings::AudioVisual, "DrawPowerOffline.Offset");
+	this->DrawPowerOffline_Shape.Read(exINI, GameStrings::AudioVisual, "DrawPowerOffline.Shape");
+	this->DrawPowerOffline_Palette.LoadFromINI(pINI, GameStrings::AudioVisual, "DrawPowerOffline.Palette");
+
 	this->AllowParallelAIQueues.Read(exINI, "GlobalControls", "AllowParallelAIQueues");
 	this->ForbidParallelAIQueues_Aircraft.Read(exINI, "GlobalControls", "ForbidParallelAIQueues.Infantry");
 	this->ForbidParallelAIQueues_Building.Read(exINI, "GlobalControls", "ForbidParallelAIQueues.Building");
@@ -295,6 +300,10 @@ void RulesExt::ExtData::Serialize(T& Stm)
 		.Process(this->DrawTurretShadow)
 		.Process(this->IsVoiceCreatedGlobal)
 		.Process(this->SelectionFlashDuration)
+		.Process(this->DrawPowerOffline)
+		.Process(this->DrawPowerOffline_Offset)
+		.Process(this->DrawPowerOffline_Shape)
+		.Process(this->DrawPowerOffline_Palette)
 		.Process(this->AnimRemapDefaultColorScheme)
 		.Process(this->TimerBlinkColorScheme)
 		.Process(this->Buildings_DefaultDigitalDisplayTypes)

src/Ext/Rules/Body.h

@@ -110,6 +110,11 @@ class RulesExt
 		ValueableIdx<ColorScheme> AnimRemapDefaultColorScheme;
 		ValueableIdx<ColorScheme> TimerBlinkColorScheme;
 
+		Valueable<bool> DrawPowerOffline;
+		Valueable<Point2D> DrawPowerOffline_Offset;
+		Nullable<SHPStruct*> DrawPowerOffline_Shape;
+		CustomPalette DrawPowerOffline_Palette;
+
 		ValueableVector<DigitalDisplayTypeClass*> Buildings_DefaultDigitalDisplayTypes;
 		ValueableVector<DigitalDisplayTypeClass*> Infantry_DefaultDigitalDisplayTypes;
 		ValueableVector<DigitalDisplayTypeClass*> Vehicles_DefaultDigitalDisplayTypes;
@@ -193,6 +198,10 @@ class RulesExt
 			, DrawTurretShadow { false }
 			, IsVoiceCreatedGlobal { false }
 			, SelectionFlashDuration { 0 }
+			, DrawPowerOffline { false }
+			, DrawPowerOffline_Offset { { 0, 0 } }
+			, DrawPowerOffline_Shape { }
+			, DrawPowerOffline_Palette { }
 			, AnimRemapDefaultColorScheme { 0 }
 			, TimerBlinkColorScheme { 5 }
 			, Buildings_DefaultDigitalDisplayTypes {}