Refactor DataModule type flags - use an enum

Author: MaximDude

System/DataModule.cpp

@@ -11,7 +11,7 @@ namespace RTE {
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	void DataModule::Clear() {
-		m_IsUserdata = false;
+		m_ModuleType = DataModuleType::Unofficial;
 		m_FileName.clear();
 		m_FriendlyName.clear();
 		m_Author.clear();
@@ -56,7 +56,7 @@ namespace RTE {
 			size_t lastPeriodPosition = m_SupportedGameVersion.find_last_of(".");
 			std::string supportedMajorGameVersion = m_SupportedGameVersion.substr(0, lastPeriodPosition);
 			std::string supportedMinorGameVersion = lastPeriodPosition == std::string::npos ? ".0" : m_SupportedGameVersion.substr(lastPeriodPosition, m_SupportedGameVersion.length());
-			if (m_ModuleID >= g_ModuleMan.GetOfficialModuleCount() && !m_IsUserdata && (supportedMajorGameVersion != c_MajorGameVersion || supportedMinorGameVersion > c_MinorGameVersion)) {
+			if (m_ModuleType == DataModuleType::Unofficial && (supportedMajorGameVersion != c_MajorGameVersion || supportedMinorGameVersion > c_MinorGameVersion)) {
 				RTEAssert(!m_SupportedGameVersion.empty(), m_FileName + " does not specify a supported Cortex Command version, so it is not compatible with this version of Cortex Command (" + c_MajorGameVersion + c_MinorGameVersion + ").\nPlease contact the mod author or ask for help in the CCCP discord server.");
 				RTEAssert(supportedMinorGameVersion <= c_MinorGameVersion, m_FileName + " supports Cortex Command version " + m_SupportedGameVersion + ", which is ahead of this version of Cortex Command (" + c_MajorGameVersion + c_MinorGameVersion + ").\nPlease update your game to the newest version to use this mod.");
 				RTEAbort(m_FileName + " supports Cortex Command version " + m_SupportedGameVersion + ", so it is not compatible with this version of Cortex Command (" + c_MajorGameVersion + c_MinorGameVersion + ").\nPlease contact the mod author or ask for help in the CCCP discord server.");
@@ -78,7 +78,7 @@ namespace RTE {
 		std::string moduleNameWithPackageExtension = System::GetUserdataDirectory() + moduleName + (moduleName.ends_with(System::GetModulePackageExtension()) ? "" : System::GetModulePackageExtension());
 		if (Writer writer(moduleNameWithPackageExtension + "/Index.ini", false, true); writer.WriterOK()) {
 			DataModule newModule;
-			newModule.m_IsUserdata = true;
+			newModule.m_ModuleType = DataModuleType::Userdata;
 			newModule.m_FriendlyName = friendlyName;
 			newModule.m_IgnoreMissingItems = ignoreMissingItems;
 			newModule.m_ScanFolderContents = scanFolderContents;
@@ -201,7 +201,7 @@ namespace RTE {
 
 		writer.NewPropertyWithValue("ModuleName", m_FriendlyName);
 
-		if (!m_IsUserdata) {
+		if (!IsUserdata()) {
 			writer.NewPropertyWithValue("Author", m_Author);
 			writer.NewPropertyWithValue("Description", m_Description);
 			writer.NewPropertyWithValue("IsFaction", m_IsFaction);

System/DataModule.h

@@ -22,6 +22,15 @@ namespace RTE {
 		SerializableClassNameGetter;
 		SerializableOverrideMethods;
 
+		/// <summary>
+		/// Enumeration for the different types of DataModules.
+		/// </summary>
+		enum class DataModuleType {
+			Unofficial, // Mods and any other modules not shipped with the game.
+			Official,
+			Userdata // Userdata written by the game (e.g saved games or editor scenes) that should be ignored anywhere where that is relevant.
+		};
+
 		/// <summary>
 		/// Struct that holds data about the custom BuyMenu/ObjectPicker theme of this DataModule.
 		/// Themes are used when a DataModule is considered a faction and is selected to be played as in an Activity.
@@ -102,15 +111,16 @@ namespace RTE {
 
 #pragma region Module Information Getters
 		/// <summary>
-		/// Gets whether this DataModule is a userdata module.
+		/// Gets whether this DataModule is an official module.
 		/// </summary>
-		/// <returns>Whether this DataModule is used for userdata written by the game.</returns>
-		bool IsUserdata() const { return m_IsUserdata; }
+		/// <returns>Whether this DataModule is an official module.</returns>
+		bool IsOfficial() const { return m_ModuleType == DataModuleType::Official; }
 
 		/// <summary>
-		/// Sets this DataModule as a userdata module.
+		/// Gets whether this DataModule is a userdata module.
 		/// </summary>
-		void SetAsUserdata() { m_IsUserdata = true; }
+		/// <returns>Whether this DataModule is used for userdata written by the game.</returns>
+		bool IsUserdata() const { return m_ModuleType == DataModuleType::Userdata; }
 
 		/// <summary>
 		/// Gets the file name of this DataModule, e.g. "MyMod.rte".
@@ -309,7 +319,7 @@ namespace RTE {
 			std::string m_FileReadFrom; //!< Where the instance was read from.
 		};
 
-		bool m_IsUserdata; //!< Whether this DataModule contains userdata written by the game (e.g saved games or editor scenes), meaning it is not an official nor a 3rd party module and is ignored anywhere where that is relevant.
+		DataModuleType m_ModuleType; //!< The type of this DataModule. See DataModuleType enumeration.
 		bool m_ScanFolderContents; //!< Indicates whether module loader should scan for any .ini's inside module folder instead of loading files defined in IncludeFile only.
 		bool m_IgnoreMissingItems; //!< Indicates whether module loader should ignore missing items in this module.