refactor(userpreferences): Merge UserPreferences and related code

Author: xezon

Generals/Code/GameEngine/Include/Common/GlobalData.h

@@ -110,6 +110,7 @@ class GlobalData : public SubsystemInterface
 	Bool m_useTrees;
 	Bool m_useTreeSway;
 	Bool m_useDrawModuleLOD;
+	Bool m_useHeatEffects;
 	Bool m_useFpsLimit;
 	Bool m_dumpAssetUsage;
 	Int m_framesPerSecondLimit;
@@ -138,6 +139,8 @@ class GlobalData : public SubsystemInterface
 	Bool m_enableStaticLOD;
 	Int m_terrainLODTargetTimeMS;
 	Bool m_useAlternateMouse;
+	Bool m_clientRetaliationModeEnabled;
+	Bool m_doubleClickAttackMove;
 	Bool m_rightMouseAlwaysScrolls;
 	Bool m_useWaterPlane;
 	Bool m_useCloudPlane;

Generals/Code/GameEngine/Include/Common/PlayerTemplate.h

@@ -125,6 +125,7 @@ class PlayerTemplate
 
 	AsciiString getLoadScreenMusic( void ) const {return m_loadScreenMusic;	}
 
+  Bool isOldFaction( void ) const { return m_oldFaction; }
 
 	static const FieldParse* getFieldParse();
 
@@ -162,6 +163,7 @@ class PlayerTemplate
 	AsciiString				m_tooltip;								///< The tooltip describing this player template
 	Bool							m_observer;
 	Bool							m_playableSide;
+  Bool              m_oldFaction;                       ///< Faction existed in the original Generals
 
 	Int								m_intrinsicSPP;
 

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

@@ -91,6 +91,8 @@ class OptionPreferences : public UserPreferences
 	void setOnlineIPAddress(UnsignedInt IP);	// convenience function
 	Bool getArchiveReplaysEnabled() const;		// convenience function
 	Bool getAlternateMouseModeEnabled(void);	// convenience function
+	Bool getRetaliationModeEnabled();					// convenience function
+	Bool getDoubleClickAttackMoveEnabled(void);	// convenience function
 	Real getScrollFactor(void);								// convenience function
 	Bool getDrawScrollAnchor(void);
 	Bool getMoveScrollAnchor(void);
@@ -130,6 +132,7 @@ class OptionPreferences : public UserPreferences
 	Bool getSmoothWaterEnabled(void);
 	Bool getTreesEnabled(void);
 	Bool getExtraAnimationsDisabled(void);
+	Bool getUseHeatEffects(void);
 	Bool getDynamicLODEnabled(void);
 	Bool getFPSLimitEnabled(void);
 	Bool getNoDynamicLODEnabled(void);

Generals/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -311,7 +311,7 @@ GlobalData* GlobalData::m_theOriginal = nullptr;
 	{ "MaxTranslucentObjects",						INI::parseInt,				nullptr,			offsetof( GlobalData, m_maxVisibleTranslucentObjects) },
 	{ "OccludedColorLuminanceScale",				INI::parseReal,				nullptr,			offsetof( GlobalData, m_occludedLuminanceScale) },
 
-/* These are internal use only, they do not need file definitons
+/* These are internal use only, they do not need file definitions
 	{ "TerrainAmbientRGB",				INI::parseRGBColor,		nullptr,			offsetof( GlobalData, m_terrainAmbient ) },
 	{ "TerrainDiffuseRGB",				INI::parseRGBColor,		nullptr,			offsetof( GlobalData, m_terrainDiffuse ) },
 	{ "TerrainLightPos",					INI::parseCoord3D,		nullptr,			offsetof( GlobalData, m_terrainLightPos ) },
@@ -331,7 +331,7 @@ GlobalData* GlobalData::m_theOriginal = nullptr;
 	{ "VideoOn",										INI::parseBool,				nullptr,			offsetof( GlobalData, m_videoOn ) },
 	{ "DisableCameraMovements",			INI::parseBool,				nullptr,			offsetof( GlobalData, m_disableCameraMovement ) },
 
-/* These are internal use only, they do not need file definitons
+/* These are internal use only, they do not need file definitions
 	/// @todo remove this hack
 	{ "InGame",											INI::parseBool,				nullptr,			offsetof( GlobalData, m_inGame ) },
 */
