VirtualRoomSetManager: Add Documentation

Author: Guantol-Lemat

repentogon/ImGuiFeatures/ConsoleMega.h

@@ -7,7 +7,7 @@
 #include "UnifontSupport.h"
 #include "Lang.h"
 #include "../REPENTOGONOptions.h"
-#include "../Patches/VirtualRoomSets.h"
+#include "../VirtualRoomConfig/VirtualRoomSetManager.h"
 
 #include <sstream>
 #include <cctype>

repentogon/LuaInterfaces/Room/LuaRoomConfig.cpp

@@ -2,7 +2,7 @@
 #include "Log.h"
 #include "LuaCore.h"
 #include "HookSystem.h"
-#include "../../Patches/VirtualRoomSets.h"
+#include "../../VirtualRoomConfig/VirtualRoomSetManager.h"
 
 /*LUA_FUNCTION(Lua_GameGetRoomConfig) {
 	Game* game = lua::GetRawUserdata<Game*>(L, 1, lua::Metatables::GAME, "Game");

repentogon/LuaInterfaces/Room/LuaRoomConfigSet.cpp

@@ -1,7 +1,7 @@
 #include "IsaacRepentance.h"
 #include "LuaCore.h"
 #include "HookSystem.h"
-#include "../../Patches/VirtualRoomSets.h"
+#include "../../VirtualRoomConfig/VirtualRoomSetManager.h"
 #include "LuaRoomConfigSet.h"
 
 LuaRoomConfigSet::Userdata::Userdata(RoomConfig_Stage& stage, int mode)

repentogon/LuaInterfaces/Room/LuaRoomConfigSet.h

@@ -1,5 +1,5 @@
 #include "LuaCore.h"
-#include "../../Patches/VirtualRoomSets.h"
+#include "../../VirtualRoomConfig/VirtualRoomSetManager.h"
 
 namespace LuaRoomConfigSet
 {

repentogon/LuaInterfaces/Room/LuaRoomConfigStage.cpp

@@ -1,7 +1,7 @@
 #include "IsaacRepentance.h"
 #include "LuaCore.h"
 #include "HookSystem.h"
-#include "../../Patches/VirtualRoomSets.h"
+#include "../../VirtualRoomConfig/VirtualRoomSetManager.h"
 #include "LuaRoomConfigSet.h"
 
 LUA_FUNCTION(Lua_RoomConfigStageGetBackdrop)

repentogon/Patches/GameStateManagement.cpp

@@ -5,7 +5,7 @@
 
 #include <filesystem>
 #include "ItemPoolManager.h"
-#include "VirtualRoomSets.h"
+#include "../VirtualRoomConfig/VirtualRoomSetManager.h"
 
 #include "../SaveStateManagement/EntitySaveStateManagement.h"
 

repentogon/Patches/VirtualRoomSets.cpp …tualRoomConfig/VirtualRoomSetManager.cpprepentogon/Patches/VirtualRoomSets.cpp renamed to repentogon/VirtualRoomConfig/VirtualRoomSetManager.cpp repentogon/Patches/VirtualRoomSets.cpp renamed to repentogon/VirtualRoomConfig/VirtualRoomSetManager.cpp

@@ -5,7 +5,7 @@
 #include "../RoomConfigUtility.h"
 #include "../LogUtility.h"
 #include "LuaCore.h"
-#include "GameStateManagement.h"
+#include "../Patches/GameStateManagement.h"
 
 #include <string>
 #include <vector>
@@ -45,21 +45,30 @@ class VirtualRoomSetManager
 		// The lua functions are placed here since they are just details for the LUA API
 		// rather than functionality of a VirtualRoomSet
 
+		/// @brief Adds the rooms stored in the passed table to the specified set.
+		/// Places the return table on the Lua stack.
+		/// @return number of return Lua values the function has pushed on the stack.
 		static int Lua_AddLuaRooms(lua_State* L, VirtualRoomSet& virtualSet, int tableIdx);
+		/// @brief Adds the rooms stored in the .stb to the specified set.
+		/// Places the return table on the Lua stack.
+		/// @param fileName is expected to correspond to file(s) found @ `<mod root>/content/rooms/<filename>`
+		/// @return number of return Lua values the function has pushed on the stack.
 		static int Lua_AddStbRooms(lua_State* L, VirtualRoomSet& virtualSet, const std::string& fileName);
 	};
 
 public:
 	/// @brief Gets the vanilla set extension, using the vanilla RoomSet id.
 	static VirtualRoomSet GetVanillaSet(uint32_t stageId, int mode);
 	/// @brief Creates a new room set.
-	static VirtualRoomSet CreateSet();
+	// static VirtualRoomSet CreateSet();
 };
 
 class VirtualRoomSet
 {
 	friend class VirtualRoomSetManager;
+
 	using _VirtualRoomSet = VirtualRoomSetManager::detail::_VirtualRoomSet;
+public:
 	using Iterator = _VirtualRoomSet::const_iterator;
 
 private: