Fix static ghost behaviours #1831

saurtron · 2024-12-18T11:43:38Z

Work done

Add leavesRadarGhost unitdef
- defaults to true for IsBuilderUnits
- controls what units leave static ghosts behind
Add staticRadarGhost unit attribute
- defaults to unitDef->leavesRadarGhost
- per unit toggle for static radar ghosts
- lua Get/SetUnitStaticRadarGhost allows changing this at any time
- controls:
  - radar wobbling when under radar
  - leaving static ghosts when out of radar or los
- leaves a dead ghost behind when staticRadarGhost gets disabled and the unit had a static ghost, this way no information is leaked about unit whereabouts (only if 3rd parameter to SetUnitStaticRadarGhost set to true).
  - this allows immobile units hopping on transports and looking like they're still there

Related issues

Conturrets are mobile units (?) Beyond-All-Reason#3617
Fixes radar wobbling for units with leavesGhost true
Fixes static radar ghosts being available just for buildings
Fixes ghost behavior for transported units

Remarks

This approach allows control of which units leave static live/dead ghosts, and also disabling the ghosts behavior when the unit is put in a transport for example
Dead ghost icons fixed at separate PR: Add dead ghost icons #1887
Could rename gameSetup->ghostedBuildings to staticGhosts (and export/accept also ghostedBuildings alias for now).
Could rename live/deadGhostBuildings to live/deadStaticGhosts since it's not special for buildings now.
- maybe change these at a different PR to not complicate this further

Pending

Fix ghosts not being generated when losing radar coverage of an area.
- not sure this is possible as part of this pr
- might need some mechanism to facilitate drawing helpers (like defenseranges) for ghosts
  - atm this isn't handled properly at least in bar, not sure about zk or engine
    - ex: when an llt moves the range stays with the ghost, and then, if the llt new pos is spotted it won't draw a range

Reference

IsImmobileUnit -> (pathType == -1U && !canfly && speed <= 0.0f)
IsBuildingUnit -> (IsImmobileUnit() && !yardmap.empty())
IsGroundUnit   -> (pathType != -1U && !canfly)

sprunk · 2024-12-18T23:03:39Z

This just forces immobiles to have ghosts while leaving games no control. Add a new unit def tag, bool leavesBuildingGhost, and make ghosts look for that.

That tag should default to true for buildings and false for mobiles, but I dug a bit and I'm no longer sure whether that new tag should default to true for immobiles. See 30c07c5, e573bdb, and https://springrts.com/mantis/view.php?id=6127.

…ehind. - Defaults to true for buildings

sprunk · 2025-01-09T01:25:45Z

Would be nice to split this into two PRs: small one adding the boolean tag, and the big refactor + fixing minimap icons.

…abled.

saurtron · 2025-01-09T09:30:12Z

Would be nice to split this into two PRs: small one adding the boolean tag, and the big refactor + fixing minimap icons.

done, see #1887

- Also rename lua methods accordingly.

unitdef initially.

…GhostChanged.

sprunk · 2025-01-12T03:13:34Z

rts/Lua/LuaSyncedCtrl.cpp

+	if (prevValue != unit->leavesGhost)
+		unitDrawer->UnitLeavesGhostChanged(unit, luaL_optboolean(L, 3, false));


These two lines should probably be part of unit->SetLeavesGhost since otherwise unit drawer can fail to be notified of a change.

sprunk · 2025-01-12T03:14:27Z

rts/Lua/LuaSyncedRead.cpp

