bugfix(saveload): Restore retail compatibility for Generals save games by Caball009 · Pull Request #3406 · TheSuperHackers/GeneralsGameCode

Caball009 · 2026-10-03T11:14:16Z

Closes Loading a retail save game is broken in generals. #3211
Follow up for [GEN] Change ObjectStatusMaskType, UpgradeMaskType to BitFlags like in Zero Hour #613
Follow up for unify(controlbar): Merge ControlBar and related code from Zero Hour #2655

This PR fixes two issues that broke retail compatibility for Generals save games.

#613 unconditionally bumped the xfer version from 7 to 8, which broke save games created by our client for retail.
#2655 added 3 disabled types to the DisabledType enum as a backport from Zero Hour. This increased DisabledType::DISABLED_COUNT and impacted the xfer logic for Object::m_disabledTillFrame. This broke loading retail save games with our client.

It seems reasonable to (re)use xfer version 8 for both fixes since previous save games created by our clients are not compatible with retail so they might as well be unsupported from here on out.

TODO:

Replicate to Zero Hour?

coderabbitai · 2026-10-03T11:14:53Z

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: f28d7349-6969-4ad0-98f6-f1fbfa7e5f7d

📥 Commits

Reviewing files that changed from the base of the PR and between b362c44 and 5a45bac.

📒 Files selected for processing (1)

Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Walkthrough

Object::xfer selects version 7 for retail-compatible saves and version 8 otherwise. For versions below 8, it serializes status flags using the legacy 29-bit representation. For versions 7 and below, it uses the legacy disabled-frame layout.

Changes

Save Compatibility

Layer / File(s)	Summary
Status flag compatibility `Generals/Code/GameEngine/Include/Common/BitFlags.h`, `Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp`	`BitFlags::size()` is now static and constexpr, and returns `NUMBITS`. For pre-version-8 status data, `Object::xfer` masks the serialized value to the lower 29 bits and converts only those bits.
Transfer version and timer serialization `Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp`	`Object::xfer` selects version 7 for retail-compatible saves and version 8 otherwise. For versions 7 and below, it serializes the first eight disabled-frame entries and entries 11 and 12. Later versions serialize the full array.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix · Severity of issue fixed: Medium

Suggested reviewers: omaraglan

Merge Risk: 🟡 Moderate · up to 5a45b

Retail-compatible saves can write invalid object status and change the live object; loading a legacy save can also retain an incorrect status. Fix both paths before merging.

Architecture Summary

Architecture risk: 🔵 Low · up to 5a45b

The change affects 1 system.

Changed systems: Generals

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

observed — Generals (service) was modified; 2 changed files map to changed impact.

Before / after behavior

observed — Modified behavior in Generals/Code/GameEngine/Include/Common/BitFlags.h: BitFlags::size() is now static and constexpr, returning NUMBITS instead of the wrapped bitset’s runtime size.
observed — Modified behavior in Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp: Object::xfer now documents status and disabled-frame serialization changes and selects version 7 for RETAIL_COMPATIBLE_XFER_SAVE, retaining version 8 otherwise; previously the version was always 8.
observed — Modified behavior in Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp: For pre-version-8 status conversion, the code now asserts the expected 29 original status bits plus 16 additional types, masks the serialized value to the lower 29 bits, and converts only those 29 bits. Previously it converted all 32 bits without masking, potentially interpreting unused Generals bits as statuses.
observed — Modified behavior in Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp: For versions 7 and below, Object::xfer now transfers the first eight disabled-frame entries and entries 11 and 12 separately, leaving the intervening Zero Hour-only entries out of the legacy format. Newer versions transfer the full array; previously every version transferred the entire array.

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Issue `#3211` requires retail save loading in Generals. `Object::xfer` uses version 7 when `RETAIL_COMPATIBLE_XFER_SAVE` is enabled. For versions below 8, it transfers the original 29 status bits and th…
Out of Scope Changes check	✅ Passed	The `Object::xfer` changes restore legacy save serialization for issue `#3211`. The `BitFlags::size()` change supports the compile-time assertion for the Generals status-bit count. No unrelated changes …
Title check	✅ Passed	The title clearly summarizes the main change: restoring retail compatibility for Generals save games.
Description check	✅ Passed	The description explains the save-game compatibility issues and the fixes addressed by this pull request.

Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

