Skip to content

bugfix(contain): Restore retail compatibility after changes to Object::m_containedByID #2868

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
Caball009 wants to merge 4 commits into
base: main
Choose a base branch
from
+63 −7
Open

bugfix(contain): Restore retail compatibility after changes to Object::m_containedByID #2868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6113c9
Refactored portable object.
Caball009 Jul 12, 2026
ae0d1be
Added code to set containedByID member variable.
Caball009 Jul 12, 2026
e82aace
Reset containedBy pointer and id on removal.
Caball009 Jul 12, 2026
5da1074
Tweaked older TSH comment.
Caball009 Jul 13, 2026
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
6 changes: 5 additions & 1 deletion GeneralsMD/Code/GameEngine/Include/GameLogic/Object.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,10 +449,14 @@ class Object : public Thing, public Snapshot
void onContainedBy( Object *containedBy );
void onRemovedFrom( Object *removedFrom );
Int getTransportSlotCount() const;
void friend_setContainedBy( Object *containedBy ) { m_containedBy = containedBy; }
void friend_setContainedBy( Object *containedBy );
const Object* getEnclosingContainedBy() const; ///< Find the first enclosing container in the containment chain.
const Object* getOuterObject() const; ///< Get the top-level object

#if RETAIL_COMPATIBLE_CRC
void friend_setContainedByID(ObjectID id) { m_containedByID = id; }
#endif

// Special Powers -------------------------------------------------------------------------------
SpecialPowerModuleInterface *getSpecialPowerModule( const SpecialPowerTemplate *specialPowerTemplate ) const;
void doSpecialPower( const SpecialPowerTemplate *specialPowerTemplate, UnsignedInt commandOptions, Bool forced = false ); ///< execute power
Expand Down
52 changes: 47 additions & 5 deletions GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Contain/HelixContain.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,10 +250,28 @@ void HelixContain::addToContainList( Object *obj )
if ( portable )
TheGameLogic->destroyObject( portable );

m_portableStructureID = obj->getID();
obj->friend_setContainedBy( getObject() );//fool portable into thinking my object is his container
portable = obj;

m_portableStructureID = portable->getID();
portable->friend_setContainedBy( getObject() );//fool portable into thinking my object is his container

#if RETAIL_COMPATIBLE_CRC
Object* containedBy = getObject();

// TheSuperHackers @info Set INVALID_ID if the container object was destroyed
// to indicate that the pointer will become a dangling pointer in the next frame.
if (containedBy && !containedBy->isDestroyed())
{
portable->friend_setContainedByID(containedBy->getID());
}
else
{
portable->friend_setContainedByID(INVALID_ID);
}
#else
DEBUG_ASSERTCRASH(getObject() == nullptr || !getObject()->isDestroyed(),
("HelixContain::addToContainList - Adding to a destroyed container"));
#endif
}
else
TransportContain::addToContainList( obj );
Expand All @@ -268,10 +286,28 @@ void HelixContain::addToContain( Object *obj )
if ( portable )
TheGameLogic->destroyObject( portable );

m_portableStructureID = obj->getID();
obj->friend_setContainedBy( getObject() );//fool portable into thinking my object is his container
portable = obj;

m_portableStructureID = portable->getID();
portable->friend_setContainedBy( getObject() );//fool portable into thinking my object is his container

#if RETAIL_COMPATIBLE_CRC
Object* containedBy = getObject();

// TheSuperHackers @info Set INVALID_ID if the container object was destroyed
// to indicate that the pointer will become a dangling pointer in the next frame.
if (containedBy && !containedBy->isDestroyed())
{
portable->friend_setContainedByID(containedBy->getID());
}
else
{
portable->friend_setContainedByID(INVALID_ID);
}
#else
DEBUG_ASSERTCRASH(getObject() == nullptr || !getObject()->isDestroyed(),
("HelixContain::addToContain - Adding to a destroyed container"));
#endif
}
else
TransportContain::addToContain( obj );
Expand All @@ -284,10 +320,16 @@ void HelixContain::removeFromContain( Object *obj, Bool exposeStealthUnits )
{
Object *portable = getPortableStructure();
if ( portable )
{
#if RETAIL_COMPATIBLE_CRC
portable->friend_setContainedByID(INVALID_ID);
#else
portable->friend_setContainedBy(nullptr);
#endif

m_portableStructureID = INVALID_ID;
//portable->kill();

}
Comment thread
greptile-apps[bot] marked this conversation as resolved.
}
else
{
Expand Down
12 changes: 11 additions & 1 deletion 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 @@ -749,6 +749,15 @@ Int Object::getTransportSlotCount() const
return count;
}

void Object::friend_setContainedBy(Object* containedBy)
{
m_containedBy = containedBy;

#if !RETAIL_COMPATIBLE_CRC
m_containedByFrame = containedBy ? TheGameLogic->getFrame() : 0;
#endif
}

const Object* Object::getEnclosingContainedBy() const
{
for (const Object* child = this, *container = getContainedBy(); container; child = container, container = container->getContainedBy())
Expand Down Expand Up @@ -4290,8 +4299,9 @@ void Object::xfer( Xfer *xfer )
// No, the contain module is just going to friend_ reach in and set this for us.
// Containers more complicated than Open (like Tunnel) can't do that. Our variable,
// our responsibility.
#if !RETAIL_COMPATIBLE_CRC
#if RETAIL_COMPATIBLE_CRC
// TheSuperHackers @tweak Contained by ID is already set with retail compatibility; don't overwrite it.
#else
if( xfer->getXferMode() == XFER_SAVE )
{
if( m_containedBy != nullptr )
Expand Down
Loading