Added functionality to load maps from anywhere across different content folders, project or plugin (#8862)

Author: Blyron

Unreal/CarlaUnreal/Plugins/Carla/Source/Carla/Carla.Build.cs

@@ -128,7 +128,8 @@ void AddDynamicLibrary(string library)
       "RHI",
       "Renderer",
       "ProceduralMeshComponent",
-      "MeshDescription"
+      "MeshDescription",
+      "Projects"
     });
 
     if (EnableCarSim)

Unreal/CarlaUnreal/Plugins/Carla/Source/Carla/Game/CarlaEpisode.cpp

@@ -94,38 +94,12 @@ bool UCarlaEpisode::LoadNewEpisode(const FString &MapString, bool ResetSettings)
 {
   bool bIsFileFound = false;
 
-  FString FinalPath = MapString.IsEmpty() ? GetMapName() : MapString;
-  FinalPath += !MapString.EndsWith(".umap") ? ".umap" : "";
+  FString FinalPath = UCarlaStatics::FindMapPath(MapString);
 
-  if (MapString.StartsWith("/Game"))
+  if(FPaths::FileExists(FinalPath))
   {
-    // Some conversions...
-    FinalPath.RemoveFromStart(TEXT("/Game/"));
-    FinalPath = FPaths::ProjectContentDir() + FinalPath;
-    FinalPath = IFileManager::Get().ConvertToAbsolutePathForExternalAppForRead(*FinalPath);
-
-    if (FPaths::FileExists(FinalPath)) {
-      bIsFileFound = true;
-      FinalPath = MapString;
-    }
-  }
-  else
-  {
-    if (MapString.Contains("/")) return false;
-
-    // Find the full path under Carla
-    TArray<FString> TempStrArray, PathList;
-    IFileManager::Get().FindFilesRecursive(PathList, *FPaths::ProjectContentDir(), *FinalPath, true, false, false);
-    if (PathList.Num() > 0)
-    {
-      FinalPath = PathList[0];
-      FinalPath.ParseIntoArray(TempStrArray, TEXT("Content/"), true);
-      FinalPath = TempStrArray[1];
-      FinalPath.ParseIntoArray(TempStrArray, TEXT("."), true);
-      FinalPath = "/Game/" + TempStrArray[0];
-
-      return LoadNewEpisode(FinalPath, ResetSettings);
-    }
+    bIsFileFound = true;
+    FinalPath = MapString;
   }
 
   if (bIsFileFound)

Unreal/CarlaUnreal/Plugins/Carla/Source/Carla/Game/CarlaStatics.cpp

@@ -8,21 +8,82 @@
 #include "Carla.h"
 
 #include <util/ue-header-guard-begin.h>
+#include "Interfaces/IPluginManager.h"
+#include "Misc/Paths.h"
+#include "Modules/ModuleManager.h"
 #include "HAL/FileManagerGeneric.h"
 #include <util/ue-header-guard-end.h>
 
+
+TArray<FString> UCarlaStatics::GetAllPluginContentPaths()
+{
+  TArray<FString> OutContentDirs;
+  const TArray<TSharedRef<IPlugin>> Plugins = IPluginManager::Get().GetDiscoveredPlugins();
+  for (const TSharedRef<IPlugin>& Plugin : Plugins)
+  {
+      if (Plugin->GetLoadedFrom() == EPluginLoadedFrom::Engine)
+      {
+          continue;
+      }
+
+      FString ContentDir = Plugin->GetContentDir();
+      if (FPaths::DirectoryExists(ContentDir))
+      {
+        OutContentDirs.Add(ContentDir);
+      }
+  }
+  return OutContentDirs;
+}
+
+
 TArray<FString> UCarlaStatics::GetAllMapNames()
 {
   TArray<FString> TmpStrList, MapNameList;
-  IFileManager::Get().FindFilesRecursive(
-      MapNameList, *FPaths::ProjectContentDir(), TEXT("*.umap"), true, false, false);
-  MapNameList.RemoveAll( [](const FString &Name) { return Name.Contains("TestMaps");});
-  MapNameList.RemoveAll( [](const FString &Name) { return Name.Contains("OpenDriveMap");});
+  TArray<FString> PathList;
+
+  PathList.Add(FPaths::ProjectContentDir());
+  PathList.Append(GetAllPluginContentPaths());
+
+  for(const FString &Path : PathList) {
+    if (FPaths::DirectoryExists(Path)) {
+      UE_LOG(LogCarla, Log, TEXT("Path: %s"), *Path);
+      IFileManager::Get().FindFilesRecursive(MapNameList, *Path, TEXT("*.umap"), true, false, false);
+    }
+  }
+
+  // Filter out undesired maps
+  MapNameList.RemoveAll([](const FString& Name) {
+      return Name.Contains("TestMaps") || Name.Contains("OpenDriveMap") || Name.Contains("Sublevels");
+  });
+
   for (int i = 0; i < MapNameList.Num(); i++) {
-      MapNameList[i].ParseIntoArray(TmpStrList, TEXT("Content/"), true);
-      MapNameList[i] = TmpStrList[1];
-      MapNameList[i] = MapNameList[i].Replace(TEXT(".umap"), TEXT(""));
-      MapNameList[i] = "/Game/" + MapNameList[i];
+    MapNameList[i] = FPaths::GetBaseFilename(*MapNameList[i]);
   }
   return MapNameList;
 }
+
+FString UCarlaStatics::FindMapPath(const FString &MapName)
+{
+  TArray<FString> ContentPaths;
+
+  ContentPaths.Add(FPaths::ProjectContentDir());
+  ContentPaths.Append(GetAllPluginContentPaths());
+
+  // Look for matching map files
+  for (const FString& Path : ContentPaths)
+  {
+      TArray<FString> FoundFiles;
+      IFileManager::Get().FindFilesRecursive(FoundFiles, *Path, TEXT("*.umap"), true, false);
+
+      for (const FString& FilePath : FoundFiles)
+      {
+          FString FileName = FPaths::GetBaseFilename(FilePath); // just "MyMap", no path, no extension
+          if (FileName.Equals(MapName, ESearchCase::IgnoreCase))
+          {
+              return FilePath; // Return the full path of the first matching map. Only one map is expected.
+          }
+      }
+  }
+
+  return FString();
+}

Unreal/CarlaUnreal/Plugins/Carla/Source/Carla/Game/CarlaStatics.h

@@ -41,9 +41,15 @@ class CARLA_API UCarlaStatics : public UBlueprintFunctionLibrary
   UFUNCTION(BlueprintPure, Category="CARLA", meta=(WorldContext="WorldContextObject"))
   static UCarlaSettings *GetCarlaSettings(const UObject *WorldContextObject);
 
+  UFUNCTION(BlueprintPure, Category="CARLA")
+  static TArray<FString> GetAllPluginContentPaths();
+
   UFUNCTION(BlueprintPure, Category="CARLA")
   static TArray<FString> GetAllMapNames();
 
+  UFUNCTION(BlueprintPure, Category="CARLA")
+  static FString FindMapPath(const FString &MapName);
+
   UFUNCTION(BlueprintPure, Category="CARLA", meta=(WorldContext="WorldContextObject"))
   static ACarlaRecorder* GetRecorder(const UObject *WorldContextObject);