@@ -365,7 +365,7 @@ GlobalData* GlobalData::m_theOriginal = nullptr;
 	{ "AutoAflameParticleSystem",					INI::parseAsciiString,  nullptr,  offsetof( GlobalData, m_autoAflameParticleSystem ) },
 	{ "AutoAflameParticleMax",						INI::parseInt,					nullptr,	 offsetof( GlobalData, m_autoAflameParticleMax ) },
 
-/* These are internal use only, they do not need file definitons
+/* These are internal use only, they do not need file definitions
 	{ "LatencyAverage",							INI::parseInt,				nullptr,			offsetof( GlobalData, m_latencyAverage ) },
 	{ "LatencyAmplitude",						INI::parseInt,				nullptr,			offsetof( GlobalData, m_latencyAmplitude ) },
 	{ "LatencyPeriod",							INI::parseInt,				nullptr,			offsetof( GlobalData, m_latencyPeriod ) },
@@ -621,6 +621,7 @@ GlobalData::GlobalData()
 	m_useTrees = 0;
 	m_useTreeSway = TRUE;
 	m_useDrawModuleLOD = FALSE;
+	m_useHeatEffects = TRUE;
 	m_useFpsLimit = FALSE;
 	m_dumpAssetUsage = FALSE;
 	m_framesPerSecondLimit = 0;
@@ -1027,6 +1028,8 @@ GlobalData::GlobalData()
 
 	m_keyboardCameraRotateSpeed = 0.1f;
 
+	m_clientRetaliationModeEnabled = TRUE; //On by default.
+
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -1182,7 +1185,9 @@ void GlobalData::parseGameDataDefinition( INI* ini )
 
 	// override INI values with user preferences
 	OptionPreferences optionPref;
- 	TheWritableGlobalData->m_useAlternateMouse = optionPref.getAlternateMouseModeEnabled();
+	TheWritableGlobalData->m_useAlternateMouse = optionPref.getAlternateMouseModeEnabled();
+	TheWritableGlobalData->m_clientRetaliationModeEnabled = optionPref.getRetaliationModeEnabled();
+	TheWritableGlobalData->m_doubleClickAttackMove = optionPref.getDoubleClickAttackMoveEnabled();
 	TheWritableGlobalData->m_keyboardScrollFactor = optionPref.getScrollFactor();
 	TheWritableGlobalData->m_drawScrollAnchor = optionPref.getDrawScrollAnchor();
 	TheWritableGlobalData->m_moveScrollAnchor = optionPref.getMoveScrollAnchor();

Generals/Code/GameEngine/Source/Common/RTS/PlayerTemplate.cpp

@@ -94,6 +94,7 @@
 		{ "SpecialPowerShortcutWinName"		,INI::parseAsciiString,													nullptr, offsetof( PlayerTemplate, m_specialPowerShortcutWinName) },
 		{ "SpecialPowerShortcutButtonCount",INI::parseInt,												nullptr, offsetof( PlayerTemplate, m_specialPowerShortcutButtonCount ) },
 		{ "IsObserver",								INI::parseBool,																	nullptr, offsetof( PlayerTemplate, m_observer ) },
+    { "OldFaction",               INI::parseBool,                                 nullptr, offsetof( PlayerTemplate, m_oldFaction ) },
 		{ "IntrinsicSciencePurchasePoints",				INI::parseInt,												nullptr, offsetof( PlayerTemplate, m_intrinsicSPP ) },
 		{ "ScoreScreenImage",					INI::parseAsciiString,													nullptr, offsetof( PlayerTemplate, m_scoreScreenImage ) },
 		{ "LoadScreenImage",					INI::parseAsciiString,													nullptr, offsetof( PlayerTemplate, m_loadScreenImage ) },
@@ -183,6 +184,7 @@ PlayerTemplate::PlayerTemplate() :
 	m_nameKey(NAMEKEY_INVALID),
 	m_observer(false),
 	m_playableSide(false),
+  m_oldFaction(false),
 	m_intrinsicSPP(0),
 	m_specialPowerShortcutButtonCount(0)
 {

Generals/Code/GameEngine/Source/Common/UserPreferences.cpp

@@ -48,6 +48,7 @@
 #include "Common/QuotedPrintable.h"
 #include "Common/MultiplayerSettings.h"
 #include "GameClient/MapUtil.h"
+#include "GameClient/ChallengeGenerals.h"
 #include "GameNetwork/GameSpy/PeerDefs.h"
 
 
@@ -529,6 +530,18 @@ Int CustomMatchPreferences::getPreferredFaction(void)
 			ret = PLAYERTEMPLATE_RANDOM;
 		else if (fac->getStartingBuilding().isEmpty())
 			ret = PLAYERTEMPLATE_RANDOM;
+		else if (TheGameInfo && TheGameInfo->oldFactionsOnly() && !fac->isOldFaction())
+			ret = PLAYERTEMPLATE_RANDOM;
+		else {
+			// Prevent from loading the disabled Generals, in case you had previously selected one as your preferred faction.
+			// This is also enforced at GUI setup (GUIUtil.cpp and GameLogic.cpp).
+			// @todo: unlock these when something rad happens
+			Bool disallowLockedGenerals = TRUE;
+			const GeneralPersona *general = TheChallengeGenerals->getGeneralByTemplateName(fac->getName());
+			Bool startsLocked = general ? !general->isStartingEnabled() : FALSE;
+			if (disallowLockedGenerals && startsLocked)
+				ret = PLAYERTEMPLATE_RANDOM;
+		}
 	}
 
 	return ret;
@@ -650,19 +663,22 @@ AsciiString CustomMatchPreferences::getPreferredMap(void)
 	AsciiString ret;
 	CustomMatchPreferences::const_iterator it = find("Map");
 	if (it == end())
-	{
-		ret = getDefaultMap(TRUE);
+	{	//map not found, use default instead
+		ret = getDefaultOfficialMap();
 		return ret;
 	}
 
 	ret = QuotedPrintableToAsciiString(it->second);
 	ret.trim();
 	if (ret.isEmpty() || !isValidMap(ret, TRUE))
-	{
-		ret = getDefaultMap(TRUE);
+	{	//map is invalid, use default instead
+		ret = getDefaultOfficialMap();
 		return ret;
 	}
 
+	//can only use official maps if recording stats
+	if( getUseStats() && !isOfficialMap(ret) )
+		ret = getDefaultOfficialMap();
 	return ret;
 }
 

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

@@ -330,6 +330,29 @@ Bool OptionPreferences::getAlternateMouseModeEnabled(void)
 	return FALSE;
 }
 
+Bool OptionPreferences::getRetaliationModeEnabled(void)
+{
+	OptionPreferences::const_iterator it = find("Retaliation");
+	if (it == end())
+		return TheGlobalData->m_clientRetaliationModeEnabled;
+
+	if (stricmp(it->second.str(), "yes") == 0) {
+		return TRUE;
+	}
+	return FALSE;
+}
+
+Bool OptionPreferences::getDoubleClickAttackMoveEnabled(void)
+{
+	OptionPreferences::const_iterator it = find("UseDoubleClickAttackMove");
+	if( it == end() )
+		return TheGlobalData->m_doubleClickAttackMove;
+
+	if( stricmp( it->second.str(), "yes" ) == 0 )
+		return TRUE;
+
+	return FALSE;
+}
 
 Real OptionPreferences::getScrollFactor(void)
 {
@@ -729,6 +752,18 @@ Bool OptionPreferences::getExtraAnimationsDisabled(void)
 	return TRUE;
 }
 
+Bool OptionPreferences::getUseHeatEffects(void)
+{
+	OptionPreferences::const_iterator it = find("HeatEffects");
+	if (it == end())
+		return TheGlobalData->m_useHeatEffects;
+
+	if (stricmp(it->second.str(), "yes") == 0) {
+		return TRUE;
+	}
+	return FALSE;
+}
+
 Bool OptionPreferences::getDynamicLODEnabled(void)
 {
 	OptionPreferences::const_iterator it = find("DynamicLOD");

GeneralsMD/Code/GameEngine/Source/Common/UserPreferences.cpp

@@ -663,7 +663,7 @@ AsciiString CustomMatchPreferences::getPreferredMap(void)
 	AsciiString ret;
 	CustomMatchPreferences::const_iterator it = find("Map");
 	if (it == end())
-	{	//found find map, use default instead
+	{	//map not found, use default instead
 		ret = getDefaultOfficialMap();
 		return ret;
 	}
@@ -814,6 +814,7 @@ Int GameSpyMiscPreferences::getMaxMessagesPerUpdate( void )
 {
 	return getInt("MaxMessagesPerUpdate", 100);
 }
+
 //-----------------------------------------------------------------------------
 // IgnorePreferences base class
 //-----------------------------------------------------------------------------