本文仅作为个人在学习过程中的记录,如有错误,欢迎指出!

场景

假设项目里有这样一个类。

UCLASS()
class UReflectionHero : public UObject
{
    GENERATED_BODY()

public:
    UPROPERTY()
    float Health = 100.f;
};

如果已经有了 UReflectionHero*,可以直接访问

float Value = Hero->Health;

因为编译器已经知道 Hero 的类型,可以直接读取其成员变量。

但若是一个属性查看工具,既要查看组件,也要查看武器。对于 UObject 对象,它的声明里肯定不会存在

Object->Health:UObject

因此,需要借助 UE 的反射系统获取,大致过程是:

问 Object:你的实际类型是什么?       → GetClass()
问这个类型:有没有叫 Health 的属性?   → 查找 FProperty
拿属性描述(元数据)读取 Object 里的血量。       → 属性读写接口

元数据:描述数据的数据。

编辑器是如何知道这个 Object 的值的

#include "UObject/Class.h"
#include "UObject/UnrealType.h"

static bool TryReadHealth(UObject* Object, float& OutHealth)
{
    if (!IsValid(Object))
    {
        return false;
    }

    // 第一步:拿到这个对象的实际类型描述。
    UClass* Class = Object->GetClass();

    // 第二步:在类型描述中,找名叫 Health 的 float 属性。
    FFloatProperty* HealthProperty = FindFProperty<FFloatProperty>(Class, FName(TEXT("Health")));

    if (!HealthProperty)
    {
        return false;
    }

    // 第三步:用这个描述,读取当前 Object 里的值。
    OutHealth = HealthProperty->GetPropertyValue_InContainer(Object);
    return true;
}

因此,假设 HeroA、HeroB 已经是有效对象,血量分别为 100 和 35:

float Value = 0.f;

TryReadHealth(HeroA, Value); // 成功时,Value 变成 100。
TryReadHealth(HeroB, Value); // 成功时,Value 变成 35。

FindFProperty

在 Class 所描述的类型中,查找名字为 Health、描述类型为 FFloatProperty 的属性。

InContainer

“装着这个成员的那块内存”,接口只是需要知道:从谁身上读这个成员?

如何读 Health?

对象起始地址 + 偏移量

img

示意图:两个对象共享同一份属性描述,但各自存储不同的 Health 值。

对应的具体函数:

float* HealthAddress = HealthProperty->ContainerPtrToValuePtr<float>(Object);
float Value = *HealthAddress;

先取地址,再读值。

如何写 Health?

假设已经找到了 Health 的描述 HealthProperty,需要指定修改哪个对象的值:

HealthProperty->SetPropertyValue_InContainer(HeroA, 80.f);

如果是一个未知属性,如何判断类型?

通常情况下,属性面板开始拿到的是一个 FProperty,之后才判断它的类型。

// 假设 Object 有效。
FProperty* Property = FindFProperty<FProperty>(Object->GetClass(), FName(TEXT("Health")));

if (FFloatProperty* FloatProperty = CastField<FFloatProperty>(Property))
{
    float Value = FloatProperty->GetPropertyValue_InContainer(Object);
}

FProperty 都是继承自 FField 的,因此使用 CastField。

但这里有一个疑问,因为不知道属性类型,又怎么确定该 CastField 什么类型呢?

CastField<FFloatProperty> 只是尝试一种可能,并不是已经确定它是 float。

通用属性面板会预先支持若干种类型,然后逐个判断:

if (FFloatProperty* FloatProperty = CastField<FFloatProperty>(Property))
{
    // 确认是 float 属性,才按 float 读取。
    float Value = FloatProperty->GetPropertyValue_InContainer(Object);
    // 显示浮点数输入框……
}
else if (FIntProperty* IntProperty = CastField<FIntProperty>(Property))
{
    int32 Value = IntProperty->GetPropertyValue_InContainer(Object);
    // 显示整数输入框……
}
else if (FBoolProperty* BoolProperty = CastField<FBoolProperty>(Property))
{
    bool Value = BoolProperty->GetPropertyValue_InContainer(Object);
    // 显示复选框……
}
else
{
    // 其他类型继续处理,或显示“暂不支持”。
}