ブループリントの概要 | Unreal Engine 5.7 ドキュメンテーション

Unreal Engine のブループリントビジュアルスクリプティング システム (単に「ブループリント」と呼ばれることが多いです) は、ノードベースのインターフェースを使って、コードを書かずにゲームプレイ機能を作成するためのビジュアルスクリプティング言語です。記述されたスクリプト言語と同様に、ブループリントシステムは数値、ブール値、配列、構造体などの型付きデータで動作します。ロジックは実行ワイヤーを通じて流れます。つまり、各ノードは明示的に実行を指示されたときにのみ実行されます。

ブループリントクラスを使用すると、物理コンポーネントをスクリプト動作と組み合わせることができます。たとえば、ブループリントには、コインのスタティックメッシュと、プレイヤーがコインに触れたときにコインを拾わせる動作を含めることができます。

一般的な多くのスクリプト言語と同様に、Engine ではこのシステムを使用してオブジェクト指向のクラスやオブジェクトを定義することができます。プログラマー向けに、Unreal Engine の C++ 実装にはブループリント固有のマークアップが含まれており、デザイナーが拡張できるベースラインシステムを作成できます。

この概要では、さまざまなタイプのブループリントアセットについて学び、サンプルのブループリントクラスを見てみましょう。そのブループリントの特定の要素を変更し、これらの変更がレベルエディタおよびゲームプレイにおいてブループリントアクタにどのように影響するかを確認します。

ブループリントの種類

ブループリントアセットにはさまざまなタイプがあり、それぞれに独自の役割があります。ブループリントを作成して保存すると、コンテンツパッケージ内のアセットファイルになります。

ブループリントクラス

ブループリントクラス (よく「ブループリント」と略されます) は、コンテンツクリエイターが既存のゲームプレイクラスに機能を簡単に追加できるようにするためのアセットです。ブループリントは、コードを入力するのではなく、Unreal Editor 内で視覚的に作成され、コンテンツパッケージのアセットとして保存されます。これらは基本的に、新しいアクタのクラスまたはタイプを定義し、他のタイプのアクタと同じように動作するインスタンスとしてマップに配置できます。

ブループリントクラスは、コンポーネント、変数、ブループリントビジュアルスクリプティングを使用して、ゲーム内のオブジェクトのプロパティと動作を記述するレシピのようなものです。ブループリントクラスのインスタンスをレベルに追加します。

これは、最も一般的なタイプであり、ブループリントクラスという名前ですが、ブループリントと略されることが多いです。

ブループリントクラスは、実行ロジックを含まず、親ブループリントから継承した変数またはコンポーネントのみをオーバーライドする場合、データのみにすることができます。データのみのブループリントクラスはコンパクトエディタで開きますが、新しいロジック、グラフ、またはその他のスクリプト化された要素を追加すると、フルブループリントエディタに変換されます。

追加のドキュメントについては、「クラスブループリント」を参照してください。

レベルブループリント

全てのレベルにはレベルブループリントがあります。新しいレベルを作成すると、Unreal Engine はそのレベルのレベルブループリントを自動的に作成します。このタイプのブループリントは、レベル全体のグローバルイベントグラフとして機能します。

レベルブループリントは、レベルストリーミングやシーケンサーシネマティックスの制御メカニズムに加え、レベル内に配置されたアクタにイベントをバインドするための制御メカニズムも提供します。

レベルのレベルブループリントを開くには、レベルエディタのメインツールバーにある [Blueprint (ブループリント)] メニューを使用します。

追加のドキュメントについては、「レベルブループリント」を参照してください。

ブループリントインターフェース

ブループリントインターフェース アセットは、他のブループリントに追加できる 1 つ以上の関数 (名前のみで、実装がない) のコレクションです。インターフェースが追加されたブループリントは、それらの関数を持つことが保証されます。インターフェースの関数は、インターフェースを追加した各ブループリントで機能を付与できます。これは基本的に、一般的なプログラミングにおけるインターフェースの概念に似ており、複数の異なるタイプのオブジェクトを全て、共通のインターフェースを介して共有し、アクセスできるようになります。簡単に言えば、ブループリントインターフェースを使用すると、複数のブループリント間でデータを共有したり送信したりできます。

ブループリントインターフェースには次の機能はありません。

