Merge pull request #4199 from pypeclub/bugfix/support-for-unreal-5.1

openpype/hosts/unreal/api/pipeline.py

@@ -2,6 +2,7 @@
 import os
 import logging
 from typing import List
+import semver
 
 import pyblish.api
 
@@ -21,6 +22,9 @@ import unreal  # noqa
 
 logger = logging.getLogger("openpype.hosts.unreal")
 OPENPYPE_CONTAINERS = "OpenPypeContainers"
+UNREAL_VERSION = semver.VersionInfo(
+    *os.getenv("OPENPYPE_UNREAL_VERSION").split(".")
+)
 
 HOST_DIR = os.path.dirname(os.path.abspath(openpype.hosts.unreal.__file__))
 PLUGINS_DIR = os.path.join(HOST_DIR, "plugins")
@@ -111,7 +115,9 @@ def ls():
 
     """
     ar = unreal.AssetRegistryHelpers.get_asset_registry()
-    openpype_containers = ar.get_assets_by_class("AssetContainer", True)
+    # UE 5.1 changed how class name is specified
+    class_name = ["/Script/OpenPype", "AssetContainer"] if UNREAL_VERSION.major == 5 and UNREAL_VERSION.minor > 0 else "AssetContainer"  # noqa
+    openpype_containers = ar.get_assets_by_class(class_name, True)
 
     # get_asset_by_class returns AssetData. To get all metadata we need to
     # load asset. get_tag_values() work only on metadata registered in

openpype/hosts/unreal/hooks/pre_workfile_preparation.py

@@ -150,6 +150,7 @@ class UnrealPrelaunchHook(PreLaunchHook):
                 engine_path=Path(engine_path)
             )
 
+        self.launch_context.env["OPENPYPE_UNREAL_VERSION"] = engine_version
         # Append project file to launch arguments
         self.launch_context.launch_args.append(
             f"\"{project_file.as_posix()}\"")

openpype/hosts/unreal/integration/UE_5.0/Source/OpenPype/OpenPype.Build.cs

@@ -6,7 +6,11 @@ public class OpenPype : ModuleRules
 {
 	public OpenPype(ReadOnlyTargetRules Target) : base(Target)
 	{
+	    DefaultBuildSettings = BuildSettingsVersion.V2;
+	    bLegacyPublicIncludePaths = false;
+	    ShadowVariableWarningLevel = WarningLevel.Error;
 		PCHUsage = ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs;
+		IncludeOrderVersion = EngineIncludeOrderVersion.Unreal5_0;
 		
 		PublicIncludePaths.AddRange(
 			new string[] {

openpype/hosts/unreal/integration/UE_5.0/Source/OpenPype/Private/AssetContainer.cpp

@@ -1,7 +1,7 @@
 // Fill out your copyright notice in the Description page of Project Settings.
 
 #include "AssetContainer.h"
-#include "AssetRegistryModule.h"
+#include "AssetRegistry/AssetRegistryModule.h"
 #include "Misc/PackageName.h"
 #include "Engine.h"
 #include "Containers/UnrealString.h"
@@ -30,8 +30,8 @@ void UAssetContainer::OnAssetAdded(const FAssetData& AssetData)
 
 	// get asset path and class
 	FString assetPath = AssetData.GetFullName();
-	FString assetFName = AssetData.AssetClass.ToString();
-	
+	FString assetFName = AssetData.AssetClassPath.ToString();
+	UE_LOG(LogTemp, Log, TEXT("asset name %s"), *assetFName);
 	// split path
 	assetPath.ParseIntoArray(split, TEXT(" "), true);
 
@@ -60,7 +60,7 @@ void UAssetContainer::OnAssetRemoved(const FAssetData& AssetData)
 
 	// get asset path and class
 	FString assetPath = AssetData.GetFullName();
-	FString assetFName = AssetData.AssetClass.ToString();
+	FString assetFName = AssetData.AssetClassPath.ToString();
 
 	// split path
 	assetPath.ParseIntoArray(split, TEXT(" "), true);
@@ -93,7 +93,7 @@ void UAssetContainer::OnAssetRenamed(const FAssetData& AssetData, const FString&
 
 	// get asset path and class
 	FString assetPath = AssetData.GetFullName();
-	FString assetFName = AssetData.AssetClass.ToString();
+	FString assetFName = AssetData.AssetClassPath.ToString();
 
 	// split path
 	assetPath.ParseIntoArray(split, TEXT(" "), true);

openpype/hosts/unreal/integration/UE_5.0/Source/OpenPype/Private/OpenPypePublishInstance.cpp

@@ -1,10 +1,10 @@
 #pragma once
 
 #include "OpenPypePublishInstance.h"
-#include "AssetRegistryModule.h"
+#include "AssetRegistry/AssetRegistryModule.h"
 #include "AssetToolsModule.h"
 #include "Framework/Notifications/NotificationManager.h"
-#include "SNotificationList.h"
+#include "Widgets/Notifications/SNotificationList.h"
 
 //Moves all the invalid pointers to the end to prepare them for the shrinking
 #define REMOVE_INVALID_ENTRIES(VAR) VAR.CompactStable(); \
@@ -47,7 +47,7 @@ void UOpenPypePublishInstance::OnAssetCreated(const FAssetData& InAssetData)
 	if (!IsValid(Asset))
 	{
 		UE_LOG(LogAssetData, Warning, TEXT("Asset \"%s\" is not valid! Skipping the addition."),
-		       *InAssetData.ObjectPath.ToString());
+		       *InAssetData.GetObjectPathString());
 		return;
 	}
 

openpype/hosts/unreal/integration/UE_5.0/Source/OpenPype/Public/AssetContainer.h

@@ -5,7 +5,7 @@
 #include "CoreMinimal.h"
 #include "UObject/NoExportTypes.h"
 #include "Engine/AssetUserData.h"
-#include "AssetData.h"
+#include "AssetRegistry/AssetData.h"
 #include "AssetContainer.generated.h"
 
 /**

openpype/hosts/unreal/integration/UE_5.0/Source/OpenPype/Public/OpenPypePublishInstance.h

@@ -1,6 +1,5 @@
 #pragma once
 
-#include "EditorTutorial.h"
 #include "Engine.h"
 #include "OpenPypePublishInstance.generated.h"
 

openpype/hosts/unreal/lib.py

@@ -50,7 +50,10 @@ def get_engine_versions(env=None):
         # environment variable not set
         pass
     except OSError:
-        # specified directory doesn't exists
+        # specified directory doesn't exist
+        pass
+    except StopIteration:
+        # specified directory doesn't exist
         pass
 
     # if we've got something, terminate auto-detection process

openpype/hosts/unreal/plugins/publish/collect_instances.py

@@ -3,6 +3,8 @@
 import ast
 import unreal  # noqa
 import pyblish.api
+from openpype.hosts.unreal.api.pipeline import UNREAL_VERSION
+from openpype.pipeline.publish import KnownPublishError
 
 
 class CollectInstances(pyblish.api.ContextPlugin):
@@ -23,8 +25,10 @@ class CollectInstances(pyblish.api.ContextPlugin):
     def process(self, context):
 
         ar = unreal.AssetRegistryHelpers.get_asset_registry()
-        instance_containers = ar.get_assets_by_class(
-            "OpenPypePublishInstance", True)
+        class_name = ["/Script/OpenPype",
+                      "AssetContainer"] if UNREAL_VERSION.major == 5 and \
+                                           UNREAL_VERSION.minor > 0 else "OpenPypePublishInstance"  # noqa
+        instance_containers = ar.get_assets_by_class(class_name, True)
 
         for container_data in instance_containers:
             asset = container_data.get_asset()
@@ -32,9 +36,8 @@ class CollectInstances(pyblish.api.ContextPlugin):
             data["objectName"] = container_data.asset_name
             # convert to strings
             data = {str(key): str(value) for (key, value) in data.items()}
-            assert data.get("family"), (
-                "instance has no family"
-            )
+            if not data.get("family"):
+                raise KnownPublishError("instance has no family")
 
             # content of container
             members = ast.literal_eval(data.get("members"))