CRoom fixes for 2024.6

- Fixes CRoom misalignment for 2024.6+ runners
- Bumps version to 3.4.3

Author: Archie-osu

ExamplePlugin/include/YYToolkit/Shared.cpp

@@ -493,4 +493,33 @@ RValue* YYObjectBase::FindOrAllocValue(
 
 	return &this->InternalGetYYVarRef(variable_hash);
 }
+
+CRoomInternal& YYTK::CRoom::GetMembers()
+{
+	YYTKInterface* module_interface = GetYYTKInterface();
+
+	// Return the more likely thing.
+	if (!module_interface)
+		return this->WithBackgrounds.Internals;
+
+	size_t bg_color_idx = 0;
+	AurieStatus last_status = module_interface->GetBuiltinVariableIndex(
+		"background_color",
+		bg_color_idx
+	);
+
+	// This lookup will fail in newer runners where backgrounds were removed
+	if (!AurieSuccess(last_status))
+	{
+		// Note: We have to craft the pointer manually here, since
+		// bool alignment prevents us from just having a struct (it'd get aligned to sizeof(PVOID)).
+
+		// Don't ask why it's from m_Color and not from m_ShowColor, it doesn't make sense
+		// and I can't figure out why it works - it just does.
+		return *reinterpret_cast<CRoomInternal*>(&this->m_Color);
+	}
+
+	return this->WithBackgrounds.Internals;
+}
+
 #endif // YYTK_DEFINE_INTERNAL

ExamplePlugin/include/YYToolkit/Shared.hpp

@@ -9,7 +9,7 @@
 
 #define YYTK_MAJOR 3
 #define YYTK_MINOR 4
-#define YYTK_PATCH 0
+#define YYTK_PATCH 3
 
 #ifndef YYTK_CPP_VERSION
 #ifndef _MSVC_LANG
@@ -2251,19 +2251,9 @@ namespace YYTK
 	static_assert(sizeof(CArrayStructure<int>) == 0x10);
 #endif // _WIN64
 
-	// Seems to be mostly stable, some elements at the end are however omitted
-	struct CRoom
+	struct CRoomInternal
 	{
-		int32_t m_LastTile;
-		CRoom* m_InstanceHandle;
-		const char* m_Caption;
-		int32_t m_Speed;
-		int32_t m_Width;
-		int32_t m_Height;
-		bool m_Persistent;
-		uint32_t m_Color;
-		bool m_ShowColor;
-		CBackGM* m_Backgrounds[8];
+		// CBackGM* m_Backgrounds[8];
 		bool m_EnableViews;
 		bool m_ClearScreen;
 		bool m_ClearDisplayBuffer;
@@ -2301,6 +2291,35 @@ namespace YYTK
 		int32_t m_EffectLayerIdCount;
 		int32_t m_EffectLayerIdMax;
 	};
+
+	// Seems to be mostly stable, some elements at the end are however omitted
+	struct CRoom
+	{
+		int32_t m_LastTile;
+		CRoom* m_InstanceHandle;
+		const char* m_Caption;
+		int32_t m_Speed;
+		int32_t m_Width;
+		int32_t m_Height;
+		bool m_Persistent;
+		uint32_t m_Color;
+		bool m_ShowColor;
+	private:
+
+		// Last confirmed use in 2023.8, might be later even
+		struct
+		{
+			CBackGM* Backgrounds[8];
+			CRoomInternal Internals;
+		} WithBackgrounds;
+
+		// 2024.6 (first confirmed use) has Backgrounds removed.
+		// CRoomInternal cannot be properly aligned (due to bool having 1-byte alignment),
+		// so GetMembers() crafts the pointer manually instead of having a defined struct here.
+
+	public:
+		CRoomInternal& GetMembers();
+	};
 #ifdef _WIN64
 	static_assert(sizeof(CRoom) == 0x218);
 #endif // _WIN64

YYToolkit/source/YYTK/Module Interface/Interface.cpp

