Skip to content

perf(fps): optimize Object::isHero with cached hero counter #1841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bobtista wants to merge 11 commits into
base: main
Choose a base branch
from
Open

perf(fps): optimize Object::isHero with cached hero counter #1841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f789849
perf(fps): optimize Object::isHero with cached hero counter
bobtista Nov 13, 2025
29bc6b0
build: wrap isHero optimization behind RETAIL_COMPATIBLE_CRC flag
bobtista Nov 13, 2025
1435034
fix(game): call TransportContain::onContaining once in RiderChangeCon…
bobtista Dec 15, 2025
bf1c4bb
remove crc retail flag, add Xfer handling
bobtista Dec 15, 2025
df4e579
perf(fps): move hero counter updates to match stealth counter pattern"
bobtista Dec 15, 2025
8e2f067
perf(fps): use assert for hero count check in removeFromContainViaIte…
bobtista Dec 19, 2025
200e0f6
perf(fps): add xfer versioning for cached hero count with retail comp…
bobtista Dec 19, 2025
464efc8
perf(fps): restore hero count in loadPostProcess for retail compatibi…
bobtista Dec 19, 2025
d979f92
perf(fps): use assert for hero count check in removeFromContainList
bobtista Dec 19, 2025
e8ae78b
perf(fps): add xfer versioning for cached hero count with retail comp…
bobtista Dec 19, 2025
df0caad
perf(fps): restore hero count in loadPostProcess for retail compatibi…
bobtista Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Generals/Code/GameEngine/Include/GameLogic/Module/ContainModule.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ class ContainModuleInterface
virtual const Object *friend_getRider() const = 0; ///< Damn. The draw order dependency bug for riders means that our draw module needs to cheat to get around it.
virtual Real getContainedItemsMass() const = 0;
virtual UnsignedInt getStealthUnitsContained() const = 0;
virtual UnsignedInt getHeroUnitsContained() const = 0;

virtual Bool calcBestGarrisonPosition( Coord3D *sourcePos, const Coord3D *targetPos ) = 0;
virtual Bool attemptBestFirePointPosition( Object *source, Weapon *weapon, Object *victim ) = 0;
Expand Down
2 changes: 2 additions & 0 deletions Generals/Code/GameEngine/Include/GameLogic/Module/OpenContain.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ class OpenContain : public UpdateModule,
virtual const Object *friend_getRider() const{return NULL;} ///< Damn. The draw order dependency bug for riders means that our draw module needs to cheat to get around it.
virtual Real getContainedItemsMass() const;
virtual UnsignedInt getStealthUnitsContained() const { return m_stealthUnitsContained; }
virtual UnsignedInt getHeroUnitsContained() const { return m_heroUnitsContained; }

virtual PlayerMaskType getPlayerWhoEntered(void) const { return m_playerEnteredMask; }

Expand Down Expand Up @@ -238,6 +239,7 @@ class OpenContain : public UpdateModule,

ObjectEnterExitMap m_objectEnterExitInfo;
UnsignedInt m_stealthUnitsContained; ///< number of stealth units that can't be seen by enemy players.
UnsignedInt m_heroUnitsContained; ///< cached hero count
Int m_whichExitPath; ///< Cycles from 1 to n and is used only in modules whose data has numberOfExitPaths > 1.
UnsignedInt m_doorCloseCountdown; ///< When should I shut my door.

Expand Down
51 changes: 48 additions & 3 deletions Generals/Code/GameEngine/Source/GameLogic/Object/Contain/OpenContain.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ OpenContain::OpenContain( Thing *thing, const ModuleData* moduleData ) : UpdateM
m_lastLoadSoundFrame = 0;
m_containListSize = 0;
m_stealthUnitsContained = 0;
m_heroUnitsContained = 0;
m_doorCloseCountdown = 0;

m_rallyPoint.zero();
Expand Down Expand Up @@ -352,6 +353,10 @@ void OpenContain::addToContainList( Object *rider )
{
m_stealthUnitsContained++;
}
if( rider->isKindOf( KINDOF_HERO ) )
{
m_heroUnitsContained++;
}
}

//-------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -542,6 +547,11 @@ void OpenContain::removeFromContainViaIterator( ContainedItemsList::iterator it,
}
}
}
if( rider->isKindOf( KINDOF_HERO ) )
{
DEBUG_ASSERTCRASH( m_heroUnitsContained > 0, ("Removing hero but hero count is 0") );
Copy link

@xezon xezon Dec 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Text is not quite accurate:

"OpenContain::removeFromContainViaIterator - Removing hero but hero count is %d", m_heroUnitsContained

Could add the same assert to stealth units above.

m_heroUnitsContained--;
}


if (isEnclosingContainerFor( rider ))
Expand Down Expand Up @@ -620,7 +630,7 @@ void OpenContain::scatterToNearbyPosition(Object* rider)
}

