【UE5】UFUNCTION【C++】

ヘッダーファイルの関数名にマウスを合わせ、右クリックすることで選択できる。
ソースファイルに処理を作成するためのテンプレートを自動的に作ってくれる。

右クリック>Quick Actions and Refactorings(VA)

たぶん、有料ソフトのVissual Assistを使っていないと無理。

①Event Graphで右クリック。良くやるやつ。

②FUNCTIONSの右のプラスボタンにホバーすると、Overrideのプルダウンメニューが現れる。

クラス名を右クリック>Quick Actions and Refactorings>Implement Virtual Method
Visual Assist(有料)の機能。クラスで使える関数を呼び出せる。

↓検索して、チェックをいれてOK。

↓自動的にコードが作成される。

ヘッダファイル

ソースファイル

１．親にしたいC++クラスを右クリック。
２．Create Blueprint class based on “親にしたいC++クラス”を選択。

Content Drawerで右クリック>Blueprint Classを選択。
Parent ClassをAll CLASSESから検索して、親にしたいC++クラスを選ぶ。

右クリック>Add call to parent function

（注意）
Native Event(My Destroy)を作成して、他のノードにつなげずに実行したらクラッシュした。
他のノードに繋げれば問題なく実行され、Parent Functionに繋げなくても問題はなかった。
Native Eventを作成しなければ、Parent Functionの処理だけを実行。

（関連）
子のブループリントを作ったとき、BeginPlayなどにデフォルトで接続されているノードも確かParent Function。
作り方が分からなかったので、親の処理を作りなおしていた。BeginPlayで右クリックすればParent Functionを作成できる。

記述の型

DisplayName="名前"

自作の関数名をDestroyにするとクラッシュした。C++において、もともと設定されている関数名だからだと思う。関数名ではなくDisplayNameをDestroyと設定するのなら問題ない。
例
MyActor.h

UFUNCTION(BlueprintNativeEvent, Category="Actor Functions", meta=(DisplayName="Destroy"))
void MyDestroy();
void MyDestroy_Implementation();

記述の型

ToolTip="説明"

ノードにマウスホバーした際にでる説明を記述できる。
例
MyActor.h

UFUNCTION(BlueprintNativeEvent, Category="Actor Functions", meta=(DisplayName="Destroy", ToolTip="The actor is destroyed when it reach the right limit."))
void MyDestroy();
void MyDestroy_Implementation();

記述の型

ShortToolTip="何か"

マウスホバーで表示されるわけではないらしい。いつどこで表示されるのか知りたい。見つかったら追記します。
例
MyActor.h

UFUNCTION(BlueprintCallable, Category="Actor Functions", meta=(HideSelfPin="true", ShortToolTip="Print the integer to the screen."))
void PrintInt(int32 Value);

ちなみにTEXT(” “)をつかって日本語を表示させようとしたが、コンパイルでエラーが出て無理だった。

記述の型

HideSelfPin="true"

Selfピンを消すことができる。Target(Self)のピン。
例
MyActor.h

UFUNCTION(BlueprintCallable, Category = "Actor Functions", meta=(HideSelfPin="true"))
int32 MultiplicationPure(int32 ValA, int32 ValB) const;

👇BlueprintCallableで作ったのにSelf Pinがない。

（参考）デフォルトではBlueprintCallableにはSelf Pinがある。

記述の型

const 型名 変数名

設定した変数が変化するとコンパイル時にエラーが出てくれる。
変化させたくない変数に対して設定する。

👇コンパイル時にエラー。

void AMyActor::PrintInt(const int32 value)
{
	value = 3;
	UKismetSystemLibrary::PrintString(this, FString::Printf(TEXT("Print Int %d"), value), true, true, FColor::Red, 10.0f);
}

（Valueに３を代入して、変数の値を変化させてしまっている）

👇これはコンパイル成功。constつけてないから。

void AMyActor::PrintInt(int32 value)
{
value = 3;
UKismetSystemLibrary::PrintString(this, FString::Printf(TEXT("Print Int %d"), value), true, true, FColor::Red, 10.0f);
}

記述の型

型名& 変数名

Outputピンの変数の型と変数名を設定できる。複数記述することで、複数のOutputピンを持たせることも可能。
例整数を2乗するノード

MyActor.h

UFUNCTION(BlueprintCallable, Category = "Actor Functions", meta = (HideSelfPin = "true", ToolTip = "Square the Integer."))
void SquareInt(const int32 Value, int32& SquaredValue);

MyActor.cpp

void AMyActor::SquareInt(const int32 Value, int32& SquaredValue)
{
SquaredValue = Value * Value;
}

👇Outputを複数に増やすのも簡単。

記述の型

クラス名* 変数名

*の後ろに&をつけるとOutputピンになる。

例入れたものを出すだけの簡単な仕事
MyActor.h

UFUNCTION(BlueprintPure, Category = "Actor Functions")
void ObjectReferencePure(AMyActor* InMyActor, AMyActor*& OutMyActor);

MyActor.cpp

void AMyActor::ObjectReferencePure(AMyActor* InMyActor, AMyActor*& OutMyActor)
{
OutMyActor = InMyActor;
}

Structureは、頭文字にFをつける。ベクトルは構造体の一種なので、VectorではなくFVectorになる。
これも型名の後ろに&をつけるとOutputピンになる。
例
MyActor.h

UFUNCTION(BlueprintPure, Category = "Actor Functions")
void InOutLocation(FVector InLocation, FVector& OutLocation);

MyActor.cpp

void AMyActor::InOutLocation(FVector InLocation, FVector& OutLocation)
{
OutLocation = InLocation;
}

GetActorLocationとか作ってみたかったけど、コンパイルエラーになって妥協した。

記述の型

UPARAM(ref) 型名& 変数名

&はついているけどInputピンになる。
例
MyActor.h

UFUNCTION(BlueprintCallable, Category = "Actor Functions", meta=(HideSelfPin="true"))
void ChangeFloat(UPARAM(ref) float& OldFloat, float NewFloat);

MyActor.cpp

void AMyActor::ChangeFloat(float& OldFloat, float NewFloat)
{
OldFloat = NewFloat;
}

👇スピードの変更ができる。

👇こんなのも作ってみたけど、よく考えたらコレ実行できない。

修正

親のクラスを変更できる。便利。

File>Reparent Blueprint