Skip to content

Commit 36b5277

Browse files
xezonxezon
authored
feat(options): Implement user options for Screen Edge Scrolling (#1538)
Adds new options ScreenEdgeScrollEnabledInWindowedApp=no, ScreenEdgeScrollEnabledInFullscreenApp=yes to Options.ini
1 parent 55e6cd4 commit 36b5277

File tree

8 files changed

+200
-20
lines changed

8 files changed

+200
-20
lines changed

‎Generals/Code/GameEngine/Include/Common/UserPreferences.h‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
#include "Common/STLTypedefs.h"
4040

4141
enum CursorCaptureMode CPP_11(: Int);
42+
typedef UnsignedInt ScreenEdgeScrollMode;
4243

4344
//-----------------------------------------------------------------------------
4445
// PUBLIC TYPES ///////////////////////////////////////////////////////////////
@@ -95,6 +96,9 @@ class OptionPreferences : public UserPreferences
9596
Bool getDrawScrollAnchor(void);
9697
Bool getMoveScrollAnchor(void);
9798
CursorCaptureMode getCursorCaptureMode() const;
99+
Bool getScreenEdgeScrollEnabledInWindowedApp() const;
100+
Bool getScreenEdgeScrollEnabledInFullscreenApp() const;
101+
ScreenEdgeScrollMode getScreenEdgeScrollMode() const;
98102
Bool getSendDelay(void); // convenience function
99103
Int getFirewallBehavior(void); // convenience function
100104
Short getFirewallPortAllocationDelta(void); // convenience function

‎Generals/Code/GameEngine/Include/GameClient/LookAtXlat.h‎

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,30 @@
3232

3333
#include "GameClient/InGameUI.h"
3434

35+
//-----------------------------------------------------------------------------
36+
// TheSuperHackers @feature The Screen Edge Scrolling can now be enabled or
37+
// disabled depending on the App being Windowed or Fullscreen.
38+
typedef UnsignedInt ScreenEdgeScrollMode;
39+
enum ScreenEdgeScrollMode_ CPP_11(: ScreenEdgeScrollMode)
40+
{
41+
ScreenEdgeScrollMode_EnabledInWindowedApp = 1<<0, // Scroll when touching the edge while the app is windowed
42+
ScreenEdgeScrollMode_EnabledInFullscreenApp = 1<<1, // Scroll when touching the edge while the app is fullscreen
43+
44+
ScreenEdgeScrollMode_Default = ScreenEdgeScrollMode_EnabledInFullscreenApp, // Default based on original game behavior
45+
};
46+
3547
//-----------------------------------------------------------------------------
3648
class LookAtTranslator : public GameMessageTranslator
3749
{
3850
public:
3951
LookAtTranslator();
4052
~LookAtTranslator();
53+
4154
virtual GameMessageDisposition translateGameMessage(const GameMessage *msg);
4255
virtual const ICoord2D* getRMBScrollAnchor(void); // get m_anchor ICoord2D if we're RMB scrolling
4356
Bool hasMouseMovedRecently( void );
4457
void setCurrentPos( const ICoord2D& pos );
58+
void setScreenEdgeScrollMode(ScreenEdgeScrollMode mode);
4559

4660
void resetModes(); //Used when disabling input, so when we reenable it we aren't stuck in a mode.
4761

@@ -50,7 +64,7 @@ class LookAtTranslator : public GameMessageTranslator
5064
{
5165
MAX_VIEW_LOCS = 8
5266
};
53-
enum
67+
enum ScrollType
5468
{
5569
SCROLL_NONE = 0,
5670
SCROLL_RMB,
@@ -67,10 +81,13 @@ class LookAtTranslator : public GameMessageTranslator
6781
UnsignedInt m_timestamp; // set when button goes down
6882
DrawableID m_lastPlaneID;
6983
ViewLocation m_viewLocation[ MAX_VIEW_LOCS ];
70-
Int m_scrollType;
71-
void setScrolling( Int );
72-
void stopScrolling( void );
84+
ScrollType m_scrollType;
85+
ScreenEdgeScrollMode m_screenEdgeScrollMode;
7386
UnsignedInt m_lastMouseMoveFrame;
87+
88+
void setScrolling( ScrollType scrollType );
89+
void stopScrolling( void );
90+
Bool canScrollAtScreenEdge() const;
7491
};
7592

7693
extern LookAtTranslator *TheLookAtTranslator;

‎Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/OptionsMenu.cpp‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
#include "GameClient/ClientInstance.h"
4545
#include "GameClient/GameClient.h"
4646
#include "GameClient/InGameUI.h"
47+
#include "GameClient/LookAtXlat.h"
4748
#include "GameClient/WindowLayout.h"
4849
#include "GameClient/Gadget.h"
4950
#include "GameClient/GadgetCheckBox.h"
@@ -390,6 +391,38 @@ CursorCaptureMode OptionPreferences::getCursorCaptureMode() const
390391
return mode;
391392
}
392393

394+
Bool OptionPreferences::getScreenEdgeScrollEnabledInWindowedApp() const
395+
{
396+
OptionPreferences::const_iterator it = find("ScreenEdgeScrollEnabledInWindowedApp");
397+
if (it == end())
398+
return (ScreenEdgeScrollMode_Default & ScreenEdgeScrollMode_EnabledInWindowedApp) != 0;
399+
400+
if (stricmp(it->second.str(), "yes") == 0)
401+
return TRUE;
402+
403+
return FALSE;
404+
}
405+
406+
Bool OptionPreferences::getScreenEdgeScrollEnabledInFullscreenApp() const
407+
{
408+
OptionPreferences::const_iterator it = find("ScreenEdgeScrollEnabledInFullscreenApp");
409+
if (it == end())
410+
return (ScreenEdgeScrollMode_Default & ScreenEdgeScrollMode_EnabledInFullscreenApp) != 0;
411+
412+
if (stricmp(it->second.str(), "yes") == 0)
413+
return TRUE;
414+
415+
return FALSE;
416+
}
417+
418+
ScreenEdgeScrollMode OptionPreferences::getScreenEdgeScrollMode() const
419+
{
420+
ScreenEdgeScrollMode mode = 0;
421+
mode |= getScreenEdgeScrollEnabledInWindowedApp() ? ScreenEdgeScrollMode_EnabledInWindowedApp : 0;
422+
mode |= getScreenEdgeScrollEnabledInFullscreenApp() ? ScreenEdgeScrollMode_EnabledInFullscreenApp : 0;
423+
return mode;
424+
}
425+
393426
Bool OptionPreferences::usesSystemMapDir(void)
394427
{
395428
OptionPreferences::const_iterator it = find("UseSystemMapDir");
@@ -1191,6 +1224,14 @@ static void saveOptions( void )
11911224
TheMouse->setCursorCaptureMode(mode);
11921225
}
11931226

1227+
// TheSuperHackers @todo Add combo box ?
1228+
{
1229+
ScreenEdgeScrollMode mode = pref->getScreenEdgeScrollMode();
1230+
(*pref)["ScreenEdgeScrollEnabledInWindowedApp"] = (mode & ScreenEdgeScrollMode_EnabledInWindowedApp) ? "yes" : "no";
1231+
(*pref)["ScreenEdgeScrollEnabledInFullscreenApp"] = (mode & ScreenEdgeScrollMode_EnabledInFullscreenApp) ? "yes" : "no";
1232+
TheLookAtTranslator->setScreenEdgeScrollMode(mode);
1233+
}
1234+
11941235
//-------------------------------------------------------------------------------------------------
11951236
// scroll speed val
11961237
val = GadgetSliderGetPosition(sliderScrollSpeed);

‎Generals/Code/GameEngine/Source/GameClient/MessageStream/LookAtXlat.cpp‎

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
#include "Common/PlayerList.h"
3636
#include "Common/Recorder.h"
3737
#include "Common/StatsCollector.h"
38+
#include "Common/UserPreferences.h"
3839
#include "GameLogic/Object.h"
3940
#include "GameLogic/PartitionManager.h"
4041
#include "GameClient/Display.h"
@@ -80,7 +81,7 @@ static const Int edgeScrollSize = 3;
8081
static Mouse::MouseCursor prevCursor = Mouse::ARROW;
8182

8283
//-----------------------------------------------------------------------------
83-
void LookAtTranslator::setScrolling(Int x)
84+
void LookAtTranslator::setScrolling(ScrollType scrollType)
8485
{
8586
if (!TheInGameUI->getInputEnabled())
8687
return;
@@ -89,7 +90,7 @@ void LookAtTranslator::setScrolling(Int x)
8990
m_isScrolling = true;
9091
TheInGameUI->setScrolling( TRUE );
9192
TheTacticalView->setMouseLock( TRUE );
92-
m_scrollType = x;
93+
m_scrollType = scrollType;
9394
if(TheStatsCollector)
9495
TheStatsCollector->startScrollTime();
9596
}
@@ -103,12 +104,32 @@ void LookAtTranslator::stopScrolling( void )
103104
TheMouse->setCursor(prevCursor);
104105
m_scrollType = SCROLL_NONE;
105106

106-
// if we have a stats collectore increment the stats
107+
// increment the stats if we have a stats collector
107108
if(TheStatsCollector)
108109
TheStatsCollector->endScrollTime();
109110

110111
}
111112