//-------------------------------------------------------------------------------------------------
void OpenContain::onContaining( Object * /*rider*/ )
void OpenContain::onContaining( Object *rider )
{
// Play audio
if( m_loadSoundsEnabled )
Expand Down Expand Up @@ -1442,13 +1452,18 @@ void OpenContain::crc( Xfer *xfer )
// ------------------------------------------------------------------------------------------------
/** Xfer method
* Version Info:
* 1: Initial version */
* 1: Initial version
* 2: Added m_heroUnitsContained cached hero count (bobtista) */
Copy link

@xezon xezon Dec 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TheSuperHackers @tweak Serialize hero units contained count

Do not use trailing (bobtista) because this is not part of our comment convention for authors.

Can put */ in new line.

// ------------------------------------------------------------------------------------------------
void OpenContain::xfer( Xfer *xfer )
{

// version
const XferVersion currentVersion = 1;
#if RETAIL_COMPATIBLE_XFER_SAVE
XferVersion currentVersion = 1;
#else
XferVersion currentVersion = 2;
#endif
XferVersion version = currentVersion;
xfer->xferVersion( &version, currentVersion );

Expand Down Expand Up @@ -1526,6 +1541,24 @@ void OpenContain::xfer( Xfer *xfer )
// stealth units contained
xfer->xferUnsignedInt( &m_stealthUnitsContained );

// hero units contained
#if !RETAIL_COMPATIBLE_XFER_SAVE
if (version >= 2)
{
xfer->xferUnsignedInt( &m_heroUnitsContained );
}
else if (xfer->getXferMode() == XFER_LOAD)
{
m_heroUnitsContained = 0;
}
#else
// In retail compatibility mode, hero count is restored by iterating hero objects in loadPostProcess
if (xfer->getXferMode() == XFER_LOAD)
{
m_heroUnitsContained = 0;
}
#endif
Copy link

@xezon xezon Dec 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole block looks overengineered. Can it be simplifed to just

	if (version >= 2)
	{
		xfer->xferUnsignedInt( &m_heroUnitsContained );
	}

?


// door close countdown
xfer->xferUnsignedInt( &m_doorCloseCountdown );

Expand Down Expand Up @@ -1658,6 +1691,18 @@ void OpenContain::loadPostProcess( void )

}

#if RETAIL_COMPATIBLE_XFER_SAVE
Copy link

@xezon xezon Dec 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use same technique as in #2024 for particle cannon to condition it.

// In retail compatibility mode, restore hero count by iterating hero objects
m_heroUnitsContained = 0;
for( ContainedItemsList::const_iterator it = m_containList.begin(); it != m_containList.end(); ++it )
{
if( (*it)->isKindOf( KINDOF_HERO ) )
{
m_heroUnitsContained++;
}
}
#endif

// sanity
DEBUG_ASSERTCRASH( m_containListSize == m_containList.size(),
("OpenContain::loadPostProcess - contain list count mismatch") );
Expand Down
16 changes: 2 additions & 14 deletions Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,25 +593,13 @@ Object::~Object()
}

//-------------------------------------------------------------------------------------------------
void localIsHero( Object *obj, void* userData )
{
Bool *hero = (Bool*)userData;

if( obj && obj->isKindOf( KINDOF_HERO ) )
{
*hero = TRUE;
}
}

//-------------------------------------------------------------------------------------------------
// TheSuperHackers @performance bobtista 13/11/2025 Use cached hero count for O(1) lookup instead of O(n) iteration.
Bool Object::isHero() const
{
ContainModuleInterface *contain = getContain();
if( contain )
{
Bool heroInside = FALSE;
contain->iterateContained( localIsHero, (void*)(&heroInside), FALSE );
if( heroInside )
if( contain->getHeroUnitsContained() > 0 )
{
return TRUE;
}
Expand Down
1 change: 1 addition & 0 deletions GeneralsMD/Code/GameEngine/Include/GameLogic/Module/ContainModule.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ class ContainModuleInterface
virtual const Object *friend_getRider() const = 0; ///< Damn. The draw order dependency bug for riders means that our draw module needs to cheat to get around it.
virtual Real getContainedItemsMass() const = 0;
virtual UnsignedInt getStealthUnitsContained() const = 0;
virtual UnsignedInt getHeroUnitsContained() const = 0;

virtual Bool calcBestGarrisonPosition( Coord3D *sourcePos, const Coord3D *targetPos ) = 0;
virtual Bool attemptBestFirePointPosition( Object *source, Weapon *weapon, Object *victim ) = 0;
Expand Down
2 changes: 2 additions & 0 deletions GeneralsMD/Code/GameEngine/Include/GameLogic/Module/OpenContain.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ class OpenContain : public UpdateModule,
virtual const Object *friend_getRider() const{return NULL;} ///< Damn. The draw order dependency bug for riders means that our draw module needs to cheat to get around it.
virtual Real getContainedItemsMass() const;
virtual UnsignedInt getStealthUnitsContained() const { return m_stealthUnitsContained; }
virtual UnsignedInt getHeroUnitsContained() const { return m_heroUnitsContained; }

virtual PlayerMaskType getPlayerWhoEntered(void) const { return m_playerEnteredMask; }

Expand Down Expand Up @@ -259,6 +260,7 @@ class OpenContain : public UpdateModule,

ObjectEnterExitMap m_objectEnterExitInfo;
UnsignedInt m_stealthUnitsContained; ///< number of stealth units that can't be seen by enemy players.
UnsignedInt m_heroUnitsContained; ///< cached hero count
Int m_whichExitPath; ///< Cycles from 1 to n and is used only in modules whose data has numberOfExitPaths > 1.
UnsignedInt m_doorCloseCountdown; ///< When should I shut my door.

Expand Down
50 changes: 48 additions & 2 deletions GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Contain/OpenContain.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ OpenContain::OpenContain( Thing *thing, const ModuleData* moduleData ) : UpdateM
m_lastLoadSoundFrame = 0;
m_containListSize = 0;
m_stealthUnitsContained = 0;
m_heroUnitsContained = 0;
m_doorCloseCountdown = 0;

m_rallyPoint.zero();
Expand Down Expand Up @@ -374,6 +375,10 @@ void OpenContain::addToContainList( Object *rider )
{
m_stealthUnitsContained++;
}
if( rider->isKindOf( KINDOF_HERO ) )
{
m_heroUnitsContained++;
}
}

//-------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -660,6 +665,11 @@ void OpenContain::removeFromContainViaIterator( ContainedItemsList::iterator it,
}
}
}
if( rider->isKindOf( KINDOF_HERO ) )
{
DEBUG_ASSERTCRASH( m_heroUnitsContained > 0, ("Removing hero but hero count is 0") );
m_heroUnitsContained--;
}


