Unreal Engine 5 ドキュメントは Epic Developer Community に移動しました

Unreal Engine 4.26

Unreal Engine 4.27

Unreal Engine 5.0

Unreal Engine 5.1

Unreal Engine 5.2

Unreal Engine 5.3

> プログラミングとスクリプト処理 > ブループリントビジュアルスクリプティング > スクリプト処理の基礎 > ブループリント変数

Light Theme

Dark Theme

ブループリント変数

ワールド内のオブジェクトやアクタの値またはリファレンスをもつプロパティです。

Intermediate

Choose your operating system:

Windows

macOS

Linux

変数の型

変数は、Boolean、integer、float などのデータ型や、オブジェクト、アクタ、特定クラスなどを保有するリファレンス型など、様々な型での作成が可能です。それぞれの変数型の配列も作成することができます。それぞれの型は区別しやすいように色分けされています。


変数型	色	意味
Boolean	マルーン	True 値または false 値 ( `bool` )。
Byte	シェルパブルー	0 から 255 の間の整数値 ( `unsigned charSherpa blue` )。
Integer	シーグリーン	2,147,483,648 と 2,147,483,647 の間の整数値 ( `int` )。
Integer64	モスグリーン	9,223,372,036,854,775,808 と 9,223,372,036,854,775,807 の間の整数値 ( `long` )。
Float	イエローグリーン	0.0553, 101.2887, と -78.322 などの小数のある数値 ( `float` )。
Name	モーブ	ゲームで何かを特定するために使用されるテキストの構成要素。
String	マゼンタ	マジェンタ (赤紫) 色の変数は文字列または Hello World などの英数字を表します。
Text	ピンク	ピンクの変数は表示されたテキストデータを表します。ローカライズ対象のテキストに使用してください。
Vector	ゴールド	3 軸を設定します (X, Y, Z)。3D 座標と RGB 色データを使う場合に便利です。
Rotator	紫を帯びた淡い青色	3D 空間の回転を定義するローテータ―のデータを表します。
Transform	オレンジ	平行移動 (3D 位置)、回転、スケーリングを組み合わせた変位データを表します。
Object	青	ライト、アクタ、スタティックメッシュ、カメラ、サウンドキューなどのオブジェクトを表します。

My Blueprint タブの変数

[My Blueprint] タブには、カスタム変数をブループリントへ追加することができ、コンポーネントリストに追加されたコンポーネントインスタンス変数やグラフで値を変数に昇格させて作成した変数など、存在するすべての変数が一覧表示されます。

変数の作成手順

ブループリント内での変数の作成は、以下の手順で行うことができます。

ブループリントを作成し、 [Graph] タブで開きます。
[MyBlueprint] ウィンドウからブループリントの変数を作成するには、変数リストヘッダー上にある 追加ボタン
新しい変数が作成され、名前の入力を求められます。

変数名を入力し、 [Details (詳細)] パネルに進んで変数のプロパティを調整します。
[Details (詳細)] パネルには、変数の使用とアクセスの方法を定義する設定がいくつかあります。

変数の デフォルト値 を設定するには、まずブループリントを コンパイル する必要があります。


オプション	説明
Variable Name	変数の名前です。
Variable Type	ドロップダウンメニューから変数の型を設定し、変数が配列かどうかを判断します。
Instance Editable	ブループリントのインスタンス上で変数がパブリックで編集可能かどうかを指定します。
Blueprint Read Only	変数がブループリントノードで設定可能か、それとも読み取り専用かを指定します。
Tooltip	変数上にカーソルがあると変数の追加情報が表示されます。
Show 3D Widget	true の場合、ユーザーはビューポートの 3D トランスフォームウィジェットを使ってベクターを調整できます。このオプションは vector 型と Transform 型に適用されます。 Instance Editable が選択された場合のみ有効です。
Expose on Spawn	ブループリントをスポーン時にピンとして変数をエクスポーズします。
Private	この変数をプライベートにします (派生ブループリントによる修正不可)。
Expose to Cinematics	変数を変更するためにシーケンサーまたは Matinee に公開するかどうかを指定します。
Config Variable	config ファイルから変数を設定することができます。
Category	与えられたラベル毎に変数を分類することができます。変数はラベル毎にソートされます。
Replication	この変数をネットワーク上でレプリケーションするか否かを指定します。

[Details (詳細)] パネルを展開して、シリアル化のオプションを定義することができます。

Transient オプションあｈ、読み込み時に変数をシリアル化してゼロを入れるかどうか設定します。 SaveGame オプションは、保存したゲームの変数をシリアル化するかどうか設定します。

Public 変数

変数が存在するブループリントの外部から変数を修正するには、変数を public にします。

デフォルトでは、目のアイコンが閉じているので (private)、選択して目のアイコンを開いて public にします。 [Instance Editable (インスタンスを編集可能にする)] ボックスを選択または選択を解除して、変数を private または public にします。

変数を public にした後、メインのエディタウィンドウの [Details (詳細)] パネルから値を変更できます。

上の画像では、変数、 LightColor が編集可能に設定されているので、レベルエディタの [Details (詳細)] パネルで値を設定できます。

変数のツールチップ

変数上にマウスを当てて、表示された変数の ツールチップ をエディタに追加することもできます。

その変数の [Details (詳細)] パネルからでも ツールチップ の追加が可能です。ツールチップが追加されると、その変数が Public 設定の場合、目のアイコンが黄色から緑に変化します。これは、その変数に対してツールチップが書き込まれたことを示しています。

スポーン時に公開

[Expose on Spawn (スポーン時に公開)] は、変数が存在するブループリントのスポーン時に、その変数をアクセス可能にするかを設定します。