greptile-apps · 2026-10-03T11:17:40Z

Confidence Score: 5/5

[Critical risk] Changes save game serialization format for a shipped game.

The PR appears safe to merge; no new actionable issue was found.

Summary

The PR restores retail-compatible Generals save transfers by writing object version 7 where configured, mapping object status bits, and preserving the retail disabled-state layout. Since the previous review, only explanatory comments changed.

_{Reviews (8) · Last reviewed commit: "Addressed feedback (3)."}

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: 2f8b57be-1908-4c17-9179-d0f2687c49b7

📥 Commits

Reviewing files that changed from the base of the PR and between 2817000 and 04cfa29.

📒 Files selected for processing (1)

Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: efcf6888-4fab-40e8-81db-7df9a38bdeca

📥 Commits

Reviewing files that changed from the base of the PR and between 04cfa29 and b362c44.

📒 Files selected for processing (2)

Generals/Code/GameEngine/Include/Common/BitFlags.h
Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.

…us'.

…ame).

xezon

Implementation looks very complicated.

xezon

Looking much better now

xezon

What a mess

xezon · 2026-10-03T20:49:43Z

Need to copy to ZH I think

Caball009 added Bug Something is not working right, typically is user facing Major Severity: Minor < Major < Critical < Blocker Gen Relates to Generals ThisProject The issue was introduced by this project, or this task is specific to this project Saveload Is Saveload/Xfer related labels Oct 3, 2026

greptile-apps Bot reviewed Oct 3, 2026

View reviewed changes

Comment thread Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp Outdated

coderabbitai Bot reviewed Oct 3, 2026

View reviewed changes

Comment thread Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp

Caball009 marked this pull request as draft October 3, 2026 11:21

Caball009 force-pushed the Caball009/restore_gen_save_game_compatibility branch from 04cfa29 to b362c44 Compare October 3, 2026 11:51

coderabbitai Bot reviewed Oct 3, 2026

View reviewed changes

Comment thread Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp Outdated

Caball009 force-pushed the Caball009/restore_gen_save_game_compatibility branch 2 times, most recently from 167ab9b to 5a45bac Compare October 3, 2026 12:04

Caball009 marked this pull request as ready for review October 3, 2026 12:11

greptile-apps Bot reviewed Oct 3, 2026

View reviewed changes

Comment thread Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp Outdated

Caball009 added 2 commits October 3, 2026 15:56

bugfix(saveload): Fix the unconditional xfer version bump for 'm_stat…

5cfb8a9

…us'.

bugfix(saveload): Fix changes to the disabled types (m_disabledTillFr…

b7be39f

…ame).

Caball009 force-pushed the Caball009/restore_gen_save_game_compatibility branch from 5a45bac to b7be39f Compare October 3, 2026 13:57

xezon reviewed Oct 3, 2026

View reviewed changes

Caball009 force-pushed the Caball009/restore_gen_save_game_compatibility branch from c9ff2f6 to 9269923 Compare October 3, 2026 15:21

Addressed feedback (1).

9269923

xezon reviewed Oct 3, 2026

View reviewed changes

Comment thread Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp

Comment thread Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp Outdated

xezon reviewed Oct 3, 2026

View reviewed changes

Comment thread Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp

Caball009 force-pushed the Caball009/restore_gen_save_game_compatibility branch from 9be6200 to ea8a75d Compare October 3, 2026 15:49

Caball009 added 2 commits October 3, 2026 17:49

Addressed feedback (2).

ea8a75d

Addressed feedback (3).

55e3570

xezon approved these changes Oct 3, 2026

View reviewed changes

Conversation

Caball009 commented Oct 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODO:

Uh oh!

coderabbitai Bot commented Oct 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Architecture Summary

Uh oh!

greptile-apps Bot commented Oct 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Confidence Score: 5/5

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

xezon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xezon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xezon left a comment

Choose a reason for hiding this comment

Uh oh!

xezon commented Oct 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Caball009 commented Oct 3, 2026 •

edited

Loading

coderabbitai Bot commented Oct 3, 2026 •

edited

Loading

greptile-apps Bot commented Oct 3, 2026 •

edited

Loading