UE5から始める C++ & BP 10 【Blueprint版】Function(関数)

ポジTA

2022年1月25日 16:30

最初関数を作る意味がよく分かりませんでした。

10年前くらいのC言語のソースコードを新しいOSで動くようにするプロジェクトに参加した時に、1000行近いmain関数を読む機会がありました。

何をやっているか意味が分かりませんでした。

1000行も上から下に処理が書かれていると、意味が分からなくなります。

処理をまとめて関数化していきました。

あぁ、これはこういう処理なのか。

そうか！関数はこういうことが起こらないために作るのか。

やっと、関数を作る意味を知ることができました。

1000行のmain関数は極端な例ですが、後の人に理解してもらえるコードを書いていると未来の自分が助かります。

未来の自分を助けるプログラミングを心がけています。

前回は「Enumeration(列挙型)」方法について調査しました。
今回は「Function(関数)」方法について調査していきます。

【Blueprint版】Function(関数)

今回できること

[Add]ノードを再現するFunctionを作成します。

計算結果の出力処理をFunction化します。

学習用の新規レベル「Chapter_2_Function」を作成する

学習用の新規レベルを作成します。
[File]メニューから[New Level…]を選択します。

[Default]を選択します。

「Maps」フォルダに「Chapter_2_Function」を入力し、[Save]ボタンをクリックします。

Blueprintを複製する

「BP_FlowControl_SwitchEnum」を複製(Ctrl + W)して、「BP_Function」を作成します。

Function[Sum]を作成する

Blueprintの[Add]ノードを再現したFunction[Sum]を作成します。

Functionに[Sum]を追加します。
[My Blueprint]パネルのFunctionsカテゴリ右側の[+]をクリックします。
Functionが新しく作成されるので、名前を[Sum]に設定します。
GraphにはFunction名のノードが作成されます。
Functionの開始地点となるノードです。

InputとOutputを追加します。

Addノードを追加します

InputのA,Bを[Add]ノードで計算するように接続します。
[Add]ノードのOutputを[Return Node]の[ReturnValue]に接続します。

Function[Sum]をEvent Grapthに追加します。
追加方法は2種類あります。

[My Blueprint]からFunction[Sum]をDrag&Dropする。
メニューで[Sum]を検索して選択する。

Function[Sum]を実行するように、実行ピンを接続しなおします。
Function[Sum]のInput[A][B]に変数[CalcValueA],[CalcValueB]を接続します。
Function[Sum]のOutput[ReturnValue]を[IntegerからString変換]ノードに接続します。

Function[Sum]の実行ピンを通過するように、変数[CalcType]のDefaultValueを[Add]に変更します。

[Compile]ボタンをクリックします。

LevelEditorに戻り、「BP_Function」をViewportにDrag&Dropします。

Level Editorの[Play]ボタンをクリックします。

Function[Sum]で計算した結果が表示されます。

Functionを使用した時の処理の流れは図のようになります。

Function内でのみ使用できるLocal Variable(ローカル変数)を作成する

Functionでのみ使用できる変数「Local Variable(ローカル変数)」を使用します。

Local Variables[LocalResult]を作成します。
Function[Sum]を開きます。
Function[Sum]を開くと、[My Blueprint]パネルに[Local Variables]カテゴリが表示されます。
[Local Variables]カテゴリの[+]ボタンをクリックします。
追加されたLocal Variableの名前を「LocalResult」に設定します。

Local Variable[LocalResult]のSetノードを追加します。
Input[A],[B]の[Add]ノードの結果を[LocalResult]に設定します。
Function[Sum]の[ReturnValue]に[LocalResult]の値を設定します。

[Event Graph]に戻ると[Local Variables]カテゴリは表示されません。

[Local Variables]カテゴリはFunction内でのみ使用できる変数を宣言できます。

VariablesとLocal Variablesの違いについて

Function[Sum]のpure化(純粋化)

Blueprintの[Add]ノードのようにFunction[Sum]を実行ピンのないノードに変更します。

Function[Sum]のノードを選択し、[Detail]パネルから[Pure]のチェックボックスをチェックします。

[Pure]のチェックボックスにチェックが入ると、Function[Sum]の実行ピンがなくなります。

公式ドキュメントの純粋関数(Pure Function)の解説です。

関数は純粋関数または非純粋関数のどちらかになります。両者の大きな違いは、純粋関数がステートやクラスのメンバーを一切変更しないのに対し、非純粋関数はステートを自由に変更します。純粋関数は通常、データ値を出力するだけの getter 関数や演算子に使用されます。関数または演算子は、データ値を単に出力します。

純粋関数はデータピンへ接続され、依存するデータが要求されるとコンパイラにより自動的に実行されます。このため、純粋関数は接続先のノードにつき 1 回ずつ呼び出されます。純粋関数は以下のいずれかのメソッドを使って指定されます。
・コードで定義された関数に対する関数宣言のキーワードに BlueprintPure を指定します。
・ブループリントエディタで追加された関数の [Pure] のチェックボックスにチェックを入れます。