113+
//-----------------------------------------------------------------------------
114+
Bool LookAtTranslator::canScrollAtScreenEdge() const
115+
{
116+
if (!TheMouse->isCursorCaptured())
117+
return false;
118+
119+
if (TheDisplay->getWindowed())
120+
{
121+
if ((m_screenEdgeScrollMode & ScreenEdgeScrollMode_EnabledInWindowedApp) == 0)
122+
return false;
123+
}
124+
else
125+
{
126+
if ((m_screenEdgeScrollMode & ScreenEdgeScrollMode_EnabledInFullscreenApp) == 0)
127+
return false;
128+
}
129+
130+
return true;
131+
}
132+
112133
//-----------------------------------------------------------------------------
113134
LookAtTranslator::LookAtTranslator() :
114135
m_isScrolling(false),
@@ -121,12 +142,15 @@ LookAtTranslator::LookAtTranslator() :
121142
m_scrollType(SCROLL_NONE)
122143
{
123144
//Added By Sadullah Nader
124-
//Initializations misssing and needed
145+
//Initializations missing and needed
125146
m_anchor.x = m_anchor.y = 0;
126147
m_currentPos.x = m_currentPos.y = 0;
127148
m_originalAnchor.x = m_originalAnchor.y = 0;
128149
//
129150

151+
OptionPreferences prefs;
152+
m_screenEdgeScrollMode = prefs.getScreenEdgeScrollMode();
153+
130154
DEBUG_ASSERTCRASH(!TheLookAtTranslator, ("Already have a LookAtTranslator - why do you need two?"));
131155
TheLookAtTranslator = this;
132156
}
@@ -163,6 +187,11 @@ void LookAtTranslator::setCurrentPos( const ICoord2D& pos )
163187
m_currentPos = pos;
164188
}
165189