上の画面には LightColor という変数があります。これは [Expose on Spawn (スポーン時に公開)] に設定される Linear Color プロパティです。この変数は Set Light Color ノードと LightColor 変数を使用してライトの色を決める Point Light ブループリントに実装されます。

以下は、Point Light ブループリントをスポーンするためにスクリプトを使用した別のブループリントです。 LightColor 変数がスポーン時に公開される設定になっているので、この値を設定するオプションは Spawn Actor from Class ノードで利用でき、ゲームワールドでスポーンするライトの色を設定することができます。

プライベート変数

変数上で [Private] オプションにチェックを入れると、外部ブループリントから変数を修正できなくなります。

例えば、以下のようにプライベートに設定されていない変数があったとします。

別のブループリント内で、この変数を含むブループリントのスポーンを選択して、 Return Value から変数にアクセスすることができます。

しかし、Private で設定しておくと、以下のようになります。

ブループリントを再度スポーンしようとし、アクセスできなかった変数へのアクセスを再度試みます。

シネマティクスに公開

変数値を シーケンサー または Matinee で調整したい場合は [Expose to Cinematics (シネマティクスに公開)] を選択します。

シーケンサーの詳細については、「シーケンサーエディタ」を参照してください。

4.23 現在、Matinee は UE4 でサポートされておらず、近い将来エンジンから除外される予定です。除外されると、 Matinee の実行や、Matinee エディタを開くことができなくなります 。
ファイルをシーケンサーにできるだけ早く変換するには、 Matinee からシーケンサーへの変換ツールを使用します。

変数へ昇格させる

[Promote to Variable (変数へ昇格] を使用しても、変数の作成が可能です。

ブループリントノードの任意の入出力ピン上で右クリックして [Promote to Variable] オプションを選択します。

New Light Color ピンを右クリックして [Promote to Variable] を選択すると、変数に New Light Color を割り当てることができます。

または入出力ピンをドラッグして [Promote to Variable] を選択することができます。

ブループリントで変数にアクセスする

ブループリントで変数を使用するには、 Get ノード (ゲッターと呼びます) を使用して変数の値を取得するか、 Set ノード (セッターといいます) を使用して変数の値を設定するかの、いずれかの方法で行います。

変数に対して Set ノード (上の 1) または Get ノード (上の 2) を作成するには、グラフ内で 右クリック して、Set (変数名) または Get (変数名) と入力します。あるいは、 Ctrl キーを押して MyBlueprint ウィンドウから変数をドラッグして Get ノードを作成するか、または Alt キーを押して MyBlueprint ウィンドウから変数をドラッグして Set ノードを作成する方法もあります。

変数の編集

変数値はブループリントノードネットワークの一部として、あるいはデフォルト値として実行前に設定することができます。デフォルト値を設定する方法は以下の通りです。

ブループリントエディタの [Class Defaults (クラスデフォルト)] をクリックし、 [Details (詳細)] パネルでデフォルトを開きます。
[Details (詳細)] パネルで変数名の右側に任意のデフォルト値を入力します。

上の画面では、デフォルトカラーを設定できる Color 変数をハイライトしています。

デフォルトに変数が表示されない場合、 [Compile (コンパイル)] ボタンをクリックしているか確認してください。

変数名の変更

変数名は以下の方法で変更します。

[My Blueprint] タブで変数名を 右クリック し、表示されたメニューから [Rename (名前変更)] を選択します。
テキスト欄に新規変数名を入力し、 [Enter] を押します。

変数のプロパティ

[Details (詳細)] パネルで変数に関する全てのプロパティを設定できます。変数によっては、ベクターの Expose to Cinematics や Integers または Floats といった数値変数の Slider Range など、他にもさまざまなプロパティがあります。


プロパティ	説明
Variable Type	ドロップダウンメニューから変数の型を設定し、変数が配列かどうかを判断します。
Instance Editable	クラスのデフォルトとブループリントの [Details (詳細)] タブで変数の値を編集可能にするかどうかを設定します。
Tooltip	変数のツールチップを設定します。
Private	変数をプライベートにし、派生したブループリントから修正はできないように設定します。
Category	既存カテゴリから選択するか、新規カテゴリ名を入力します。 Class Defaults (クラスのデフォルト) 、 [My Blueprint] タブ、ブループリントの [Details (詳細)] タブで変数を表示させるかどうかを設定します。
Replication	変数の値をクライアント中にレプリケートするかどうかを選択し、値がレプリケートされる場合はコールバック関数による通知が必要かを選択します。

詳細な変数プロパティ


プロパティ	説明
Config Variable	この変数が存在する場合、そのデフォルト値を設定ファイルから読み取るかどうかを指定します。様々なプロジェクトやコンフィギュレーション間で、デフォルト値とビヘイビアをカスタマイズするために使用するオプションです。
Transient	ロード時にシリアル化およびゼロ埋めされません。
SaveGame	保存したゲームに対してシリアル化されます。
Advanced Display	デフォルトで [Class Defaults] ウィンドウで非表示になります。
Multi line	複数行の表示を可能にします。変数を編集しながら新しい行を追加するには、[Shift] + [Enter] を押します。注記:このオプションは String 変数と Text 変数のみに適用します。
Deprecated Deprecation Message	廃止されます。変数を参照しているすべてのノードは、取り除く、または置き換えの推奨を示すコンパイラ警告を生成します。例：「X は使用しなくなりました。X の代わりに Y を使用してください。」

変数値の取得と設定

Get ノードおよび Set ノードにより、変数をブループリントネットワークの一部として編集することも可能です。その一番簡単な方法は、[Variables (変数)] タブから変数をイベントグラフへ直接ドラッグすることです。小さなメニューが表示され、Get ノードあるいは Set ノードを作成するかを聞いてきます。