Refactored Save Filters

Filters are copied less, only baked once, and optimized now
Intended to fix cross-level loading, but the problem is elsewhere :(

Author: muit

Source/SaveExtension/Private/LevelFilter.cpp

@@ -0,0 +1,12 @@
+// Copyright 2015-2020 Piperift. All Rights Reserved.
+
+#include "LevelFilter.h"
+
+
+/////////////////////////////////////////////////////
+// USaveDataTask
+
+const FName FSELevelFilter::TagNoTransform { "!SaveTransform"  };
+const FName FSELevelFilter::TagNoPhysics   { "!SavePhysics"    };
+const FName FSELevelFilter::TagNoTags      { "!SaveTags"       };
+const FName FSELevelFilter::TagTransform   { "SaveTransform"   };

Source/SaveExtension/Private/LifetimeComponent.cpp

@@ -46,15 +46,15 @@ void ULifetimeComponent::EndPlay(EEndPlayReason::Type Reason)
 	Super::EndPlay(Reason);
 }
 
-void ULifetimeComponent::OnSaveBegan(const FSaveFilter& Filter)
+void ULifetimeComponent::OnSaveBegan(const FSELevelFilter& Filter)
 {
 	if (Filter.ShouldSave(GetOwner()))
 	{
 		Saved.Broadcast();
 	}
 }
 
