自学内容网 自学内容网
自学内容网 > 正文

UE Asset Batch Duplication插件

🕗 发布于 2024-09-22 09:35 游戏引擎  虚幻  引擎插件  

目录

准备工作

"Scripting library"

三个最重要的功能（前两个是UEditorUtilityLibrary中的）

自动创建声明：

TArray

T 的含义

F 的含义

Live Coding （Ctrl+alt F11）

Live Coding 的工作流程：

关于刷新 Visual Studio 项目：

详细步骤

步骤0：refresh Visual Studio Project and close editor

步骤1.include EditorUtilityLibrary.h and EditorAssetLibrary.h to your cpp file

步骤2. 在QuickAssetAction.h中声明BatchAssets的Function

步骤3.QuickAssetAction.cpp中，

解释：

1. TArray SelectedAssetsData = UEditorUtilityLibrary::GetSelectedAssetData();

2. uint32 Counter = 0;

示例应用

错误代码和主要问题

正确代码

插件效果

准备工作

"Scripting library"

"Scripting library" 通常指的是一组可重用的脚本代码，开发者可以在项目中调用以简化和加快开发过程。它提供了一些常见的功能和工具，这样开发者无需从头编写每个功能，而是可以通过调用库中的函数或类，来实现特定的任务或行为。

我们需要用UEditorUtilityLibrary和UEditorAssetLibrary这两个"Scripting library"

