fix(view): Implement state for user controlled camera to properly distinguish between scripted and user camera by xezon · Pull Request #2363 · TheSuperHackers/GeneralsGameCode

xezon · 2026-02-28T11:47:41Z

This change implements a new state for the user controlled camera to properly distinguish between scripted and user camera.

Originally, there is no 100% clear cut between user camera and scripted camera movements. To make a clear cut, all user input camera controls are now explicitly called through "user" functions that set a flag for the user controlled camera. This will be very relevant in later changes when different logic needs to apply in user and scripted camera, because the scripted camera is far more sensitive to changes and to preserve its original look there needs to be a very clear distinction.

The scripted camera state is set by doing one of the 5 scripted camera modes for waypoint path, pitch, zoom, angle and follow object.

m_viewLockedUntilFrame was changed to m_userControlLockedUntilFrame. m_viewLockedUntilFrame no longer worked correctly after #2280 and broke the Replay Player Camera, because the locked view then also applied to the Replay Player Camera, which of course was not intended. Instead, now user control functions are blocked only while the Replay Player Camera is active.

Known issues

USA01 intro cutscene is still broken (is fixed in future change)
Replay Player Camera has zoom issues when logic step is decoupled from render update (is fixed in future change)

TODO

Replicate to Generals

…tinguish between scripted and user camera

greptile-apps · 2026-02-28T12:02:35Z

Greptile Summary

This PR establishes a clear architectural distinction between user-controlled and scripted camera movements by introducing explicit state tracking and wrapper functions. All user input camera controls now route through user* wrapper functions (e.g., userLookAt, userSetAngle, userZoom) that set the m_isUserControlled flag and stop any active scripted camera movements. The scripted camera state is set when using waypoint paths, pitch/zoom/angle animations, or object following.

Key changes:

Renamed m_viewLockedUntilFrame to m_userControlLockedUntilFrame to specifically lock user input rather than all camera movement
Added m_isUserControlled boolean to track camera control source
Implemented template-based doUserAction() wrappers that check lock state, stop scripted camera, and set user control flag
Updated all user input paths across 12 files to use new wrapper functions
Fixed Replay Player Camera by using user control lock instead of view lock, allowing replay camera to function while blocking actual user input
Optimized scroll speed check by using squared length comparison (m_scrollAmountCutoffSqr)

Confidence Score: 5/5

This PR is safe to merge with minimal risk - it's a well-structured refactoring with consistent changes across all affected files
The refactoring follows a clear, consistent pattern across all 12 files. The template-based wrapper functions provide type-safe encapsulation of the user control logic. The previous issue with squared length comparison has been resolved. All user input code paths have been systematically updated to use the new wrapper functions, and the distinction between user and scripted camera is now architecturally sound.
No files require special attention

Important Files Changed

Filename	Overview
Core/GameEngine/Include/GameClient/View.h	Added user control wrapper functions (`userSetPosition`, `userSetAngle`, etc.) using templates, renamed `m_viewLockedUntilFrame` to `m_userControlLockedUntilFrame`, added `m_isUserControlled` flag for state tracking
Core/GameEngine/Source/GameClient/View.cpp	Implemented `isUserControlLocked()` check using frame comparison, updated initialization and reset logic for new user control state members
Core/GameEngineDevice/Source/W3DDevice/GameClient/W3DView.cpp	Main implementation: uses squared length comparison for scroll speed, handles user vs scripted camera state transitions, updated `reset()` to use direct setters, added logic to treat non-user-controlled camera as scripted movement
Core/Libraries/Include/Lib/BaseType.h	Added `lengthSqr()` helper method to `Coord2D` for efficient squared length calculation (avoids sqrt)
GeneralsMD/Code/GameEngine/Source/GameClient/MessageStream/LookAtXlat.cpp	Converted mouse-driven camera controls to user functions (`userSetAngle`, `userZoom`, `userScrollBy`), uses direct `scrollBy()` when resetting scroll to zero (non-user action)
GeneralsMD/Code/GameEngine/Source/GameLogic/System/GameLogicDispatch.cpp	Replay Player Camera now uses user functions to enable auto-zoom over terrain, changed lock function to `lockUserControlUntilFrame()`, added explicit scroll reset

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    Start([User Input: Camera Action]) --> CheckLock{isUserControlLocked?}
    CheckLock -->|Yes| Blocked[Return false - Action Blocked]
    CheckLock -->|No| StopScripted[stopDoingScriptedCamera]
    StopScripted --> SetFlag[setUserControlled = true]
    SetFlag --> Execute[Execute Camera Function]
    Execute --> Return[Return true - Action Completed]
    
    Script([Scripted Camera Action]) --> AddState[addScriptedState]
    AddState --> SetScripted[setUserControlled = false]
    SetScripted --> ScriptExecute[Execute Camera Function]
    
    Update([W3DView::update]) --> CheckUserControlled{m_isUserControlled?}
    CheckUserControlled -->|false| SetDidScripted[didScriptedMovement = true]
    CheckUserControlled -->|true| CheckScriptedState{isDoingScriptedCamera?}
    CheckScriptedState -->|true| SetDidScripted
    CheckScriptedState -->|false| Normal[Normal Height Adjustment]
    SetDidScripted --> PreserveHeight[Preserve Scripted Camera Height]

_{Last reviewed commit: 34f0439}

greptile-apps

_{12 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}