新しい変数を追加する
グラフを編集する
コンポーネントを追加

詳細については、「ブループリントインターフェース」および「インターフェースクイックスタートガイド」を参照してください。

ブループリントライブラリ

関数とマクロを「ライブラリ」アセットに作成することでロジックを再利用でき、プロジェクト内の全てのブループリントからアクセスできるようになります。

ブループリント関数ライブラリ

ブループリント関数ライブラリは、再利用可能な関数のコレクションを格納するブループリントアセットです。これらの関数は、特定のブループリントやアクタに関連付けられていません。代わりに、プロジェクト全体でグローバルにアクセス可能であり、ブループリントクラスから呼び出しできます。ライブラリを使用すると、便利な関数を 1 か所に保持できるため、同じノードを複数のブループリントにコピーして貼り付ける必要がありません。

ブループリント関数ライブラリの関数は静的であり、呼び出し間で情報を保存したり記憶したりせず、そのデータをパラメータとして渡さない限り、特定のブループリントインスタンスに関する情報を認識しません。このため、関数ライブラリは、入力に対して操作を行い、結果を返す汎用ロジックに最適です。機能がオブジェクトの内部変数 (プレイヤーのインベントリなど) に依存する場合、通常はライブラリではなく、そのオブジェクトのブループリントに属します。

ブループリントマクロライブラリ

ブループリントマクロライブラリは、他のブループリントにノードとして配置可能なマクロ コレクションや自己完結型のグラフを保持するためのコンテナです。ブループリントマクロライブラリを使用すると、実行とデータ転送の両方の入出力を備えた、使用頻度の高いノードのシーケンスを格納できるため、時間を節約できます。

マクロは、マクロを参照する全てのグラフで共有されますが、コンパイル中に折りたたまれたノードであるかのように、グラフに自動展開されます。つまり、ブループリントマクロライブラリをコンパイルする必要はありません。ただし、マクロへの変更は、それらのグラフを含むブループリントが再コンパイルされたときにのみ、そのマクロを参照するグラフに反映されます。

詳細については、「ブループリントマクロライブラリ」および「マクロの作成」を参照してください。

関数は、入力を受け取り、一度実行され、結果を返すことができる再利用可能なロジックのブロックです。計算やチェックに最適です。マクロは、使用されるブループリントに直接展開される再利用可能なグラフレイアウトです。複数の実行出力を持つことができ、ビジュアルフロー制御に役立ちます。

ブループリントユーティリティ

ブループリントユーティリティ (エディタユーティリティ とも呼ばれます) は、エディタのアクションの実行やエディタ機能の拡張のために使用できるエディタ専用のブループリントです。これらは、パラメータのないイベントを UI のボタンとして公開でき、ブループリントに公開されている任意の関数を実行し、ビューポートで選択されているアクタの現在のセットに対してアクションを実行する機能を備えています。

ブループリントクラスの紹介

開始するには、ファーストパーソンまたはサードパーソン テンプレート (任意のバリアント) に基づく Unreal Editor プロジェクトが必要です。

Unreal Engine で新規プロジェクトを作成する方法については、「Unreal で最初のプロジェクトを作成する」を参照してください。

既存のブループリントを開く

テンプレートからプロジェクトを作成したため、プロジェクトにはすでにいくつかのブループリントが含まれており、それらを確認して使用できます。含まれているブループリントクラスの 1 つの例は、プレイヤーを上方向にブーストする機能があるジャンプパッドブループリントです。このブループリントのインスタンスをレベルの任意の場所に追加できます。

ジャンプパッドブループリントを開くには、次の手順を実行します。

Unreal Engine で、画面の左下隅にある [Content Drawer (コンテンツドロワー)] ボタンをクリックします。または、CTRL キーを押しながらスペース キーを押します。
[Content (コンテンツ)] > [LevelPrototyping] > [Interactable] > [JumpPad] フォルダに移動します。
BP_JumpPad アセットが表示されます。これはブループリントクラスです。アセットをダブルクリックして、Blueprint Editor (ブループリントエディタ) で開きます。
デフォルトでは、ブループリントは新しいウィンドウで開きます。メインエディタで、アセットの名前が表示されたタブをレベルのタブの隣にドラッグすると、ウィンドウをドッキングできます。

