前提
身内用に書いたものを、暫定的に公開しているものです。何かおこったら閉じるかもしれません。
前の記事に書いた知識(ブループリントの最低限の知識)は持っている、という前提で書いてます。特に説明のない限り、Unreal Engine 4.25 で FirstPerson テンプレートで作成したプロジェクトのレベルブループリントのイベントグラフ上で操作をする前提です。
参考までに javascript や C# で同じ処理を書いたらどうなるかを併記しておきます(厳密にいうと同じではないこともあります。あくまでイメージです…)。
変数
ブループリントの変数には型があります。イベントグラフの中に書いた変数は、すべてインスタンス変数(的な扱い)になります。関数では、関数の中限定のローカル変数も宣言できます。
変数の宣言
var Counter; // javascript は型がないので厳密には同じではない
int Counter;
変数の宣言は、ブループリントのノードではなく、エディタの左にある「マイブループリント」の「変数」という項目の右にある+を押すことで追加できます。
+を押すと、デフォルトの変数名と型が自動的に設定されます。名前や型を変更するには、変更したい項目(変数)を選んで、右側に出る「詳細」のタブの中で編集します。
ここで「変数名」「変数の型」など、さまざまな項目を変更できます。
変数のデフォルト値(初期化時の値)を入れるためには、一度「コンパイル」アイコンを押します。
var Counter = 100;
int Counter = 100;
コンパイルを一度押すと、デフォルト値が設定できるようになります。変数の名前や型などを変更した後にデフォルト値を設定しなおす時は、再度コンパイルを押す必要があります。
変数への代入
Counter = 100;
Counter = 100;
代入したい変数名を左から選んでエディタ内にドラッグドロップします。Set か Get を選ぶメニューが出るので、Set を選びます。そして、設定したい値を直接入力して、実行の白い線をつなぎます。
上の例では Counter 変数に 100 という数値を設定しています。
変数の値の読み出し
Counter = Val;
Counter = Val;
値を読み出したい変数を左から選んでエディタ内にドラッグドロップし、Set か Get を選ぶメニューで Get を選びます。これで値を読み出すノードは作られますが、値を読むノードには実行の白いピンがありません。読み出した値を使う、別の白いピンがあるノードにつなぐことで、実際に値を読み出す処理がなされます。
変数の値の読み出しタイミング
読み出すノードから、白いピンのある複数のノードに接続した場合、変数からの値の読み出しは「白いピンのあるノードが実行されるタイミングで」評価されるため、同じ値にならないことがあります。
上のようなグラフの処理の結果、Counter の値は 10 になります。最初の Set Counter ノードが実行されるときは、その直前に Val に 0 が入っているので、Counter には 0 が代入されます。しかし、次の Set Counter ノードでは、直前に Val に 10 が代入されているので、Counter の値は 10 になります。
同じ Val のノードからそれぞれの Set Counter ノードに線が出ているので、一見して同じ値が入りそうですが、線のつなぎ方とは関係なく「白い線がつながっているノードが実行されるタイミングで」白い線がつながっていないノードの値が評価されるため、このような結果になります。
ちなみに、このように Get Val ノードを分けて書いても、実行結果は全く同じになります。
変数の型(主なもの)
- Boolean: false か true の二値をとる型
- Byte: 符号付8ビット整数型
- Integer: 符号付32ビット整数型。よく使います。
- Integer64: 符号付64ビット整数型
- Float: 浮動小数点型。よく使います。
- String: 文字列型
- Text: 使用言語の設定によって表示内容を変更できる文字列型
- Vector: 浮動小数点の三次元ベクトル型(位置座標などに使う) (float x, float y, float z) 。よく使います。
- Rotator: 浮動小数点の回転角を示す型(float x, float y, float z)
- Transform: アクターの位置、回転角、拡大率を保持する型(Vector Location, Rotator Rotation, Vector Scale)
配列は、変数の型の右にある、型を示す色の横棒みたいなアイコンを押すことで作れます。配列以外にマップ、集合などにもできます。配列については、後述の配列の項目で詳しく説明します。
変数の自動追加
他のノードから引き出した線の先で右クリックして「変数へ昇格」とすると、その型に対応するインスタンス変数を作成することができます。
上の例では、変数に昇格すると Integer 型の変数が追加されます。変数名は NewValue_0 のような適当な名前がつきます。名前を自分で変更すれば、その変数に関連するノードの名前も自動的に変更されます。
数値演算
加算
Counter = Counter + 1; // Counter ++; と同じ
Counter = Counter + 1; // Counter ++; と同じ
変数間の加算もできます。
Counter += Val;
Counter += Val;
加算のノードを出すには、右クリックしてから+または add と入力して検索します。加算のノードは、加算する変数の組み合わせによっていくつか種類が存在してます。Get Counter のノードから線を引き出してから検索すると、Get Counter の型 (Integer) を引数にもつ加算ノードだけが検索結果に出てくるので便利です。
Counter += Val + 2;
Counter += Val + 2;
「ピンを追加」を押すことで、加算する変数や数値の個数を増やすこともできます。
追加したピンを削除したい場合は、ピンの上で右クリックして「ピンを削除」を選びます。
減算
Counter -= Val;
Counter -= Val;
減算は「-」(ハイフン)または sub で検索できます。上側のピンの数値から、下側のピンの数値を引きます。徐算はピンの追加はできません。
積算
Counter *= Val;
Counter *= Val;
積算は「*」(アスタリスク)または mul で検索できます。積算もピンの追加ができます。
除算
Counter /= Val;
Counter /= Val;
徐算は「/」(スラッシュ)または div で検索できます。上のピンの値を下のピンで割ります。整数型の場合は、商の小数点以下は切り捨てられます。
0 で割ってもエラーにはならず、0 を結果として返すようです。 0/0 でも 0 を返してきます。
なお、徐算はピンの追加はできません。
剰余算
Counter %= Val; // Counter = Counter % Val;
Counter %= Val;// Counter = Counter % Val;
剰余は「%」(パーセント)または mod で検索できます。上のピンの値を下のピンで割ったあまりを計算します。整数型でのみ使えます。剰余算もピンの追加はできません。
円周率
円周率は GetPi です。
ノードの見掛けは上のような感じです。
べき乗、四捨五入
べき乗は Power、四捨五入は Round、小数点以下切り捨ては Floor です。
平方根を得る sqrt というノードもあります。
三角関数
引数を Degree か Radian かで異なるノードになります。Sin, Cos, Tan, Asin, ACos, Atan があります。
ATAN だけは X,Y を別々に指定できる ATAN2 というノードがあります。また、なぜか ATAN は他の桟価格関数ノードと形状が違っています。(実用上の問題はありません、多分)
乱数
乱数は Random で検索できます。型や条件によってさまざまな種類があります。
上の左は、0 以上 100 以下の実数の乱数を発生させます。右は 0 以上 100 以下の整数の乱数を発生させます。
乱数のノードから右にピンを複数引き出した場合、出力ピンごとに異なる数値が出力されます。
乱数ノードから直接複数の線を出すのでない場合でも、たとえば上のよう感じで乱数の出力先のノードで複数に分岐している場合でも異なる値になります。上のプログラムを実行すると、二つの PrintText で異なる数字が表示されることがあります。
乱数はわかっていても非常にバグりやすいので、多少冗長に見えても複数の線が出ないように、ノードを個々に分けたほうが安全だと思ってます。
対数、指数関数
一般の対数は Log、自然対数は Loge、指数関数は Exp で検索できます。自然対数の底の値を得たいときは、Exp ノードの引数を 1 にして得ます。
ちなみに Log 0 を計算させてもエラーにならず、Float の負の最小値を返すようです。
算術演算の組み合わせ
計算順序を示すカッコに相当するノードはありません。
Counter = (1 + 2) * (3 + 4);
Counter = (1 + 2) * (3 + 4);
ノードを接続する順序で、演算する順序が決まります。
Counter = 1 + 2 * 3 + 4;
Counter = 1 + 2 * 3 + 4;
他のプログラミング言語では書きにくい(変な?)計算式も書けます。
var tmp0 = Counter + Val;
var tmp1 = tmp0 + 1;
var tmp2 = tmp1 + tmp0;
Counter = tmp2 + tmp1;
int tmp0 = Counter + Val;
int tmp1 = tmp0 + 1;
int tmp2 = tmp1 + tmp0;
Counter = tmp2 + tmp1;
このプログラムで、Val のデフォルト値を 0 にして Counter のデフォルト値を 1 にすると、5 が Counter に代入されます。javascript や C# で手続き的にこの計算式を計算しようとすると、上記のような一時変数が必要になりますが、ブループリントは演算の結果を変数にいれずとも再利用できるので、上記のような計算式の書き方も可能です。(嬉しいかは別として)
あくまで、このような書き方も可能だということであって、このように描くのを推奨するわけではありません。前述したように、値の評価は「白いノードが実行されるタイミングで決まる」ため、複雑な線の出し方をすると、予期しないバグが発生することがあります。上のほうに書いた乱数の例がいい例です。
ベクトル関係の演算
Vector 型の変数に使える、さまざまな演算ノードがあります。
上のほうに書いた算術演算を使わなくても、一発で計算できるノードがいろいろあります。ベクトル関係の計算をしたい場合は、ベクトル回りのノードを先に調べてみるといいかもしれません(丸投げ)。
条件分岐
条件分岐には Branch (ブランチ)というノードを使います。他言語の IF 文に相当します。
if ( Val == 0 ){
Counter = 0;
}else{
Counter = 1;
}
if ( Val == 0 ){
Counter = 0;
}else{
Counter = 1;
}
ブランチの左側の赤いピンに、論理演算ノードの計算結果の Boolean の値を入れます。Boolean の値が true なら上のピンの先が実行され、false なら下のピンの先が実行されます。
論理演算
だいたい他の言語と同じような論理演算が使えます。
等しい
==またはequalで検索できます。
if ( Val == 0 ){ ... }
if ( Val == 0 ){ ... }
不等号
<やlessで検索できます。>の場合は、>またはgreaterで検索できます。
if ( Val < 0 ){ ... }
if ( Val < 0 ){ ... }
、不等号その2
=<やlessで検索できます。>=の場合は、>=またはgreaterで検索できます。
if ( Val <= 0 ){ ... }
if ( Val <= 0 ){ ... }
不一致
!=または NotEqual で検索できます。
if ( Val != 0 ){ ... }
if ( Val != 0 ){ ... }
論理積(AND)
AND はピンが増やせます。
if ( Val >= 90 && Val <= 100 ){ ... }
if ( Val >= 90 && Val <= 100 ){ ... }
論理和(OR)
OR もピンが増やせます。
if ( Val == 0 || Val == 10 ){ ... }
if ( Val == 0 || Val == 10 ){ ... }
その他の論理演算ノード
NOT,NAND,NOR,XOR もあります。説明は省略します。
switch-case 的な条件分岐
変数の値によって、処理内容を変更するような、いわゆる switch-case 文的な条件分岐も書けます。
switch で検索することでノードを設置できます。ピンを増やすことで、入力が 0 の場合、1 の場合・・・というように条件を増やしていけます。ピンを増やした時の数字は 0, 1, 2, というように順番にしか増えないので、たとえば 0 と 100 の時だけ条件分岐したい、みたいなことは、このノードではやりにくいです(ピンを101個作ればできますが・・・)。
このように、文字列の内容で分岐できる条件分岐ノードもあります。文字列を使った条件分岐ノードは、右側の「詳細」のところでマッチさせる文字列を指定できます。
型変換(キャスト)
型が異なる変数に値を代入するには、型変換をする必要があります。型の変換が自明なときは、型が違うピンにつないだときに、自動的に型変換のノードをエディタが挟んでくれます。
上の例では、Text 型を引数にとる PrintText ノードの Text 型のピンに、Integer 型のピンを接続しています。接続した瞬間、Integer 型から Text 型に変換するノードが作られています。
というか、自明でない(自動で型変換してくれない)場合は自分で型を変換する関数を書いたりする必要がある場合がほとんどです。
なお、型変換のことを他言語では「(型)キャスト」と呼ぶことがありますが、ブループリントでキャストというと、オブジェクトの型をチェックする(C# や javascript の instanceof の強化版のような)機能のことを言うことが多いです。
続く
次回は繰り返し(ループ)、ブループリント特有の制御構文(ぽいもの)、配列あたりについて書く予定です。