You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
This change consists of multiple changes: Core: - Deprecation of ANY_PACKAGE macro. Added ANY_PACKAGE_DEPRECATED macro which can still be used for backwards compatibility purposes (only used in CoreUObject) - Deprecation of StaticFindObjectFast* functions that take bAnyPackage parameter - Added UStruct::GetStructPathName function that returns FTopLevelAssetPath representing the path name (package + object FName, super quick compared to UObject::GetPathName) + wrapper UClass::GetClassPathName to make it look better when used with UClasses - Added (Static)FindFirstObject* functions that find a first object given its Name (no Outer). These functions are used in places I consider valid to do global UObject (UClass) lookups like parsing command line parameters / checking for unique object names - Added static UClass::TryFindType function which serves a similar purpose as FindFirstObject however it's going to throw a warning (with a callstack / maybe ensure in the future?) if short class name is provided. This function is used in places that used to use short class names but now should have been converted to use path names to catch any potential regressions and or edge cases I missed. - Added static UClass::TryConvertShortNameToPathName utility function - Added static UClass::TryFixShortClassNameExportPath utility function - Object text export paths will now also include class path (Texture2D'/Game/Textures/Grass.Grass' -> /Script/Engine.Texture2D'/Game/Textures/Grass.Grass') - All places that manually generated object export paths for objects will now use FObjectPropertyBase::GetExportPath - Added a new startup test that checks for short type names in UClass/FProperty MetaData values AssetRegistry: - Deprecated any member variables (FAssetData / FARFilter) or functions that use FNames to represent class names and replaced them with FTopLevelAssetPath - Added new member variables and new function overloads that use FTopLevelAssetPath to represent class names - This also applies to a few other modules' APIs to match AssetRegistry changes Everything else: - Updated code that used ANY_PACKAGE (depending on the use case) to use FindObject(nullptr, PathToObject), UClass::TryFindType (used when path name is expected, warns if it's a short name) or FindFirstObject (usually for finding types based on user input but there's been a few legitimate use cases not related to user input) - Updated code that used AssetRegistry API to use FTopLevelAssetPaths and USomeClass::StaticClass()->GetClassPathName() instead of GetFName() - Updated meta data and hardcoded FindObject(ANY_PACKAGE, "EEnumNameOrClassName") calls to use path names #jira UE-99463 #rb many.people [FYI] Marcus.Wassmer #preflight 629248ec2256738f75de9b32 #codereviewnumbers 20320742, 20320791, 20320799, 20320756, 20320809, 20320830, 20320840, 20320846, 20320851, 20320863, 20320780, 20320765, 20320876, 20320786 #ROBOMERGE-OWNER: robert.manuszewski #ROBOMERGE-AUTHOR: robert.manuszewski #ROBOMERGE-SOURCE: CL 20430220 via CL 20433854 via CL 20435474 via CL 20435484 #ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v949-20362246) [CL 20448496 by robert manuszewski in ue5-main branch]
209 lines
7.5 KiB
C++
209 lines
7.5 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
/*=============================================================================
|
|
ReplaceAssetsCommandlet.cpp: Commandlet for replacing assets with those
|
|
from another location (intended use is replacing with cooked assets)
|
|
=============================================================================*/
|
|
|
|
#include "Commandlets/ReplaceAssetsCommandlet.h"
|
|
#include "AssetRegistry/AssetRegistryModule.h"
|
|
#include "HAL/FileManager.h"
|
|
#include "Misc/Paths.h"
|
|
#include "AssetRegistry/ARFilter.h"
|
|
#include "Engine/World.h"
|
|
|
|
DEFINE_LOG_CATEGORY_STATIC(LogReplaceAssetsCommandlet, Log, All);
|
|
|
|
UReplaceAssetsCommandlet::UReplaceAssetsCommandlet(const FObjectInitializer& ObjectInitializer)
|
|
: Super(ObjectInitializer)
|
|
{
|
|
|
|
}
|
|
|
|
int32 UReplaceAssetsCommandlet::Main(const FString& InParams)
|
|
{
|
|
// Parse command line.
|
|
TArray<FString> Tokens;
|
|
TArray<FString> Switches;
|
|
UCommandlet::ParseCommandLine(*InParams, Tokens, Switches);
|
|
|
|
// Support standard and BuildGraph style delimeters
|
|
static const TCHAR* ParamDelims[] =
|
|
{
|
|
TEXT(";"),
|
|
TEXT("+"),
|
|
};
|
|
|
|
const FString AssetSourcePathSwitch = TEXT("AssetSourcePath=");
|
|
const FString ReplacedPathsSwitch = TEXT("ReplacedPaths=");
|
|
const FString ReplacedClassesSwitch = TEXT("ReplacedClasses=");
|
|
const FString ExcludedPathsSwitch = TEXT("ExcludedPaths=");
|
|
const FString ExcludedClassesSwitch = TEXT("ExcludedClasses=");
|
|
FString AssetSourcePath;
|
|
TArray<FString> ReplacedPaths;
|
|
TArray<FString> ReplacedClasses;
|
|
TArray<FString> ExcludedPaths;
|
|
TArray<FString> ExcludedClasses;
|
|
|
|
// Parse parameters
|
|
for (int32 SwitchIdx = 0; SwitchIdx < Switches.Num(); ++SwitchIdx)
|
|
{
|
|
const FString& Switch = Switches[SwitchIdx];
|
|
FString SwitchValue;
|
|
if (FParse::Value(*Switch, *AssetSourcePathSwitch, SwitchValue))
|
|
{
|
|
AssetSourcePath = SwitchValue;
|
|
}
|
|
else if (FParse::Value(*Switch, *ReplacedPathsSwitch, SwitchValue))
|
|
{
|
|
SwitchValue.ParseIntoArray(ReplacedPaths, ParamDelims, 2);
|
|
}
|
|
else if (FParse::Value(*Switch, *ReplacedClassesSwitch, SwitchValue))
|
|
{
|
|
SwitchValue.ParseIntoArray(ReplacedClasses, ParamDelims, 2);
|
|
}
|
|
else if (FParse::Value(*Switch, *ExcludedPathsSwitch, SwitchValue))
|
|
{
|
|
SwitchValue.ParseIntoArray(ExcludedPaths, ParamDelims, 2);
|
|
}
|
|
else if (FParse::Value(*Switch, *ExcludedClassesSwitch, SwitchValue))
|
|
{
|
|
SwitchValue.ParseIntoArray(ExcludedClasses, ParamDelims, 2);
|
|
}
|
|
}
|
|
|
|
// Check that replacement asset folder exists
|
|
bool bHasReplacementAssets = !AssetSourcePath.IsEmpty() && IFileManager::Get().DirectoryExists(*AssetSourcePath);
|
|
if (!bHasReplacementAssets)
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Error, TEXT("Source Path for replacement assets does not exist - please specify a valid location for -AssetSourcePath on the commandline"));
|
|
return 1;
|
|
}
|
|
|
|
// Load the asset registry module
|
|
FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked<FAssetRegistryModule>(TEXT("AssetRegistry"));
|
|
|
|
// Update Registry Module
|
|
UE_LOG(LogReplaceAssetsCommandlet, Display, TEXT("Searching Asset Registry"));
|
|
AssetRegistryModule.Get().SearchAllAssets(true);
|
|
|
|
TArray<FAssetData> FinalAssetList;
|
|
|
|
// Get assets from paths and classes that we want to replace
|
|
if (ReplacedPaths.Num() > 0)
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Display, TEXT("Getting Assets from specified paths"));
|
|
FARFilter Filter;
|
|
Filter.bIncludeOnlyOnDiskAssets = true;
|
|
Filter.bRecursivePaths = true;
|
|
for (const FString& ReplacedPath : ReplacedPaths)
|
|
{
|
|
Filter.PackagePaths.AddUnique(*ReplacedPath);
|
|
}
|
|
TArray<FAssetData> AssetList;
|
|
AssetRegistryModule.Get().GetAssets(Filter, AssetList);
|
|
for (FAssetData& Asset : AssetList)
|
|
{
|
|
FinalAssetList.AddUnique(Asset);
|
|
}
|
|
}
|
|
if (ReplacedClasses.Num() > 0)
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Display, TEXT("Getting Assets of specified classes"));
|
|
FARFilter Filter;
|
|
Filter.bIncludeOnlyOnDiskAssets = true;
|
|
Filter.PackagePaths.Add(TEXT("/Game"));
|
|
Filter.bRecursivePaths = true;
|
|
for (const FString& ReplacedClass : ReplacedClasses)
|
|
{
|
|
FTopLevelAssetPath ReplacedClassPathName = UClass::TryConvertShortTypeNameToPathName<UStruct>(ReplacedClass, ELogVerbosity::Error, TEXT("UReplaceAssetsCommandlet"));
|
|
if (ReplacedClassPathName.IsNull())
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Error, TEXT("Failed to convert short class name \"%s\" to path name. Please use class path names for ReplacedClasses."), *ReplacedClass);
|
|
}
|
|
else
|
|
{
|
|
Filter.ClassPaths.AddUnique(ReplacedClassPathName);
|
|
}
|
|
}
|
|
TArray<FAssetData> AssetList;
|
|
AssetRegistryModule.Get().GetAssets(Filter, AssetList);
|
|
for (FAssetData& Asset : AssetList)
|
|
{
|
|
FinalAssetList.AddUnique(Asset);
|
|
}
|
|
}
|
|
|
|
// Run through paths and classes that should be excluded
|
|
if (FinalAssetList.Num() > 0 && ExcludedPaths.Num() > 0)
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Display, TEXT("Excluding Assets from specified paths"));
|
|
FARFilter Filter;
|
|
Filter.bIncludeOnlyOnDiskAssets = true;
|
|
Filter.bRecursivePaths = true;
|
|
for (const FString& ExcludedPath : ExcludedPaths)
|
|
{
|
|
Filter.PackagePaths.AddUnique(*ExcludedPath);
|
|
}
|
|
TArray<FAssetData> AssetList;
|
|
AssetRegistryModule.Get().GetAssets(Filter, AssetList);
|
|
FinalAssetList.RemoveAll([&AssetList](const FAssetData& Asset) {return AssetList.Contains(Asset); });
|
|
}
|
|
if (FinalAssetList.Num() > 0 && ExcludedClasses.Num() > 0)
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Display, TEXT("Excluding Assets of specified classes"));
|
|
FARFilter Filter;
|
|
Filter.bIncludeOnlyOnDiskAssets = true;
|
|
Filter.PackagePaths.Add(TEXT("/Game"));
|
|
Filter.bRecursivePaths = true;
|
|
for (const FString& ExcludedClass : ExcludedClasses)
|
|
{
|
|
FTopLevelAssetPath ExcludedClassPathName = UClass::TryConvertShortTypeNameToPathName<UStruct>(ExcludedClass, ELogVerbosity::Error, TEXT("UReplaceAssetsCommandlet"));
|
|
if (ExcludedClassPathName.IsNull())
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Error, TEXT("Failed to convert short class name \"%s\" to path name. Please use class path names for ExcludedClasses."), *ExcludedClass);
|
|
}
|
|
else
|
|
{
|
|
Filter.ClassPaths.AddUnique(ExcludedClassPathName);
|
|
}
|
|
}
|
|
TArray<FAssetData> AssetList;
|
|
AssetRegistryModule.Get().GetAssets(Filter, AssetList);
|
|
FinalAssetList.RemoveAll([&AssetList](const FAssetData& Asset) {return AssetList.Contains(Asset); });
|
|
}
|
|
|
|
TArray<FString> FinalFileList;
|
|
if (FinalAssetList.Num() > 0)
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Display, TEXT("Converting Package Names to File Paths"));
|
|
for (FAssetData& RemovedAsset : FinalAssetList)
|
|
{
|
|
bool bIsMap = RemovedAsset.AssetClassPath == UWorld::StaticClass()->GetClassPathName();
|
|
FinalFileList.AddUnique(FPaths::ConvertRelativePathToFull(FPackageName::LongPackageNameToFilename(RemovedAsset.PackageName.ToString(), bIsMap ? FPackageName::GetMapPackageExtension() : FPackageName::GetAssetPackageExtension())));
|
|
}
|
|
|
|
UE_LOG(LogReplaceAssetsCommandlet, Display, TEXT("Replacing files..."));
|
|
for (const FString& ReplacedPath : FinalFileList)
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Log, TEXT("Replacing asset: %s"), *ReplacedPath);
|
|
if (!IFileManager::Get().Delete(*ReplacedPath, false, true))
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Error, TEXT("Failed to delete asset: %s"), *ReplacedPath);
|
|
}
|
|
FString ReplacementPath = ReplacedPath;
|
|
FPaths::MakePathRelativeTo(ReplacementPath, *FPaths::RootDir());
|
|
ReplacementPath = FPaths::Combine(AssetSourcePath, ReplacementPath);
|
|
if (IFileManager::Get().FileExists(*ReplacementPath))
|
|
{
|
|
if (IFileManager::Get().Copy(*ReplacedPath, *ReplacementPath) != COPY_OK)
|
|
{
|
|
UE_LOG(LogReplaceAssetsCommandlet, Error, TEXT("Failed to copy asset: %s"), *ReplacementPath);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|