Ground line for select box (#1717)

- `Grounded` has been abandoned, you can now use `GroundShape` to
specific a image which always draw on ground, it will only draw when
techno is in air if set `Ground.AlwaysDraw=false`, this also affect on
`GroundLine`.
- `Grounded` 已经被废弃了，你现在可以通过 `GroundShape` 指定一个始终绘制在地面的图像，若
`Ground.AlwaysDraw=false` ，那么它只会在单位位于空中时绘制，这也影响 `GroundLine` 的绘制。
- If `GroundLine=true` , the game will draw a line from techno's
position to its vertical projection, `GroundLine.Dashed=true` means the
projection line is a dashed line.
- 若 `GroundLine=true` ，那么游戏将会绘制一条从单位的位置到其垂直投影的线，`GroundLine.Dashed=true`
意味着投影线为虚线。

In `rulesmd.ini`:
```ini
[SOMESELECTBOXTYPE] ; Select box Type name
GroundShape=                            ; filename with .shp extension
GroundPalette=palette.pal               ; filename with .pal extension
GroundFrames=                           ; List of integer, default 1,1,1 for infantry, 0,0,0 for vehicle and aircraft
GroundOffset=0,0                        ; integers - horizontal, vertical
Ground.AlwaysDraw=true             ; boolean
GroundLine=false                        ; boolean
GroundLineColor=0,255,0                 ; R, G, B
GroundLineColor.ConditionYellow=        ; R, G, B
GroundLineColor.ConditionRed=           ; R, G, B
GroundLine.Dashed=false                 ; boolean
```
![W@`N 6J
G9@UM4MURW`LFIF](https://github.com/user-attachments/assets/d446947f-4afc-444d-91ee-b4ed35d7d387)

---------

Co-authored-by: CrimRecya <[email protected]>

Author: NetsuNegi

CREDITS.md

@@ -417,6 +417,7 @@ This page lists all the individual contributions to the project by their author.
   - Fix the bug that damaged particle dont disappear after building has repaired by engineer
   - Display banner improvement
   - Electric/RadBeam trail for laser tails
+  - Ground line for select box
 - **Apollo** - Translucent SHP drawing patches
 - **ststl**:
   - Customizable `ShowTimer` priority of superweapons

YRpp

@@ -284,12 +284,16 @@ RealTimeTimers.Adaptive=false   ; boolean
 
 ### Select Box
 
+![selectbox](_static/images/selectbox.png)
+
 - Now you can use and customize select box for infantry, vehicle and aircraft. No select box for buildings in default case, but you still can specific for some building if you want.
   - `Frames` can be used to list frames of `Shape` file that'll be drawn as a select box when the TechnoType's health is at or below full health/the percentage defined in `[AudioVisual] -> ConditionYellow/ConditionRed`, respectively.
   - If `Grounded` set to true, the select box will be drawn on the ground below the TechnoType.
   - Select box's translucency setting can be adjusted via `Translucency`.
   - `VisibleToHouses` and `VisibleToHouses.Observer` can limit visibility to specific players.
   - `DrawAboveTechno` specific whether the select box will be drawn before drawing the TechnoType. If set to false, the select box can be obscured by the TechnoType, and the draw location will ignore `PixelSelectionBracketDelta`.
+  - You can now use `GroundShape` to specific a image which always draw on ground, it will only draw when techno is in air if set `Ground.AlwaysDraw=false`, this also affect on `GroundLine`.
+  - If `GroundLine=true` , the game will draw a line from techno's position to its vertical projection, `GroundLine.Dashed=true` means the projection line is a dashed line.
 
 In `rulesmd.ini`:
 ```ini
@@ -304,12 +308,21 @@ DefaultUnitSelectBox=                   ; Select box for vehicle and aircraft
 Shape=select.shp                        ; filename with .shp extension
 Palette=palette.pal                     ; filename with .pal extension
 Frames=                                 ; List of integer, default 1,1,1 for infantry, 0,0,0 for vehicle and aircraft
-Grounded=false                          ; boolean
 Offset=0,0                              ; integers - horizontal, vertical
 Translucency=0                          ; translucency level (0/25/50/75)
 VisibleToHouses=all                     ; Affected House Enumeration (none|owner/self|allies/ally|team|enemies/enemy|all)
 VisibleToHouses.Observer=true           ; boolean
 DrawAboveTechno=true                    ; boolean
+GroundShape=                              ; filename with .shp extension
+GroundPalette=palette.pal               ; filename with .pal extension
+GroundFrames=                           ; List of integer, default 1,1,1 for infantry, 0,0,0 for vehicle and aircraft
+GroundOffset=0,0                    ; integers - horizontal, vertical
+Ground.AlwaysDraw=true              ; boolean
+GroundLine=false                                ; boolean
+GroundLineColor=0,255,0                     ; R, G, B
+GroundLineColor.ConditionYellow=           ; R, G, B
+GroundLineColor.ConditionRed=               ; R, G, B
+GroundLine.Dashed=false                 ; boolean
 
 [SOMETECHNO]                            ; TechnoType
 SelectBox=                              ; Select box

docs/User-Interface.md

@@ -406,8 +406,12 @@ New:
 - [Display banner](AI-Scripting-and-Mapping.md#display-banner) (by Morton & ststl)
 - [Allows refineries to use multiple ActiveAnim simultaneously](Fixed-or-Improved-Logics.md#allows-refineries-to-use-multiple-activeanim-simultaneously) (by TaranDahl)
 - Electric/RadBeam trail for laser tails (by NetsuNegi)
+<<<<<<< HEAD
+- Ground line for select box (by NetsuNegi)
+=======
 - Add `DebrisMinimums` to keep the count of debris within a certain range (by CrimRecya)
 - Several attackmove related enhancement (by TaranDahl)
+>>>>>>> upstream/develop
 
 Vanilla fixes:
 - Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)

docs/Whats-New.md

@@ -350,50 +350,63 @@ void TechnoExt::DrawSelectBox(TechnoClass* pThis, const Point2D* pLocation, cons
 	if (!pSelectBox || pSelectBox->DrawAboveTechno == drawBefore)
 		return;
 
-	const auto pShape = pSelectBox->Shape.Get();
-
-	if (!pShape)
-		return;
-
 	const bool canSee = HouseClass::IsCurrentPlayerObserver() ? pSelectBox->VisibleToHouses_Observer : EnumFunctions::CanTargetHouse(pSelectBox->VisibleToHouses, pThis->Owner, HouseClass::CurrentPlayer);
 
 	if (!canSee)
 		return;
 
-	const auto pPalette = pSelectBox->Palette.GetOrDefaultConvert(FileSystem::PALETTE_PAL);
-
 	const double healthPercentage = pThis->GetHealthPercentage();
-	const Vector3D<int> frames = pSelectBox->Frames.Get(whatAmI == AbstractType::Infantry ? CoordStruct { 1,1,1 } : CoordStruct { 0,0,0 });
-	const int frame = healthPercentage > RulesClass::Instance->ConditionYellow ? frames.X : healthPercentage > RulesClass::Instance->ConditionRed ? frames.Y : frames.Z;
+	const auto defaultFrame = whatAmI == InfantryClass::AbsID ? Vector3D<int> { 1, 1, 1 } : Vector3D<int> { 0, 0, 0 };
 
-	Point2D drawPoint = *pLocation;
+	const auto pSurface = DSurface::Temp;
+	const auto flags = (drawBefore ? BlitterFlags::Flat | BlitterFlags::Alpha : BlitterFlags::Nonzero | BlitterFlags::MultiPass) | BlitterFlags::Centered | pSelectBox->Translucency;
+	const int zAdjust = drawBefore ? pThis->GetZAdjustment() - 2 : 0;
+	const auto pGroundShape = pSelectBox->GroundShape.Get();
 
-	if (pSelectBox->Grounded && whatAmI != BuildingClass::AbsID)
+	if ((pGroundShape || pSelectBox->GroundLine) && whatAmI != BuildingClass::AbsID && (pSelectBox->Ground_AlwaysDraw || pThis->IsInAir()))
 	{
 		CoordStruct coords = pThis->GetCenterCoords();
 		coords.Z = MapClass::Instance.GetCellFloorHeight(coords);
+		auto [point, visible] = TacticalClass::Instance->CoordsToClient(coords);
 
-		const auto& [outClient, visible] = TacticalClass::Instance->CoordsToClient(coords);
+		if (visible && pGroundShape)
+		{
+			const auto pPalette = pSelectBox->GroundPalette.GetOrDefaultConvert(FileSystem::PALETTE_PAL);
 
-		if (!visible)
-			return;
+			const Vector3D<int> frames = pSelectBox->GroundFrames.Get(defaultFrame);
+			const int frame = healthPercentage > RulesClass::Instance->ConditionYellow ? frames.X : healthPercentage > RulesClass::Instance->ConditionRed ? frames.Y : frames.Z;
+
+			const Point2D drawPoint = point + pSelectBox->GroundOffset;
+			pSurface->DrawSHP(pPalette, pGroundShape, frame, &drawPoint, pBounds, flags, 0, zAdjust, ZGradient::Ground, 1000, 0, nullptr, 0, 0, 0);
+		}
 
-		drawPoint = outClient;
+		if (pSelectBox->GroundLine)
+		{
+			Point2D start = *pLocation; // Copy to prevent be modified
+			const int color = Drawing::RGB_To_Int(pSelectBox->GroundLineColor.Get(healthPercentage));
+
+			if (pSelectBox->GroundLine_Dashed)
+				pSurface->DrawDashed(&start, &point, color, 0);
+			else
+				pSurface->DrawLine(&start, &point, color);
+		}
 	}
 
-	drawPoint += pSelectBox->Offset;
+	if (const auto pShape = pSelectBox->Shape.Get())
+	{
+		const auto pPalette = pSelectBox->Palette.GetOrDefaultConvert(FileSystem::PALETTE_PAL);
 
-	if (pSelectBox->DrawAboveTechno)
-		drawPoint.Y += pType->PixelSelectionBracketDelta;
+		const Vector3D<int> frames = pSelectBox->Frames.Get(defaultFrame);
+		const int frame = healthPercentage > RulesClass::Instance->ConditionYellow ? frames.X : healthPercentage > RulesClass::Instance->ConditionRed ? frames.Y : frames.Z;
 
-	if (whatAmI == AbstractType::Infantry)
-		drawPoint += { 8, -3 };
-	else
-		drawPoint += { 1, -4 };
+		const Point2D offset = whatAmI == InfantryClass::AbsID ? Point2D { 8, -3 } : Point2D { 1, -4 };
+		Point2D drawPoint = *pLocation + offset + pSelectBox->Offset;
 
-	const auto flags = BlitterFlags::Centered | BlitterFlags::Nonzero | BlitterFlags::MultiPass | pSelectBox->Translucency;
+		if (pSelectBox->DrawAboveTechno)
+			drawPoint.Y += pType->PixelSelectionBracketDelta;
 
-	DSurface::Composite->DrawSHP(pPalette, pShape, frame, &drawPoint, pBounds, flags, 0, 0, ZGradient::Ground, 1000, 0, nullptr, 0, 0, 0);
+		pSurface->DrawSHP(pPalette, pShape, frame, &drawPoint, pBounds, flags, 0, zAdjust, ZGradient::Ground, 1000, 0, nullptr, 0, 0, 0);
+	}
 }
 
 void TechnoExt::ProcessDigitalDisplays(TechnoClass* pThis)

docs/_static/images/selectbox.png

@@ -18,12 +18,19 @@ void SelectBoxTypeClass::LoadFromINI(CCINIClass* pINI)
 	this->Shape.Read(exINI, pSection, "Shape");
 	this->Palette.LoadFromINI(pINI, pSection, "Palette");
 	this->Frames.Read(exINI, pSection, "Frames");
-	this->Grounded.Read(exINI, pSection, "Grounded");
 	this->Offset.Read(exINI, pSection, "Offset");
 	this->Translucency.Read(exINI, pSection, "Translucency");
 	this->VisibleToHouses.Read(exINI, pSection, "VisibleToHouses");
 	this->VisibleToHouses_Observer.Read(exINI, pSection, "VisibleToHouses.Observer");
 	this->DrawAboveTechno.Read(exINI, pSection, "DrawAboveTechno");
+	this->GroundShape.Read(exINI, pSection, "GroundShape");
+	this->GroundPalette.LoadFromINI(pINI, pSection, "GroundPalette");
+	this->GroundFrames.Read(exINI, pSection, "GroundFrames");
+	this->GroundOffset.Read(exINI, pSection, "GroundOffset");
+	this->Ground_AlwaysDraw.Read(exINI, pSection, "Ground.AlwaysDraw");
+	this->GroundLine.Read(exINI, pSection, "GroundLine");
+	this->GroundLineColor.Read(exINI, pSection, "GroundLineColor.%s");
+	this->GroundLine_Dashed.Read(exINI, pSection, "GroundLine.Dashed");
 }
 
 template <typename T>
@@ -33,12 +40,19 @@ void SelectBoxTypeClass::Serialize(T& Stm)
 		.Process(this->Shape)
 		.Process(this->Palette)
 		.Process(this->Frames)
-		.Process(this->Grounded)
 		.Process(this->Offset)
 		.Process(this->Translucency)
 		.Process(this->VisibleToHouses)
 		.Process(this->VisibleToHouses_Observer)
 		.Process(this->DrawAboveTechno)
+		.Process(this->GroundShape)
+		.Process(this->GroundPalette)
+		.Process(this->GroundFrames)
+		.Process(this->GroundOffset)
+		.Process(this->Ground_AlwaysDraw)
+		.Process(this->GroundLine)
+		.Process(this->GroundLineColor)
+		.Process(this->GroundLine_Dashed)
 		;
 }
 

src/Ext/Techno/Body.Visuals.cpp

@@ -10,23 +10,37 @@ class SelectBoxTypeClass final : public Enumerable<SelectBoxTypeClass>
 	Valueable<SHPStruct*> Shape;
 	CustomPalette Palette;
 	Nullable<Vector3D<int>> Frames;
-	Valueable<bool> Grounded;
 	Valueable<Point2D> Offset;
 	TranslucencyLevel Translucency;
 	Valueable<AffectedHouse> VisibleToHouses;
 	Valueable<bool> VisibleToHouses_Observer;
 	Valueable<bool> DrawAboveTechno;
+	Valueable<SHPStruct*> GroundShape;
+	CustomPalette GroundPalette;
+	Nullable<Vector3D<int>> GroundFrames;
+	Valueable<Point2D> GroundOffset;
+	Valueable<bool> Ground_AlwaysDraw;
+	Valueable<bool> GroundLine;
+	Damageable<ColorStruct> GroundLineColor;
+	Valueable<bool> GroundLine_Dashed;
 
 	SelectBoxTypeClass(const char* pTitle = NONE_STR) : Enumerable<SelectBoxTypeClass>(pTitle)
 		, Shape { FileSystem::LoadSHPFile("select.shp") }
 		, Palette {}
 		, Frames {}
-		, Grounded { false }
 		, Offset { Point2D::Empty }
 		, Translucency { 0 }
 		, VisibleToHouses { AffectedHouse::All }
 		, VisibleToHouses_Observer { true }
 		, DrawAboveTechno { true }
+		, GroundShape { nullptr }
+		, GroundPalette {}
+		, GroundFrames {}
+		, GroundOffset { Point2D::Empty }
+		, Ground_AlwaysDraw { true }
+		, GroundLine { false }
+		, GroundLineColor { { 0,255,0 } }
+		, GroundLine_Dashed { false}
 	{ }
 
 	void LoadFromINI(CCINIClass* pINI);