ブループリントエディタでは、コンポーネントを定義したり、セットアップ操作を実行したり、イベントに応答したり、操作を整理してモジュール化したり、プロパティを定義したりできます。ブループリントに追加するビジュアルと機能は、ゲーム内にあるそのブループリントの全てのインスタンスに適用されます。

BP_JumpPad を見てみましょう。ウィンドウの上部には、[Viewport (ビューポート)]、[EventGraph (イベントグラフ)]、[Construction Script (コンストラクション スクリプト)]の 3 つのタブが表示されます。

コンポーネントを使用してレベルオブジェクトをビルドする

[Viewport (ビューポート)] タブをクリックします。メインレベルエディタでビューポートを使用するのと同様に、ブループリントのビューポートを使用してブループリントを表示および編集します。

このタブには、プラットフォーム、ライト、パーティクルエフェクトを含むジャンプパッドの視覚表現が表示されます。

ウィンドウの左側には、ブループリントのコンポーネント、つまりブループリントが何で構成されており、レベルに何が表示されるかを定義する要素も表示されます。 [Components (コンポーネント)] パネルを使用して、ブループリントのコンポーネントを追加、削除、整理します。

コンポーネントを使用してブループリントに追加できる構成要素は次のとおりです。

カプセルコリジョン、ボックスコリジョン、または球体コリジョンコンポーネントを使用したコリジョンジオメトリ。
スタティックメッシュコンポーネントまたはスケルタルメッシュコンポーネントの形式でレンダリングされたジオメトリ。
移動コンポーネントによる移動制御。

コンポーネントのみを含み、スクリプト化された動作を含まないブループリントを作成し、1 か所で編集できる再利用可能なレベルオブジェクトとして機能させることができます。

EventGraph でブループリントのコンポーネントまたはそのプロパティを参照することもできるため、ランタイム中にそれらのコンポーネントに対してアクションを実行できます。

BP_JumpPad の一部となっているコンポーネントを詳しく見てみましょう。

BP_JumpPad にはポイントライトコンポーネントがあります。 [Components (コンポーネント)] リストまたは [Viewport (ビューポート)] でポイントライト オブジェクトをクリックします。 トランスフォーム ツールを使用して、この光源を移動および回転できます。

ブループリントエディタの右側には、選択したコンポーネントに関連するプロパティが一覧表示される詳細パネルが表示されます。この光源の [Intensity (強度)]、[Light Color (ライトの色)] などを編集できます。

ブループリント機能を作成する

[Viewport (ビューポート)] タブの隣に、[EventGraph (イベントグラフ)] タブと [Construction Script (コンストラクションスクリプト)] タブが表示されます。ブループリントで関数を作成すると、それらの関数グラフのタブもここに表示されます。

グラフには、ブループリントのデザイン時間およびゲーム時間動作および機能が含まれています。ここでは、ブループリントのコンポーネントの動作方法を指示するロジックを作成します。

ロジックとは、ブループリントのノードと接続のことです。

コンストラクションスクリプト

ブループリントアクタがレベルエディタビューポートまたはゲームプレイにおいてレベルにスポーンすると、Unreal Engine はまずそのコンポーネントをビルドした後、そのコンストラクションスクリプトを実行します。アクタのプロパティをトランスフォームまたは変更すると、エディタでも実行されるため、ビューポートで結果をすぐに確認できます。ゲームプレイ用にブループリントアクタを設定する初期化アクションを実行するために使用されます。これらの初期化アクションはコンテキストに固有である場合があります。たとえば、オブジェクトが配置されている地面のタイプに応じて、異なるマテリアルをオブジェクトに適用します。

BP_JumpPad の [Construction Script (コンストラクションスクリプト)] タブをクリックすると、レベルに初めて表示 (またはスポーン) されたときにジャンプパッドの色やその他のプロパティを設定する一連のアクションを実行する Construction Script ノードが表示されます。

ブループリントグラフの操作：

パン：右クリックしてドラッグします。
ズーム：マウスホイールを使用します。
フレーム選択：F キーを押すと、選択したノードの中心に合わせて配置されます。
全体表示：A を押すと、グラフ全体が表示されます。
ジャンプ：関数またはイベントノードをダブルクリックすると、グラフまたはそのグラフタブで検索されます。

イベントグラフ