if (isEnclosingContainerFor( rider ))
Expand Down Expand Up @@ -1667,13 +1677,19 @@ void OpenContain::crc( Xfer *xfer )
// ------------------------------------------------------------------------------------------------
/** Xfer method
* Version Info:
* 1: Initial version */
* 1: Initial version
* 2: Added m_passengerAllowedToFire
* 3: Added m_heroUnitsContained cached hero count (bobtista) */
// ------------------------------------------------------------------------------------------------
void OpenContain::xfer( Xfer *xfer )
{

// version
const XferVersion currentVersion = 2;
#if RETAIL_COMPATIBLE_XFER_SAVE
XferVersion currentVersion = 2;
#else
XferVersion currentVersion = 3;
#endif
XferVersion version = currentVersion;
xfer->xferVersion( &version, currentVersion );

Expand Down Expand Up @@ -1751,6 +1767,24 @@ void OpenContain::xfer( Xfer *xfer )
// stealth units contained
xfer->xferUnsignedInt( &m_stealthUnitsContained );

// hero units contained
#if !RETAIL_COMPATIBLE_XFER_SAVE
if (version >= 3)
{
xfer->xferUnsignedInt( &m_heroUnitsContained );
}
else if (xfer->getXferMode() == XFER_LOAD)
{
m_heroUnitsContained = 0;
}
#else
// In retail compatibility mode, hero count is restored by iterating hero objects in loadPostProcess
if (xfer->getXferMode() == XFER_LOAD)
{
m_heroUnitsContained = 0;
}
#endif

// door close countdown
xfer->xferUnsignedInt( &m_doorCloseCountdown );

Expand Down Expand Up @@ -1890,6 +1924,18 @@ void OpenContain::loadPostProcess( void )

}

#if RETAIL_COMPATIBLE_XFER_SAVE
// In retail compatibility mode, restore hero count by iterating hero objects
m_heroUnitsContained = 0;
for( ContainedItemsList::const_iterator it = m_containList.begin(); it != m_containList.end(); ++it )
{
if( (*it)->isKindOf( KINDOF_HERO ) )
{
m_heroUnitsContained++;
}
}
#endif

// sanity
DEBUG_ASSERTCRASH( m_containListSize == m_containList.size(),
("OpenContain::loadPostProcess - contain list count mismatch") );
Expand Down
15 changes: 2 additions & 13 deletions GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2042,25 +2042,14 @@ Bool Object::isNonFactionStructure(void) const
return isStructure() && !isFactionStructure();
}

void localIsHero( Object *obj, void* userData )
{
Bool *hero = (Bool*)userData;

if( obj && obj->isKindOf( KINDOF_HERO ) )
{
*hero = TRUE;
}
}

//-------------------------------------------------------------------------------------------------
// TheSuperHackers @performance bobtista 13/11/2025 Use cached hero count for O(1) lookup instead of O(n) iteration.
Bool Object::isHero(void) const
{
ContainModuleInterface *contain = getContain();
if( contain )
{
Bool heroInside = FALSE;
contain->iterateContained( localIsHero, (void*)(&heroInside), FALSE );
if( heroInside )
if( contain->getHeroUnitsContained() > 0 )
{
return TRUE;
}
Expand Down
Loading