190+
void LookAtTranslator::setScreenEdgeScrollMode(ScreenEdgeScrollMode mode)
191+
{
192+
m_screenEdgeScrollMode = mode;
193+
}
194+
166195
//-----------------------------------------------------------------------------
167196
/**
168197
* The LookAt Translator is responsible for camera movements. It is directly responsible for
@@ -308,8 +337,7 @@ GameMessageDisposition LookAtTranslator::translateGameMessage(const GameMessage
308337
break;
309338
}
310339

311-
// TheSuperHackers @tweak Ayumi/xezon 26/07/2025 Enables edge scrolling in windowed mode.
312-
if (TheMouse->isCursorCaptured())
340+
if (canScrollAtScreenEdge())
313341
{
314342
if (m_isScrolling)
315343
{

‎GeneralsMD/Code/GameEngine/Include/Common/UserPreferences.h‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040

4141
class Money;
4242
enum CursorCaptureMode CPP_11(: Int);
43+
typedef UnsignedInt ScreenEdgeScrollMode;
4344

4445
//-----------------------------------------------------------------------------
4546
// PUBLIC TYPES ///////////////////////////////////////////////////////////////
@@ -98,6 +99,9 @@ class OptionPreferences : public UserPreferences
9899
Bool getDrawScrollAnchor(void);
99100
Bool getMoveScrollAnchor(void);
100101
CursorCaptureMode getCursorCaptureMode() const;
102+
Bool getScreenEdgeScrollEnabledInWindowedApp() const;
103+
Bool getScreenEdgeScrollEnabledInFullscreenApp() const;
104+
ScreenEdgeScrollMode getScreenEdgeScrollMode() const;
101105
Bool getSendDelay(void); // convenience function
102106
Int getFirewallBehavior(void); // convenience function
103107
Short getFirewallPortAllocationDelta(void); // convenience function

‎GeneralsMD/Code/GameEngine/Include/GameClient/LookAtXlat.h‎

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,30 @@
3232

3333
#include "GameClient/InGameUI.h"
3434

35+
//-----------------------------------------------------------------------------
36+
// TheSuperHackers @feature The Screen Edge Scrolling can now be enabled or
37+
// disabled depending on the App being Windowed or Fullscreen.
38+
typedef UnsignedInt ScreenEdgeScrollMode;
39+
enum ScreenEdgeScrollMode_ CPP_11(: ScreenEdgeScrollMode)
40+
{
41+
ScreenEdgeScrollMode_EnabledInWindowedApp = 1<<0, // Scroll when touching the edge while the app is windowed
42+
ScreenEdgeScrollMode_EnabledInFullscreenApp = 1<<1, // Scroll when touching the edge while the app is fullscreen
43+
44+
ScreenEdgeScrollMode_Default = ScreenEdgeScrollMode_EnabledInFullscreenApp, // Default based on original game behavior
45+
};
46+
3547
//-----------------------------------------------------------------------------
3648
class LookAtTranslator : public GameMessageTranslator
3749
{
3850
public:
3951
LookAtTranslator();
4052
~LookAtTranslator();
53+
4154
virtual GameMessageDisposition translateGameMessage(const GameMessage *msg);
4255
virtual const ICoord2D* getRMBScrollAnchor(void); // get m_anchor ICoord2D if we're RMB scrolling
4356
Bool hasMouseMovedRecently( void );
4457
void setCurrentPos( const ICoord2D& pos );
58+
void setScreenEdgeScrollMode(ScreenEdgeScrollMode mode);
4559

4660
void resetModes(); //Used when disabling input, so when we reenable it we aren't stuck in a mode.
4761

@@ -50,7 +64,7 @@ class LookAtTranslator : public GameMessageTranslator
5064
{
5165
MAX_VIEW_LOCS = 8
5266
};
53-
enum
67+
enum ScrollType
5468
{
5569
SCROLL_NONE = 0,
5670
SCROLL_RMB,
@@ -67,10 +81,13 @@ class LookAtTranslator : public GameMessageTranslator
6781
UnsignedInt m_timestamp; // set when button goes down
6882
DrawableID m_lastPlaneID;
6983
ViewLocation m_viewLocation[ MAX_VIEW_LOCS ];
70-
Int m_scrollType;
71-
void setScrolling( Int );
72-
void stopScrolling( void );
84+
ScrollType m_scrollType;
85+
ScreenEdgeScrollMode m_screenEdgeScrollMode;
7386
UnsignedInt m_lastMouseMoveFrame;
87+
88+
void setScrolling( ScrollType scrollType );
89+
void stopScrolling( void );
90+
Bool canScrollAtScreenEdge() const;
7491
};
7592

7693
extern LookAtTranslator *TheLookAtTranslator;

‎GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/OptionsMenu.cpp‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
#include "GameClient/ClientInstance.h"
4545
#include "GameClient/GameClient.h"
4646
#include "GameClient/InGameUI.h"
47+
#include "GameClient/LookAtXlat.h"
4748
#include "GameClient/WindowLayout.h"
4849
#include "GameClient/Gadget.h"
4950
#include "GameClient/GadgetCheckBox.h"
@@ -422,6 +423,38 @@ CursorCaptureMode OptionPreferences::getCursorCaptureMode() const
422423
return mode;
423424
}
424425

426+
Bool OptionPreferences::getScreenEdgeScrollEnabledInWindowedApp() const
427+
{
428+
OptionPreferences::const_iterator it = find("ScreenEdgeScrollEnabledInWindowedApp");
429+
if (it == end())
430+
return (ScreenEdgeScrollMode_Default & ScreenEdgeScrollMode_EnabledInWindowedApp) != 0;
431+
432+
if (stricmp(it->second.str(), "yes") == 0)
433+
return TRUE;
434+
435+
return FALSE;
436+
}
437+
438+
Bool OptionPreferences::getScreenEdgeScrollEnabledInFullscreenApp() const
439+
{
440+
OptionPreferences::const_iterator it = find("ScreenEdgeScrollEnabledInFullscreenApp");
441+
if (it == end())
442+
return (ScreenEdgeScrollMode_Default & ScreenEdgeScrollMode_EnabledInFullscreenApp) != 0;
443+
444+
if (stricmp(it->second.str(), "yes") == 0)
445+
return TRUE;
446+
447+
return FALSE;
448+
}
449+
450+
ScreenEdgeScrollMode OptionPreferences::getScreenEdgeScrollMode() const
451+
{
452+
ScreenEdgeScrollMode mode = 0;
453+
mode |= getScreenEdgeScrollEnabledInWindowedApp() ? ScreenEdgeScrollMode_EnabledInWindowedApp : 0;
454+
mode |= getScreenEdgeScrollEnabledInFullscreenApp() ? ScreenEdgeScrollMode_EnabledInFullscreenApp : 0;
455+
return mode;
456+
}
457+
425458
Bool OptionPreferences::usesSystemMapDir(void)
426459
{
427460
OptionPreferences::const_iterator it = find("UseSystemMapDir");
@@ -1251,6 +1284,14 @@ static void saveOptions( void )
12511284
TheMouse->setCursorCaptureMode(mode);
12521285
}
12531286

1287+
// TheSuperHackers @todo Add combo box ?
1288+
{
1289+
ScreenEdgeScrollMode mode = pref->getScreenEdgeScrollMode();
1290+
(*pref)["ScreenEdgeScrollEnabledInWindowedApp"] = (mode & ScreenEdgeScrollMode_EnabledInWindowedApp) ? "yes" : "no";
1291+
(*pref)["ScreenEdgeScrollEnabledInFullscreenApp"] = (mode & ScreenEdgeScrollMode_EnabledInFullscreenApp) ? "yes" : "no";
1292+
TheLookAtTranslator->setScreenEdgeScrollMode(mode);
1293+
}
1294+
12541295
//-------------------------------------------------------------------------------------------------
12551296
// scroll speed val
12561297
val = GadgetSliderGetPosition(sliderScrollSpeed);

0 commit comments

Comments
 (0)