Unreal Engine 5 C++: Asset Batch Duplication插件编写02

news/2024/9/22 23:13:10 标签: 游戏引擎, 虚幻, 引擎插件

目录

准备工作

"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，查看修改是否已经在编辑器面板中生效。

正确代码

新建项，添加一个DebugHeader.h声明print功能

#pragma once

void Print(const FString& Message, const FColor& Color)
{
	if (GEngine)
	{
		GEngine->AddOnScreenDebugMessage(-1, 8.f, Color, Message);
	}
}

void PrintLog(const FString& Message)
{
	UE_LOG(LogTemp, Warning, TEXT("%s"),*Message);
}
#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);
	}
		

}

插件效果

重要DEBUG

如果遇到旧的UFUNCTION遗留的问题（代码中已删除，编辑器仍显示按钮）

  • 先热重载，
  • 再去EUB里重新解绑和绑定一下parent class。（EUB的设置见专栏上一篇，是用于debug editor页面不显示Scriptable Asset Action

在ctrl shift B编译visual studio时，一定先关闭 Unreal Editor，原因如下：

1. 防止文件冲突和锁定

  • Unreal Editor 会锁定文件：当 Unreal Editor 打开时，它会加载大量资源、编译的 DLL、模块等。如果你在编译过程中，这些文件可能已经被编辑器使用或锁定，导致 Visual Studio 无法正确访问和覆盖这些文件，可能会出现编译失败或冲突错误。
  • DLL 文件被使用：如果你正在修改插件或模块的代码，编译后会生成新的动态链接库（DLL）文件。在编译时，Visual Studio 需要替换这些 DLL 文件，但如果编辑器正在运行并使用这些文件，新的 DLL 无法被覆盖。

2. 确保资源和内存的一致性

  • 资源占用问题：当编辑器打开时，它会占用大量内存和处理资源。关闭编辑器可以腾出系统资源，保证 Visual Studio 编译时有足够的内存和处理能力，尤其是大型项目的编译。
  • 避免内存数据不同步：当编辑器运行时，可能会产生临时缓存或文件。而编译新代码后，这些缓存可能与新生成的代码不匹配，导致运行时出现错误或不一致的问题。

3. 避免热重载失败

  • 热重载机制的限制：Unreal Engine 具有热重载（Hot Reload）功能，允许在编辑器运行时重新编译代码并加载新版本的 DLL。然而，热重载机制并不完美，尤其是在涉及到大量代码或模块更改时，可能会引发编译失败、崩溃、编辑器状态不一致等问题。
  • 模块结构变化影响热重载：如果代码中涉及到模块、宏、类的定义变化，热重载可能无法正确识别这些更改。这种情况下，最好关闭编辑器，重新启动以加载新的代码。

4. 清除和重建项目

  • 避免编辑器缓存干扰：如果你想进行清理并完全重新构建项目，编辑器的某些缓存文件可能会干扰编译。关闭编辑器可以确保 Visual Studio 完全清理并重新生成所有文件，避免潜在的旧缓存问题。

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

参考链接：

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

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


http://www.niftyadmin.cn/n/5670964.html

相关文章

Python 中的 Socket 编程入门

Python 中的 Socket 编程入门

Python 中的 Socket 编程入门 Socket 编程是网络编程的重要组成部分&#xff0c;允许计算机通过网络进行通信。在 Python 中&#xff0c;使用内置的 socket 模块&#xff0c;开发者可以轻松地实现客户端和服务器之间的交互。本文将详细介绍 Python 中的 Socket 编程&#xff0…
阅读更多...
五、CAN总线

五、CAN总线

目录 一、基础知识 1、can介绍 2、CAN硬件电路 3、CAN电平标准 4、CAN收发器芯片介绍 5、CAN帧格式 ① CAN帧种类 ② CAN数据帧 ③ CAN遥控帧​编辑 ④ 位填充 ⑤ 波形实例 6、接收方数据采样 ① 接收方数据采样遇到的问题 ② 位时序 ③ 硬同步 ④ 再同步 ⑤ 波…
阅读更多...
【天怡AI-注册安全分析报告-无验证方式导致安全隐患】

【天怡AI-注册安全分析报告-无验证方式导致安全隐患】

前言 由于网站注册入口容易被黑客攻击&#xff0c;存在如下安全问题&#xff1a; 1. 暴力破解密码&#xff0c;造成用户信息泄露 2. 短信盗刷的安全问题&#xff0c;影响业务及导致用户投诉 3. 带来经济损失&#xff0c;尤其是后付费客户&#xff0c;风险巨大&#xff0c;造…
阅读更多...
C++ —— vector 的模拟实现

C++ —— vector 的模拟实现

目录 前言 1. vector深度剖析 2. 基础框架 3. 核心接口 3.1 reserve 3.2 push_back 和 pop_back 3.3 print 3.4 insert 3.5 erase 3.6 resize 4. 拷贝构造 4.1 构造与析构 4.2 拷贝构造 4.3 赋值重载 4.4 迭代器区间 5. 使用memcpy拷贝问题 前言 接:C —— 关于…
阅读更多...
算法:双指针题目练习

算法:双指针题目练习

文章目录 算法:双指针移动零复写零快乐数盛最多水的容器有效三角形的个数查找总价格为目标值的两个商品三数之和四数之和 总结 算法:双指针 移动零 定义两个指针,slow和fast.用这两个指针把整个数组分成三块. [0,slow]为非零元素,[slow1,fast-1]为0元素,[fast,num.length]为未…
阅读更多...
Unity 设计模式 之 创建型模式 -【单例模式】【原型模式】 【建造者模式】

Unity 设计模式 之 创建型模式 -【单例模式】【原型模式】 【建造者模式】

Unity 设计模式 之 创建型模式 -【单例模式】【原型模式】 【建造者模式】 目录 Unity 设计模式 之 创建型模式 -【单例模式】【原型模式】 【建造者模式】 一、简单介绍 二、单例模式 (Singleton Pattern) 1、什么时候使用单例模式 2、单例模式的好处 3、使用单例模式的…
阅读更多...
插入与冒泡排序(C++)

插入与冒泡排序(C++)

\一、插入排序 1 简介 插入排序&#xff0c;也称为直接插入排序&#xff0c;其排序思想和我们平时打扑克牌时排序类似。 2 算法步骤 将第一个元素看作已排序序列&#xff0c;第二个到最后一个看作未排序序列。 第二个元素&#xff0c;与之前已排序号的序列进行对比&#x…
阅读更多...
基于SpringBoot+WebSocket实现地图上绘制车辆实时运动轨迹图

基于SpringBoot+WebSocket实现地图上绘制车辆实时运动轨迹图

实现基于北斗卫星的车辆定位和轨迹图的Maven工程&#xff08;使用模拟数据&#xff09;&#xff0c;我们将使用以下技术&#xff1a; Spring Boot&#xff1a;作为后端框架&#xff0c;用来提供数据接口。Thymeleaf&#xff1a;作为前端模板引擎&#xff0c;呈现网页。Leaflet…
阅读更多...
最新文章

Copyright @ 2022~2023