-void ULifetimeComponent::OnLoadFinished(const FSaveFilter& Filter, bool bError)
+void ULifetimeComponent::OnLoadFinished(const FSELevelFilter& Filter, bool bError)
 {
 	if (Filter.ShouldSave(GetOwner()))
 	{

Source/SaveExtension/Private/SaveFilter.cpp

@@ -399,7 +399,7 @@ void USaveManager::UnsubscribeFromEvents(const TScriptInterface<ISaveExtensionIn
 	SubscribedInterfaces.Remove(Interface);
 }
 
-void USaveManager::OnSaveBegan(const FSaveFilter& Filter)
+void USaveManager::OnSaveBegan(const FSELevelFilter& Filter)
 {
 	IterateSubscribedInterfaces([&Filter](auto* Object) {
 		check(Object->template Implements<USaveExtensionInterface>());
@@ -413,7 +413,7 @@ void USaveManager::OnSaveBegan(const FSaveFilter& Filter)
 	});
 }
 
-void USaveManager::OnSaveFinished(const FSaveFilter& Filter, const bool bError)
+void USaveManager::OnSaveFinished(const FSELevelFilter& Filter, const bool bError)
 {
 	IterateSubscribedInterfaces([&Filter, bError](auto* Object) {
 		check(Object->template Implements<USaveExtensionInterface>());
@@ -432,7 +432,7 @@ void USaveManager::OnSaveFinished(const FSaveFilter& Filter, const bool bError)
 	}
 }
 
-void USaveManager::OnLoadBegan(const FSaveFilter& Filter)
+void USaveManager::OnLoadBegan(const FSELevelFilter& Filter)
 {
 	IterateSubscribedInterfaces([&Filter](auto* Object) {
 		check(Object->template Implements<USaveExtensionInterface>());
@@ -446,7 +446,7 @@ void USaveManager::OnLoadBegan(const FSaveFilter& Filter)
 	});
 }
 
-void USaveManager::OnLoadFinished(const FSaveFilter& Filter, const bool bError)
+void USaveManager::OnLoadFinished(const FSELevelFilter& Filter, const bool bError)
 {
 	IterateSubscribedInterfaces([&Filter, bError](auto* Object) {
 		check(Object->template Implements<USaveExtensionInterface>());

Source/SaveExtension/Private/SaveManager.cpp

@@ -2,7 +2,7 @@
 
 #include "SavePreset.h"
 
-#include "SaveFilter.h"
+#include "LevelFilter.h"
 #include "SlotData.h"
 #include "SlotInfo.h"
 
@@ -27,9 +27,9 @@ void USavePreset::GetSlotNameFromId(int32 Id, FName& Name) const
 	}
 }
 
-FSaveFilter USavePreset::ToFilter() const
+FSELevelFilter USavePreset::ToFilter() const
 {
-	FSaveFilter Filter{};
+	FSELevelFilter Filter{};
 	Filter.FromPreset(*this);
 	return Filter;
 }

Source/SaveExtension/Private/SavePreset.cpp

@@ -7,20 +7,27 @@
 /////////////////////////////////////////////////////
 // LevelRecords
 
-FName FPersistentLevelRecord::PersistentName{ "Persistent" };
+const FName FPersistentLevelRecord::PersistentName{ "Persistent" };
 
 
 bool FLevelRecord::Serialize(FArchive& Ar)
 {
 	Super::Serialize(Ar);
 
+	Ar << bOverrideGeneralFilter;
+	if (bOverrideGeneralFilter)
+	{
+		static UScriptStruct* const LevelFilterType{ FSELevelFilter::StaticStruct() };
+		LevelFilterType->SerializeItem(Ar, &Filter, nullptr);
+	}
+
 	Ar << LevelScript;
 	Ar << Actors;
 
 	return true;
 }
 
-void FLevelRecord::Clean()
+void FLevelRecord::CleanRecords()
 {
 	LevelScript = {};
 	Actors.Empty();

Source/SaveExtension/Private/Serialization/LevelRecords.cpp

@@ -15,7 +15,7 @@
 // FMTTask_SerializeActors
 void FMTTask_SerializeActors::DoWork()
 {
-	if (Filter.bStoreGameInstance)
+	if (bStoreGameInstance)
 	{
 		SerializeGameInstance();
 	}

Source/SaveExtension/Private/Serialization/MTTask_SerializeActors.cpp

@@ -44,6 +44,47 @@ USaveManager* USlotDataTask::GetManager() const
 	return Cast<USaveManager>(GetOuter());
 }
 
+void USlotDataTask::BakeAllFilters()
+{
+	SlotData->GeneralLevelFilter.BakeAllowedClasses();
+
+	if(SlotData->MainLevel.bOverrideGeneralFilter)
+	{
+		SlotData->MainLevel.Filter.BakeAllowedClasses();
+	}
+
+	for(const auto& Level : SlotData->SubLevels)
+	{
+		if(Level.bOverrideGeneralFilter)
+		{
+			Level.Filter.BakeAllowedClasses();
+		}
+	}
+}
+
+const FSELevelFilter& USlotDataTask::GetGeneralFilter() const
+{
+	check(SlotData);
+	return SlotData->GeneralLevelFilter;
+}
+
+const FSELevelFilter& USlotDataTask::GetLevelFilter(const FLevelRecord& Level) const
+{
+	if(Level.bOverrideGeneralFilter)
+	{
+		return Level.Filter;
+	}
+	return GetGeneralFilter();
+}
+
+FLevelRecord* USlotDataTask::FindLevelRecord(const ULevelStreaming* Level) const
+{
+	if (!Level)
+		return &SlotData->MainLevel;
+	else // Find the Sub-Level
+		return SlotData->SubLevels.FindByKey(Level);
+}
+
 UWorld* USlotDataTask::GetWorld() const
 {
 	return GetOuter()->GetWorld();

Source/SaveExtension/Private/Serialization/SlotDataTask.cpp

@@ -10,6 +10,15 @@ void USlotDataTask_LevelLoader::OnStart()
 {
 	if (SlotData && StreamingLevel && StreamingLevel->IsLevelLoaded())
 	{
+		FLevelRecord* LevelRecord = FindLevelRecord(StreamingLevel);
+		if (!LevelRecord)
+		{
+			Finish(false);
+			return;
+		}
+
+		GetLevelFilter(*LevelRecord).BakeAllowedClasses();
+
 		if (Preset->IsFrameSplitLoad())
 		{
 			DeserializeLevelASync(StreamingLevel->GetLoadedLevel(), StreamingLevel);
@@ -26,27 +35,26 @@ void USlotDataTask_LevelLoader::OnStart()
 
 void USlotDataTask_LevelLoader::DeserializeASyncLoop(float StartMS /*= 0.0f*/)
 {
-	FLevelRecord * LevelRecord = FindLevelRecord(CurrentSLevel.Get());
-	if (!LevelRecord)
-	{
-		Finish(false);
-		return;
-	}
+	FLevelRecord& LevelRecord = *FindLevelRecord(CurrentSLevel.Get());
 
 	if (StartMS <= 0)
+	{
 		StartMS = GetTimeMilliseconds();
+	}
+
+	const auto& Filter = GetLevelFilter(LevelRecord);
 
 	// Continue Iterating actors every tick
 	for (; CurrentActorIndex < CurrentLevelActors.Num(); ++CurrentActorIndex)
 	{
 		AActor* Actor{ CurrentLevelActors[CurrentActorIndex].Get() };
 		if (Actor)
 		{
-			DeserializeLevel_Actor(Actor, *LevelRecord);
+			DeserializeLevel_Actor(Actor, LevelRecord, Filter);
 
 			const float CurrentMS = GetTimeMilliseconds();
 			// If x milliseconds passed, continue on next frame
-			if (CurrentMS - StartMS >= Filter.MaxFrameMs)
+			if (CurrentMS - StartMS >= MaxFrameMs)
 				return;
 		}
 	}

Source/SaveExtension/Private/Serialization/SlotDataTask_LevelLoader.cpp

@@ -10,6 +10,15 @@ void USlotDataTask_LevelSaver::OnStart()
 {
 	if (SlotData && StreamingLevel && StreamingLevel->IsLevelLoaded())
 	{
+		FLevelRecord* LevelRecord = FindLevelRecord(StreamingLevel);
+		if (!LevelRecord)
+		{
+			Finish(false);
+			return;
+		}
+
+		GetLevelFilter(*LevelRecord).BakeAllowedClasses();
+
 		const int32 NumberOfThreads = FMath::Max(1, FPlatformMisc::NumberOfWorkerThreadsToSpawn());
 		SerializeLevelSync(StreamingLevel->GetLoadedLevel(), NumberOfThreads, StreamingLevel);