UPROPERTY可以让我们在c++类中的成员在被声明的同时可以控制它在ue4编辑器中的交互方式和属性.
首先,我们在UE4编辑器里面新建一个c++类,名叫 MyActor.之后我们使用UPROPERTY宏来将成员变量反射到UE4编辑器中去.
UPROPERTY()中的括号可以含有属性说明符和元数据说明符(meta).
下面是几个常用的
属性说明符:
AdvancedDisplay:属性将出现在面板的”高级”下拉菜单中
BlueprintReadOnly:在蓝图中只读
BlueprintReadWrite:在蓝图中可以读写
EditAnywhere:在任意面板可以编辑,与任意处可见不兼容
EditDefaultsOnly:只能在类默认面板中可以编辑,与任意处可见不兼容
VisibleAnywhere:任意面板可见,与Edit…不兼容
VisibleDefaultsOnly:类默认面板可见,与Edit…不兼容
VisibleInstanceOnly:类实例化后可见,在原型的面板中不可见
EditInstanceOnly:类实例化后才可编辑
Category = “…”:将属性分类
BlueprintCallable:仅用于组播委托,公开属性,使其可以在蓝图中调用
下面是常用的
元数据说明符
:
ClampMin or ClampMax =“N” 指定最大最小值
如果需要更详细全面的属性说明符和元数据说明符看官方文档:游戏性架构-属性-属性说明符.
在下面的代码块中,TestVar 是一个公有int32类型的变量,它可以在任意面板被编辑,蓝图可读可写,被分类到”BP Normal Var”中,而且最小值为10最大为20
// Fill out your copyright notice in the Description page of Project Settings.
#pragma once
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "MyActor.generated.h"
UCLASS()
class BPTEST_API AMyActor : public AActor
{
GENERATED_BODY()
public:
// Sets default values for this actor's properties
AMyActor();
public:
UPROPERTY(EditAnywhere,BlueprintReadOnly, Category = "BP Normal Var",meta = (ClampMin = "10",ClampMax = "20",InstanceEditable = true))
int32 TestVar;
protected:
// Called when the game starts or when spawned
virtual void BeginPlay() override;
public:
UFUNCTION(BlueprintCallable)
void BPTestFunc();
UFUNCTION(BlueprintPure)
void BPTestFunc1();
UFUNCTION(BlueprintNativeEvent)
void BPNativeEvent();
UFUNCTION(BlueprintImplementableEvent)
void BPNeedOverrideEvent();
void BPNativeEvent_Implementation();
// Called every frame
virtual void Tick(float DeltaTime) override;
};
使用UFUNCTION反射函数到蓝图:声明函数时,可以为函数添加函数说明符
常见的函数说明符有:
BlueprintCallable:表示该函数在蓝图中可执行
BlueprintPure:表示该函数为不影响任何actor的纯函数(PureFunction)
BlueprintImplementableEvent
:可以在蓝图中进行重载,但是在c++中无原始定义,相当于一个纯虚函数
BlueprintNativeEvent:
:可以在蓝图中进行重载,在c++中有原始定义,相当于一个虚函数;使用这类函数要在c++中定义一个实现体,命名格式为: FunctionX_Implementation(),如果声明了有BlueprintNativeEvent函数说明符的函数却不定义和声明实现体,编译器会报错.
除此之外,声明函数时也可以为止添加元数据说明符(声明结构体,类,枚举值等都可以添加元数据说明符),例如Category = “Function” 表示将这个函数分类到”Function”中