在本篇日志中,我们将要用一个C++类来实现一个游戏内的物品,同时介绍UCLASS、USTRUCT、UPROPERTY的使用
一、创建一个C++类
我们在UE5的"内容侧滑菜单"中,在右侧空白中右键选择"新建C++类",然后可以选择一个想要的父类,这里我们要实现的是物品,所以选择Object类作为父类
在"类的类型"中选择公共,使其能够被其他模块调用
二、在.h文件中声明变量
在VS中打开我们刚刚生成的.h文件,"#pragma once"表示这个.h无论被包含多少次,都只会编译一次,"第三个头文件是必须最后一编译的头文件,所以如果要新添头文件,必须放在这个头文件前面。
cpp
#pragma once
#include "CoreMinimal.h"
#include "UObject/NoExportTypes.h"
#include "Stardust.generated.h"
接着在下面可以看到一个"UCLASS"宏,表明接下来所声明的类将会暴露给UE5的反射系统。
"Blueprintable"表示这个c++类可以派生出蓝图类。
"GENERATED_BODY()"表示不继承父类的构造函数,要想继承父类的构造函数,需要替换为"GENERATED_UCLASS_BODY()"
cpp
UCLASS(Blueprintable)
class ASTROMUTATE_2_API UStardust : public UObject
{
GENERATED_BODY()
public:
};
接下来我们创建一个结构体来表示物品的各个属性,在结构提前用USTRUCT宏将该结构体暴露给反射。
"BlueprintType"表示该结构体可以作为蓝图中的一种数据类型。
暴露给反射系统的结构体名称必须以F开头,在UE编辑器中该结构体的名称将不包含首字母F,同时须使用"GENERATED_USTRUCT_BODY"宏。
cpp
USTRUCT(BlueprintType)
struct FStardustTable
{//星尘数据
GENERATED_USTRUCT_BODY()
FStardustTable();
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StardustStruct")
FString StardustName;//名称
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StardustStruct")
EStardustFormEnum StardustForm;//形态
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StardustStruct")
int StardustStackLimit;//堆叠上限
//为增加可读性,这里只展示了物品的部分属性
};
接下来我们先声明一个构造函数,用于在物品生成时初始化属性。
要声明暴露给反射系统的变量,需要使用"UPROPERTY"宏。
"EditAnywhere"表示该变量在编辑器中的类默认设置和实例化细节面板中都可以被编辑,"Edit"也可以替换成"Visible",表示该变量只读。
"BlueprintReadWrite"表示该变量在蓝图中可以获取和设置,可将"ReadWrite"替换为"ReadOnly"表示该变量在蓝图中尽可获取。
"Category"可以设置该变量所处的目录。
第一个声明的变量为FString,该数据类型与stl中的string类似,为可修改的字符串。
第二个声明的变量是一个枚举,枚举的定义同样需要先使用"UENUM"宏将其暴露给反射。
"BlueprintType"表示该枚举可以作为蓝图中的数据类型。
"UMETA"中可以定义枚举内容在蓝图中显示的名称。
cpp
UENUM(BlueprintType)
enum class EStardustFormEnum//形态
{
Empty UMETA(DisplayName = "Empty"),
Type1 UMETA(DisplayName = "Type1"),
Type2 UMETA(DisplayName = "Type2"),
Type3 UMETA(DisplayName = "Type3"),
};
未完待续