ブループリントのイベントグラフは、イベントと関数呼び出しを使用して、ゲームプレイイベントに応じて一連のアクションを順番に実行するノードグラフです。ここでは、インタラクティビティと動的な応答が設定されます。たとえば、ライトブループリントは、ライトコンポーネントをオフにしてマテリアルを変更することでダメージイベントに応答できます。

イベントグラフの全てのロジックは、ゲームプレイ中に発生する事柄への応答です。たとえば、プレイヤー入力への応答、アニメーションのトリガー、サウンドの再生などです。「これが起こったら、あれをしたい」と思ったときは必ず、イベントから始める必要があります。

ブループリントには、全て同じブループリントの一部として実行される複数のイベントグラフを含めることができます。複数のイベントグラフは、ロジックを別々のセクションに整理するためだけに使用され、ブループリントの動作には影響しません。

[BP_JumpPad EventGraph] タブには、プレイヤーがゲーム内でジャンプパッドの上を歩くときなど、アクタがこのブループリントとオーバーラップしたときに実行されるノードのシーケンスが表示されます。このイベントが発生すると、ブループリントは、そのアクタに通常よりも高い速度でジャンプ動作を実行させます。

グラフ内の特定のノードを見つけるには、グラフビューで CTRL + F ショートカットを使用してノードを検索します。たとえば、Event ActorBeginOverlap ノードを確認するには、CTRL + F ショートカットを使用して、検索フィールドにEvent ActorBeginOverlap と入力します。結果を選択すると、そのノードにビューがパンされます。

アクションを実行できるノードには、実行ピンがあります。これは実行ピンとも呼ばれ、ノード上に白い三角形で表されます。ノードの実行ピンが別のノードに接続されていない場合、三角形には白いアウトラインがあります。

接続されたノード	接続されていないノード

お気づきかと思いますが、イベントノードには入力実行ピンがありません。これは、定義されたイベントがゲームワールドでトリガーされるとすぐにイベントノードが実行されるためです。この例では、ゲーム内でアクタが BP_JumpPad のアクタとオーバーラップすると、このイベントがトリガーされます。

ノードはデータピンを持つこともできます。たとえば、Event ActorBeginOverlap には、Other Actor のピンがあります。これは、BP_JumpPad レベルオブジェクトとオーバーラップするレベルオブジェクト (アクタ) への参照です。データピンはノード間で値を渡し、実行ピンはノードが実行される順序を制御します。

Event ActorBeginOverlap ノードの実行ピンは、Cast To キャラクター ノードに接続されています。これは、ワールドのアクタ (プレイヤーなど) がジャンプパッドアクタとオーバーラップすると、このブループリントが Cast To Character ノードを実行することを意味します。

ノード間の接続は、ワイヤーと呼ばれることがよくあります。

Event ActorBeginOverlap ノードの実行ピンを Cast To Character ノードから切断し、Other Actor ピンを接続したままにすると、実行ピンが接続されていないため、何も起こりません。つまり、Event ノードは Cast To Character ノードをトリガーしません。

接続 (またはワイヤー) を削除するには、Alt キーを押しながらそのワイヤーをクリックします。あるピンから別のピンへドラッグしてワイヤーを接続します。

ワイヤーを再ルーティングするには、ワイヤーをダブルクリックして再ルーティングノードを作成します。再ルーティングノードにカーソルを合わせ、カーソルが 4 つの矢印に変わったら、再ルーティングノードをドラッグして移動します。

イベントグラフでのノードアクションの操作について詳しくは、「ノードを配置する」および「ノードを接続する」を参照してください。

変数

変数は、次のいずれかの条件に当てはまるプロパティです。

距離測定やキャラクターが移動できる速度などの値を保持する。
アクタが使用するスタティックメッシュなど、ワールド内の何かを参照する。

変数をブループリントのみがアクセスできるように設定したり、レベルエディタで編集可能にしたりできます。これにより、デザイナーはレベルに配置されたブループリントインスタンスを簡単にカスタマイズできます。

BP_JumpPad の [EventGraph (イベントグラフ)] タブで、ブループリントエディタの左側にある [My Blueprint (マイブループリント)] パネルを見てみましょう。

[Variables (変数)] セクションには、[速度 (Velocity)] と [カラーターゲット (Color Target)] という 2 つの変数が表示されます。