三个最重要的功能（前两个是UEditorUtilityLibrary中的）

  • GetSelectedAssets()   返回TArray<UObject*>
  • GetSelectedAssetData()    返回TArray<FAssetData>  (比UObject*包含更多信息）
  • ListAssets    返回TArray<FString>

自动创建声明：

  • 在函数声明（例如 MyFunction）上右键单击。
  • 从右键菜单中选择 Quick Actions and Refactorings 或者直接使用快捷键 Ctrl + .。

TArray<FAssetData>

  • TArray 是 Unreal Engine 中的动态数组模板，用于存储同类型的数据。
  • FAssetData 是一个结构体，包含有关资产的信息，如资产的路径、类、标签等。
  • FVector MyVector; // 三维向量
FAssetData MyAssetData; // 资产数据结构
//示例代码

    在 Unreal Engine 的命名约定中，

T 的含义

  • Template（模板）：表示这是一个模板类，可以接受不同类型的参数。例如，TArray 表示一个动态数组模板，能够存储任何类型的数据。

F 的含义

  • Struct（结构体）：表示这是一个结构体，通常用于存储一些数据。例如，FVector 表示一个三维向量结构体，FAssetData 表示关于资产信息的结构体。

Live Coding （Ctrl+alt F11）

Live Coding 是 Unreal Engine 的一个功能，允许你在运行游戏时直接修改代码并重新编译，从而可以即时看到更改的效果，而不必重新启动 Unreal Editor。这对于快速迭代和调试非常有帮助。

Live Coding 的工作流程：

  1. 启用 Live Coding 后，编写或修改代码。
  2. 在 Unreal Editor 中，点击 Live Coding 按钮（通常是一个闪电图标）或使用快捷键（默认为 Ctrl + Shift + B）来编译更改。
  3. 代码编译后，Unreal Editor 会自动应用这些更改，允许你立即看到效果。

关于刷新 Visual Studio 项目：

  • 不需要：在使用 Live Coding 时，你不需要在 Unreal Editor 中手动刷新 Visual Studio 项目。Live Coding 会处理代码的编译和应用。
  • 例外：如果你进行了更改，比如添加了新的类或模块，或者更改了 .uplugin 或 .uproject 文件，可能需要手动刷新 Visual Studio 项目。在这种情况下，你可以右键点击项目的 .uproject 文件并选择 "Generate Visual Studio project files"。

Live Coding 可以大幅提高开发效率，对于结构性更改，还是需要手动刷新项目。

详细步骤

步骤0：refresh Visual Studio Project and close editor

avoid risk squiggles and have auto completion back.

步骤1.include EditorUtilityLibrary.h and EditorAssetLibrary.h to your cpp file

假设你有一个插件 SuperManager，需要包含另一个插件 AssetActionUtility 的头文件 AssetActionUtility.h。如果直接在 QuickAssetAction.h 中包含 AssetActionUtility.h 可能会导致编译器找不到路径的问题。为了解决这个问题，你需要在 SuperManager.Build.cs 中添加 AssetActionUtility 的包含路径：

在C++项目中，编译器需要知道每个头文件的确切路径，才能正确找到并包含它们。出现 include 失败的情况，通常是因为编译器找不到头文件的路径。这可能是由于文件的组织结构、模块划分或插件的配置问题。在这种情况下，<PluginName>.Build.cs 中加入include path告诉编译器如何找到相关头文件。

PublicDependencyModuleNames.AddRange(
new string[]
{
"Core","Blutility","EditorScriptingUtilities"
// ... add other public dependencies that you statically link with here ...
}
);

步骤2. 在QuickAssetAction.h中声明BatchAssets的Function

// QuickAssetAction.h

#pragma once

#include "CoreMinimal.h"
#include "UObject/NoExportTypes.h"
#include "QuickAssetAction.generated.h"

UCLASS(Blueprintable, BlueprintType)
class YOURPLUGIN_API UQuickAssetAction : public UObject
{
    GENERATED_BODY()

public:
    // 第一个按钮对应的函数
    UFUNCTION(CallInEditor, Category = "Asset Actions")
    void ExecuteFirstAction();

    // 第二个按钮对应的函数
    UFUNCTION(CallInEditor, Category = "Asset Actions")
    void ExecuteSecondAction();
};

步骤3.QuickAssetAction.cpp中，

  • 调用 UEditorUtilityLibrary 提供的 GetSelectedAssetData() 函数，获取当前在编辑器中选中的所有资产的数据，并将这些数据存储在名为 SelectedAssetsData 的动态数组中。
  • 声明一个名为 Counter 的无符号 32 位整数变量，并将其初始值设置为 0
TArray<FAssetData>SelectedAssetsData = UEditorUtilityLibrary::GetSelectedAssetData();
uint32 Counter = 0;

解释：

1. TArray<FAssetData> SelectedAssetsData = UEditorUtilityLibrary::GetSelectedAssetData();

  • TArray<FAssetData>:

    • TArray 是 Unreal Engine 中的动态数组模板，用于存储同类型的数据。
    • FAssetData 是一个结构体，包含有关资产的信息，如资产的路径、类、标签等。

  • SelectedAssetsData:

    • 这是一个变量名，用于存储获取到的选中资产的数据。

  • UEditorUtilityLibrary::GetSelectedAssetData():

    • UEditorUtilityLibrary 是 Unreal Engine 提供的一个实用工具库，包含许多用于编辑器扩展和工具开发的静态函数。
    • GetSelectedAssetData() 是 UEditorUtilityLibrary 中的一个静态函数，用于获取当前在编辑器中选中的资产的数据。它返回一个 TArray<FAssetData> 类型的数组，包含所有选中的资产信息。

  • 综合起来:

    • 这一行代码的作用是调用 UEditorUtilityLibrary 提供的 GetSelectedAssetData() 函数，获取当前在编辑器中选中的所有资产的数据，并将这些数据存储在名为 SelectedAssetsData 的动态数组中。
2. uint32 Counter = 0;

  • uint32:

    • 这是一个无符号的 32 位整数类型，表示可以存储从 0 到 4,294,967,295 的整数值。
    • uint32 是 Unreal Engine 和 C++ 中常用的数据类型之一。它代表一个无符号的 32 位整数，即只能存储非负整数，范围是 0 到 4,294,967,295。无符号类型的好处是它能提供比有符号类型（如 int32）更大的正数范围，但不能表示负数。

  • Counter:

    • 这是一个变量名，通常用于作为计数器在循环或其他需要计数的场景中使用。

  • = 0;:

    • 这是对变量 Counter 进行初始化，将其值设置为 0。

  • 综合起来:

    • 这一行代码的作用是声明一个名为 Counter 的无符号 32 位整数变量，并将其初始值设置为 0。这个计数器可能会在后续的代码中用于跟踪某些操作的次数，比如处理选中的资产数量。

示例应用

假设你正在编写一个函数，用于对选中的资产进行批量操作，比如批量复制资产。你可以使用 SelectedAssetsData 来获取所有选中的资产，然后使用 Counter 来记录已经处理的资产数量。

错误代码和主要问题

void UQuickAssetAction::BatchDuplication(int32 NumOfDuplicates)
{
if (NumOfDuplicates<=0) {
Print(TEXT("Pls enter a valid number"), FColor::Red);
return;
}

TArray<FAssetData>SelectedAssetsData = UEditorUtilityLibrary::GetSelectedAssetData();
uint32 Counter = 0;

for (const FAssetData& SelectedAssetData : SelectedAssetsData)
{
for (int32 i = 0; i < NumOfDuplicates; i++) {
const FString SourceAssetPath = SelectedAssetData.ObjectPath.ToString();
const FString NewDuplicationAssetName = SelectedAssetData.AssetName.ToString() + TEXT("_") + FString::FromInt(i + 1);//在代码中声明了 NewDuplicationAssetName，但在 FPaths::Combine 中使用了 NewDuplicatedAssetName，导致未定义标识符错误。
const FString NewPathName = FPaths::Combine(SelectedAssetData.PackagePath.ToString(), NewDuplicatedAssetName);

UEditorAssetLibrary::DuplicateAsset(SourceAssetPath, NewPathName)
{//你在调用 UEditorAssetLibrary::DuplicateAsset 后使用了 {}，这在C++中是不合法的。正确的做法应该是检查 DuplicateAsset 的返回值，然后在条件语句中执行相关操作。
UEditorAssetLibrary::SaveAsset(NewPathName, false);
++Counter;
}
}
}

if (Counter > 0)
{
Print(TEXT("Successfully duplicated" + FString::FromInt(Counter) + "files"), FColor::Green);
}


}

  1. 未定义标识符 NewDuplicatedAssetName：

    • 在代码中声明了 NewDuplicationAssetName，但在 FPaths::Combine 中使用了 NewDuplicatedAssetName，导致未定义标识符错误。

  2. DuplicateAsset 的使用方式错误：

    • 你在调用 UEditorAssetLibrary::DuplicateAsset 后使用了 {}，这在C++中是不合法的。正确的做法应该是检查 DuplicateAsset 的返回值，然后在条件语句中执行相关操作。

  3.≤（Unicode字符）

在如下的 cpp 文件中，条件语句使用了 ≤（Unicode字符），而不是标准的 <= 运算符。这会导致编译器将 NumOfDuplicates≤0 视为一个未定义的标识符，而不是一个比较表达式。

      4.Function按钮重复出现

         清理和重建项目：手动删除项目中的 Binaries、Intermediate 和 Saved 文件夹，然后重新编译项目。这些文件夹可能包含缓存的编译信息，导致旧代码未被正确移除。

修改了与 Unreal 反射系统相关的代码时，如 UFUNCTION 的声明和定义，要让你的修改（ UFUNCTION 的变动）在 编辑器面板 中生效，建议关闭 Live Coding 并全量编译，以确保新的反射数据被生成并在编辑器中反映。

步骤：

  1. 关闭 Unreal Editor（这很重要，确保旧的插件代码不再占用）。
  2. 打开 Visual Studio，然后点击菜单栏的 Build > Rebuild Solution，进行完整的项目重编译。
  3. 编译完成后，重新打开 Unreal Editor，查看修改是否已经在编辑器面板中生效。

正确代码

#include "AssetAction/QuickAssetAction.h"
#include "DebugHeader.h"
#include "EditorUtilityLibrary.h"
#include "EditorAssetLibrary.h"


void UQuickAssetAction::BatchDuplication(int32 NumOfDuplicates)
{
if (NumOfDuplicates<=0) {
Print(TEXT("Pls enter a valid number"), FColor::Red);
return;
}

TArray<FAssetData>SelectedAssetsData = UEditorUtilityLibrary::GetSelectedAssetData();
uint32 Counter = 0;

for (const FAssetData& SelectedAssetData : SelectedAssetsData)
{
for (int32 i = 0; i < NumOfDuplicates; i++) {
const FString SourceAssetPath = SelectedAssetData.ObjectPath.ToString();
const FString NewDuplicatedAssetName = SelectedAssetData.AssetName.ToString() + TEXT("_") + FString::FromInt(i + 1);
const FString NewPathName = FPaths::Combine(SelectedAssetData.PackagePath.ToString(), NewDuplicatedAssetName);

if(UEditorAssetLibrary::DuplicateAsset(SourceAssetPath, NewPathName))
{
UEditorAssetLibrary::SaveAsset(NewPathName, false);
++Counter;
}
}
}

if (Counter > 0)
{
Print(TEXT("Successfully duplicated" + FString::FromInt(Counter) + "files"), FColor::Green);
}


}

插件效果

———————————————————————————————————————————

参考链接：

"Could not be compiled. Try rebuilding from source manually." - Ask - GameDev.tv

https://www.pome.cc/tips/livecoding/


原文地址：https://blog.csdn.net/charon8778/article/details/142421108

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

相关文章

自学内容网
Copyright © 2015-2024