+ */
+int LuaSyncedRead::GetUnitLeavesGhost(lua_State* L)
+{
+	const CUnit* const unit = ParseAllyUnit(L, __func__, 1);


Should probably be allowed for enemy units too, since that is whose ghosts you're interested in.

rts/Rendering/Units/UnitDrawerData.cpp

sprunk · 2025-01-12T03:15:55Z

rts/Sim/Units/Unit.cpp

@@ -555,7 +562,7 @@ float3 CUnit::GetErrorVector(int argAllyTeam) const
 	const int atSightMask = losStatus[argAllyTeam];

 	const int isVisible = 2 * ((atSightMask & LOS_INLOS  ) != 0 ||                  teamHandler.Ally(argAllyTeam, allyteam)); // in LOS or allied, no error
-	const int seenGhost = 4 * ((atSightMask & LOS_PREVLOS) != 0 && gameSetup->ghostedBuildings && unitDef->IsBuildingUnit()); // seen ghosted building, no error
+	const int seenGhost = 4 * ((atSightMask & LOS_PREVLOS) != 0 && leavesGhost); // seen ghosted immobiles, no error


Ghosts are no longer tied to being an immobile.

Suggested change

const int seenGhost = 4 * ((atSightMask & LOS_PREVLOS) != 0 && leavesGhost); // seen ghosted immobiles, no error

const int seenGhost = 4 * ((atSightMask & LOS_PREVLOS) != 0 && leavesGhost); // seen ghost, no error

Unsure about this, since this is just for ghosts of "generally immobile" units.

At least I don't see how this kind of ghosts could have a meaning in the game unless the unit has some kind of "generally immobile" assumption, even if it can sometimes be broken, like when a building is moved with some exception like being transported.

Mobile ones have a different kind of ghost.

Can you point to the different kind of ghost for mobiles? Maybe handling for the two could be combined somehow.

actually, looks like the mobile ones don't get drawn by engine itself, for bar it looks like it goes through unit_ghostradar_gl4.

actually, looks like the mobile ones don't get drawn by engine itself, for bar it looks like it goes through unit_ghostradar_gl4.

I suspect they could use the same path liveGhostBuildings are using tho, they probably doing it for nothing

sprunk · 2025-01-12T03:20:33Z

rts/Lua/LuaSyncedCtrl.cpp

+ *
+ * @number unitID
+ * @bool leavesGhost
+ * @bool[opt] leaveDeadGhost leave a dead ghost behind if disabling and the unit had a live static ghost.


It would be good if leaving a dead ghost was a standalone function. That way SetUnitLeavesGhost is atomic and you can leave dead ghosts around in other circumstances at will.

Co-authored-by: sprunk <spr.ng@o2.pl>

Make all immobiles have no radar drift.

6da976c

saurtron added 3 commits December 21, 2024 13:21

Apply same ghosting behavior for immobiles and buildings.

9dc230f

Add unitDef->leavesRadarGhost to control units leaving radar ghosts b…

29f3458

…ehind. - Defaults to true for buildings

Add unit->staticRadarGhost to control radar ghosts having no drift.

f3ea435

saurtron force-pushed the no-drift-for-immobiles branch from bfe5b71 to f3ea435 Compare January 7, 2025 13:17

saurtron added 2 commits January 7, 2025 16:21

Update building ghosts when unit->staticRadarGhost changes.

fa85dd5

Small refactor of UpdateGhosts and rename to UpdateUnitGhosts.

7197698

saurtron changed the title ~~Make all immobiles have no radar drift.~~ Fix static ghost behaviours Jan 8, 2025

Make leaving dead ghosts behind optional when staticRadarGhost is dis…

fcbb300

…abled.

saurtron force-pushed the no-drift-for-immobiles branch from f956649 to fcbb300 Compare January 9, 2025 09:27

saurtron mentioned this pull request Jan 9, 2025

Add dead ghost icons #1887

Open

saurtron added 7 commits January 9, 2025 10:45

Check unit->staticRadarGhost instead of unitDef inside UnitEnteredLos.

7e905e0

Rename unitDef.leavesRadarGhost, unit.staticRadarGhost to leavesGhost.

e15c580

- Also rename lua methods accordingly.

Allow unit->leaveGhost to be set also for units who didn't have it at

d3120da

unitdef initially.

Rename SetLeavesGhost parameter to newLeavesGhost.

a8a0c80

Improve documentation for SetUnitLeavesGhost.

493cba2

Rename UnitDrawer and UnitDrawerData SetUnitLeavesGhost to UnitLeaves…

0ec0141

…GhostChanged.

Just check gameSetup->ghostedBuildings when setting unit.leavesGhost.

afd9a07

saurtron force-pushed the no-drift-for-immobiles branch from 3a18651 to bb41bc9 Compare January 9, 2025 10:40

saurtron marked this pull request as ready for review January 9, 2025 11:00

saurtron force-pushed the no-drift-for-immobiles branch from bb41bc9 to afd9a07 Compare January 9, 2025 12:38

sprunk reviewed Jan 12, 2025

View reviewed changes

Avoid uneeded check for PREVLOS before clearing it

f046206

Co-authored-by: sprunk <spr.ng@o2.pl>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix static ghost behaviours #1831

Fix static ghost behaviours #1831

saurtron commented Dec 18, 2024 •

edited

Loading

sprunk commented Dec 18, 2024 •

edited

Loading

sprunk commented Jan 9, 2025

saurtron commented Jan 9, 2025

sprunk Jan 12, 2025

sprunk Jan 12, 2025

sprunk Jan 12, 2025

saurtron Jan 12, 2025

sprunk Jan 12, 2025

saurtron Jan 12, 2025

saurtron Jan 12, 2025 •

edited

Loading

sprunk Jan 12, 2025

		if (prevValue != unit->leavesGhost)
		unitDrawer->UnitLeavesGhostChanged(unit, luaL_optboolean(L, 3, false));

	const int seenGhost = 4 * ((atSightMask & LOS_PREVLOS) != 0 && leavesGhost); // seen ghosted immobiles, no error
	const int seenGhost = 4 * ((atSightMask & LOS_PREVLOS) != 0 && leavesGhost); // seen ghost, no error

Fix static ghost behaviours #1831

Are you sure you want to change the base?

Fix static ghost behaviours #1831

Conversation

saurtron commented Dec 18, 2024 • edited Loading

Work done

Related issues

Remarks

Pending

Reference

sprunk commented Dec 18, 2024 • edited Loading

sprunk commented Jan 9, 2025

saurtron commented Jan 9, 2025

sprunk Jan 12, 2025

Choose a reason for hiding this comment

sprunk Jan 12, 2025

Choose a reason for hiding this comment

sprunk Jan 12, 2025

Choose a reason for hiding this comment

saurtron Jan 12, 2025

Choose a reason for hiding this comment

sprunk Jan 12, 2025

Choose a reason for hiding this comment

saurtron Jan 12, 2025

Choose a reason for hiding this comment

saurtron Jan 12, 2025 • edited Loading

Choose a reason for hiding this comment

sprunk Jan 12, 2025

Choose a reason for hiding this comment

saurtron commented Dec 18, 2024 •

edited

Loading

sprunk commented Dec 18, 2024 •

edited

Loading

saurtron Jan 12, 2025 •

edited

Loading