Velocity 変数をクリックして選択します。詳細パネルには、この変数に関連するさまざまなプロパティがあります。リストの一番下には、[Default Value (デフォルト値)] カテゴリがあり、ここで [Velocity (速度)] 変数の値を設定できます。

この場合、[Velocity (速度)] は 0、0、800 に設定されます。これは、プレイヤーに適用される速度が Z 軸、つまり上方向に 800 単位であることを意味します。

つまり、ジャンプパッドの機能は、「プレイヤーがこのジャンプパッドの上を歩くと、800 cm/秒で上向きに移動させる」というものです。

ジャンプパッドの変数を見ると、隣に開いた目のアイコンがあることがわかります。つまり、これらの変数はパブリックかつ編集可能な変数であり、レベル内のそのブループリントの全てのインスタンスで編集できます。

ブループリントを開いて編集することなく、レベルエディタから編集可能な変数のデフォルト値をインスタンスごとにオーバーライドできます。

ブループリントの外部で変数を編集する方法の例を確認するには、次のステップを実行します。

Unreal Editor の左上隅にあるレベルのタブをクリックして、レベルエディタに戻ります。
コンテンツブラウザを開き、[JumpPad] フォルダにある BP_JumpPad アセットを地面のレベルにドラッグします。選択されていることを確認します。
詳細パネルで、[Default (デフォルト)] という名前のカテゴリを見つけます。このカテゴリでは、先ほど見た 2 つの変数 ([Velocity (速度)] と [Color Target (カラーターゲット)]) を確認できます。これら 2 つの変数はブループリントで編集可能として設定されているため、ここに表示されます (目のアイコンが開いています)。
BP_JumpPad タブに戻ります。 [My Blueprint (マイブループリント)] > [Variables (変数)] セクションで、Velocity 変数の目のアイコンをクリックして、公開せず、編集不可にします。開いている目が閉じている目に変わります。
変更を適用するには、ブループリントエディタの左上隅にある [Compile (コンパイル)] ボタンをクリックします。
コンパイルすると、ブループリントのエラーがチェックされ、最新の変更がレベルで機能するようにブループリントがアップデートされます。
レベルエディタに戻り、BP_JumpPad アクタを選択し、[Details (詳細)] > [Default (デフォルト)] セクションをもう一度確認します。編集可能インスタンスではなくなったため、Velocity 変数がありません。
ブループリントを元の設定に戻すには、ブループリントエディタに戻り、Velocity 変数の横にある目のアイコンをもう一度クリックします。
[Compile (コンパイル)] と [Save (保存)] をクリックします。

変数がパブリックかつ編集可能な場合、他のブループリントでも使用できます。たとえば、レベルのレベルブループリントは、ジャンプパッドの Color Target 変数にアクセスして使用し、パッドの色を変更できます。

変数タイプ、変数の作成と編集、ブループリントグラフでの変数の参照について詳しくは、「ブループリント変数」を参照してください。

機能

関数は、ブループリント内の別のグラフから実行または呼び出すことができる特定のブループリントに属するノードグラフです。関数には、単一の実行出力ピンを含む関数の名前があるノードによって指定される単一のエントリポイントがあります。別のグラフから関数を呼び出すと、関数エントリノードから始まる関数内のロジックが実行されます。

ブループリントクラスをビルドするとき、複数の場所や他のブループリントでイベントグラフのロジックの一部を再利用することをおすすめします。多くの場所で同じロジックを再構築する代わりに、ノードを追加する関数を作成した後、任意のブループリントからその関数を呼び出すことができます。

別のブループリントに存在する関数を呼び出す場合、関数は作成されたブループリントで引き続き実行されます。この呼び出しにより、外部からその関数にアクセスできるようになります

たとえば、必須キーを受け取り、そのキーをプレイヤーのインベントリと比較して、true または false を返す HasKey 関数を、プレイヤーキャラクターブループリントに作成できます。その後、他のブループリント (ドア、宝箱、NPC キャラクター) は全てその関数を呼び出して、プレイヤーが特定のキーを持っているかどうかをチェックしてから、他の動作を実行できます。これらのレベルオブジェクトはそれぞれ、ブループリントで再作成する必要なく、プレイヤーキャラクターの HasKey 関数のロジックを再利用できます。