@@ -1646,7 +1646,7 @@ namespace YYTK
 
 		// Loop all active instances in the room
 		for (
-			CInstance* inst = current_room->m_ActiveInstances.m_First; 
+			CInstance* inst = current_room->GetMembers().m_ActiveInstances.m_First; 
 			inst != nullptr; 
 			inst = inst->GetMembers().m_Flink
 		)

YYToolkit/source/YYTK/Shared.cpp

@@ -493,4 +493,33 @@ RValue* YYObjectBase::FindOrAllocValue(
 
 	return &this->InternalGetYYVarRef(variable_hash);
 }
+
+CRoomInternal& YYTK::CRoom::GetMembers()
+{
+	YYTKInterface* module_interface = GetYYTKInterface();
+
+	// Return the more likely thing.
+	if (!module_interface)
+		return this->WithBackgrounds.Internals;
+
+	size_t bg_color_idx = 0;
+	AurieStatus last_status = module_interface->GetBuiltinVariableIndex(
+		"background_color",
+		bg_color_idx
+	);
+
+	// This lookup will fail in newer runners where backgrounds were removed
+	if (!AurieSuccess(last_status))
+	{
+		// Note: We have to craft the pointer manually here, since
+		// bool alignment prevents us from just having a struct (it'd get aligned to sizeof(PVOID)).
+
+		// Don't ask why it's from m_Color and not from m_ShowColor, it doesn't make sense
+		// and I can't figure out why it works - it just does.
+		return *reinterpret_cast<CRoomInternal*>(&this->m_Color);
+	}
+
+	return this->WithBackgrounds.Internals;
+}
+
 #endif // YYTK_DEFINE_INTERNAL

YYToolkit/source/YYTK/Shared.hpp

@@ -9,7 +9,7 @@
 
 #define YYTK_MAJOR 3
 #define YYTK_MINOR 4
-#define YYTK_PATCH 2
+#define YYTK_PATCH 3
 
 #ifndef YYTK_CPP_VERSION
 #ifndef _MSVC_LANG
@@ -2251,19 +2251,9 @@ namespace YYTK
 	static_assert(sizeof(CArrayStructure<int>) == 0x10);
 #endif // _WIN64
 
-	// Seems to be mostly stable, some elements at the end are however omitted
-	struct CRoom
+	struct CRoomInternal
 	{
-		int32_t m_LastTile;
-		CRoom* m_InstanceHandle;
-		const char* m_Caption;
-		int32_t m_Speed;
-		int32_t m_Width;
-		int32_t m_Height;
-		bool m_Persistent;
-		uint32_t m_Color;
-		bool m_ShowColor;
-		CBackGM* m_Backgrounds[8];
+		// CBackGM* m_Backgrounds[8];
 		bool m_EnableViews;
 		bool m_ClearScreen;
 		bool m_ClearDisplayBuffer;
@@ -2301,6 +2291,35 @@ namespace YYTK
 		int32_t m_EffectLayerIdCount;
 		int32_t m_EffectLayerIdMax;
 	};
+
+	// Seems to be mostly stable, some elements at the end are however omitted
+	struct CRoom
+	{
+		int32_t m_LastTile;
+		CRoom* m_InstanceHandle;
+		const char* m_Caption;
+		int32_t m_Speed;
+		int32_t m_Width;
+		int32_t m_Height;
+		bool m_Persistent;
+		uint32_t m_Color;
+		bool m_ShowColor;
+	private:
+
+		// Last confirmed use in 2023.8, might be later even
+		struct
+		{
+			CBackGM* Backgrounds[8];
+			CRoomInternal Internals;
+		} WithBackgrounds;
+
+		// 2024.6 (first confirmed use) has Backgrounds removed.
+		// CRoomInternal cannot be properly aligned (due to bool having 1-byte alignment),
+		// so GetMembers() crafts the pointer manually instead of having a defined struct here.
+
+	public:
+		CRoomInternal& GetMembers();
+	};
 #ifdef _WIN64
 	static_assert(sizeof(CRoom) == 0x218);
 #endif // _WIN64