Niagara スクリプト エディタのリファレンス

このページでは、Niagara スクリプト エディタのユーザー インターフェース (UI) について説明します。

Choose your operating system:

Windows

macOS

Linux

概要

Niagara スクリプト エディタ を使用すると、Niagara システムやエミッタで使用する新しいモジュール、動的入力、その他のスクリプトを作成することができます。スクリプト エディタは、モジュールのヘッダをダブルクリックすると起動できます。このページではスクリプト エディタのユーザー インターフェース (UI) について、次のいくつかのパートに分けて説明します。

クリックしてフルサイズ表示。

  1. メニュー バー

  2. ツールバー

  3. スクリプト詳細パネル

  4. パラメータ パネル

  5. 統計パネル

  6. ノード グラフ

  7. Niagara メッセージ ログ パネル

  8. 選択した詳細パネル

メニュー バー

Menu Bar

以下の表は Niagara エディタ自体に適用するコマンドのみの説明です。アセット エディタまたは Unreal Editor のその他の機能を開くメニューでは、他のコマンドが表示される場合があります。

File

コマンド

説明

Save

現在のエミッタを保存します。

Save As

現在のエミッタを別の名前で保存します。

Open Asset

他のアセットを選択するウィンドウを表示します。

Save All

このプロジェクトのアセットとレベルをすべて保存します。

Choose Files to Save

アセットとレベルの保存オプションが指定できるダイアログ ボックスを表示します。

Connect to source control

コンテンツ上でのソース コントロールの実行を可能にする、ソース コントロールに接続するためのダイアログ ボックスを表示します。

Edit

コマンド

説明

Undo

最後に行った操作を元に戻します。

Redo

元に戻した操作をやり直します。

Undo History

元に戻した操作をすべて一覧表示するダイアログ ボックスを開きます。

Asset

コマンド

説明

Find in Content Browser

前回使用したコンテンツ ブラウザに切り替えて、そのコンテンツ ブラウザで現在のアセットを選択します。

Reference Viewer

現在のアセットの参照をすべて表示するダイアログボックスを開きます。

Size Map

アセットの概算サイズとアセットが参照するものすべてを表示するインタラクティブ マップを開きます。

Audit Assets

[Audit Asset (アセットの監査)] の UI を開き、選択したアセットに関する情報を表示します。

Shader Cook Statistics

シェーダ クック処理の統計情報を表示します。

Window

コマンド

説明

Toolbar

ツールバーの表示/非表示を切り替えます。

Node Graph

ノード グラフの表示 / 非表示を切り替えます。

Script Details

[Script Details (スクリプト詳細)] パネルの表示/非表示を切り替えます。

Selected Details

[Selected Details] パネルの表示 / 非表示を切り替えます。

System Details

[System Details (システム詳細)] パネルの表示/非表示を切り替えます。

Parameters

[Parameters] パネルの表示 / 非表示を切り替えます。

Stats

[Stats] パネルの表示 / 非表示を切り替えます。

Niagara Message Log

[Niagara Message Log] パネルの表示 / 非表示を切り替えます。

ツールバー

Script Editor Toolbar

ツール名

説明

Save

Save Icon

現在のスクリプトを保存します。

Browse

Browse Icon

前回使用したコンテンツ ブラウザに切り替えて、現在のアセットを選択します。

Apply

Apply Icon

保存していない変更を現在のアセットに適用します。

Compile

Compile Icon

スクリプトに加えたすべての変更をコンパイルします。

Refresh

Refresh Icon

パネルを更新して依存関係を正確に表示します。

スクリプト詳細パネル

クリックしてフルサイズ表示。

設定

説明

Module Usage Bitmask

このモジュールを参照するために適切なスクリプトの種類を選択します。複数の種類を選択することができます。

Category

ユーザーが追加メニューを開いた時にこのモジュールやスクリプトがどのカテゴリの下にリストされるかを指示します。この矢印をクリックすると、このテキスト フィールドの詳細なテキスト設定が表示されます。

Provided Dependencies

このモジュールが他のモジュールに提供する依存関係の ID の配列を作成します。 プラス記号 のアイコン ( + ) をクリックして配列に要素を追加します。

Required Dependencies

この配列には、このモジュールが必要とするスタックにある他のモジュールからの依存関係が含まれます。各配列の要素は 4 つのメンバーを含みます。

  • ID :必要な依存モジュールの一意の ID です。

  • Type :依存関係が属するのが、このモジュールの前か後かを示します

  • Script Constraints :依存関係を提供するモジュールのソース スクリプトに関連するコンストレイントを指定します。

  • Description :必要な依存関係の説明を入力します。この矢印をクリックすると、このテキスト フィールドの詳細なテキスト設定が表示されます。

Deprecated

使用しないモジュールの場合はこのチェックボックスをオンにします。この設定により次の 2 つの設定が有効になります。このチェックボックスがオフの場合、それらは使用できません。

Deprecation Message

このモジュールが非推奨の場合に表示されるメッセージを入力します。この矢印をクリックすると、このテキスト フィールドの詳細なテキスト設定が表示されます。

Deprecation Recommendation

非推奨モジュールの代わりに推奨するモジュールです。ドロップダウンをクリックして推奨するモジュールを選択します。

Conversion Utility

このスクリプトへの既存のスクリプトのコンテンツ割り当てを変換するカスタム ロジックを書き込み、または選択することができます。

Experimental

このチェックボックスをオンにすると、このモジュールは実験段階としてラベリングされます (そのため、サポートは少なくなります)。また、このチェックボックスがオンの場合は次の設定が有効になります。チェックボックスがオフの場合、使用できません。

Experimental Message

このモジュールが実験段階である場合、この設定を使用してモジュールが選択された時に表示されるメッセージを入力することができます。この矢印をクリックすると、このテキスト フィールドの詳細なテキスト設定が表示されます。

Expose to Library

このチェックボックスをオンにすると、このモジュールはライブラリに公開されます。

Description

このモジュールの説明を入力します。この矢印をクリックすると、このテキスト フィールドの詳細なテキスト設定が表示されます。

Keywords

エディタ メニューでこのモジュールを検索するために使用できる、スペース区切りのキーワードのリストを入力できるテキスト フィールドです。

Highlights

[System Overview] に表示される時に、モジュールに表示される色分けされたアイコンを選択することができます。リストは配列として構成されています。 プラス記号 のアイコン ( + ) をクリックして配列に追加することができます。

Script Metadata

マップを作成します。マップは関連する順序付けされていないコンテナです。コンテナでは一連のキーと一連の値が関連付けされています。

Input Parameters

このスクリプトに含まれる入力パラメータを一覧表示します。 プラス記号 のアイコン ( + ) をクリックしてパラメータを追加することができます。

Output Parameters

このスクリプトに含まれる出力パラメータを一覧表示します。 プラス記号 のアイコン ( + ) をクリックしてパラメータを追加することができます。

パラメータ パネル

Parameters Panel

編集中のモジュールで使用するすべてのパラメータが一覧表示されます。スクリプトのビルド中は、パラメータをこのパネルからノード グラフにドラッグアンドドロップすることができます。次の表では、カテゴリを説明とともに一覧表示します。 プラス記号 ( + ) のアイコンをクリックしてパラメータのメニューを表示し、そのカテゴリに追加します。スクリプトのビルド中は、パラメータをこのパネルからグラフにドラッグアンドドロップすることができます。

パラメータのカテゴリ

説明

System Attributes

システム ステージに書き込まれた永続的な属性で、任意の場所で読み取ることができます。

Emitter Attributes

エミッタ ステージに書き込まれた永続的な属性で、エミッタ ステージとパーティクル ステージで読み取ることができます。

Particle Attributes

パーティクル ステージに書き込まれた永続的な属性で、パーティクル ステージで読み取ることができます。

Module Inputs

システム エディタとエミッタ エディタにモジュール入力を公開する値です。

Static Switch

編集時にのみ設定できる値です。

Modules Locals

単一のモジュール内で書き込み / 読み取りができる一時的な値です。一時的な値はフレーム間やステージ間では保持されません。

Engine Provided

エンジンによって提供される読み取り専用の値です。これらの値のソースはシミュレーション自体、またはシミュレーションのオーナーです。

統計パネル

Stats Panel

ノード グラフ

Node Graph

UE4 で使用される他のタイプのノード グラフと同様に、これはビルド中の HLSL スクリプトを視覚的に表現したものです。グラフ内の任意の場所で右クリックすると、選択するノードのメニューを開くことができます。既存のノードに入力または出力を接続した場合にも同じメニューを開くことができます。

Niagara メッセージ ログ パネル

Message Log Panel

スクリプトのコンパイル時に警告やエラーが発生すると、ここに表示されます。

選択した詳細パネル

Selected Details Panel

ノード グラフで選択した特定のノードに関する詳細が表示されます。

選択したすべてのノードの情報がこのパネルに表示されるわけではありません。

Unreal Engine のドキュメントを改善するために協力をお願いします!どのような改善を望んでいるかご意見をお聞かせください。
調査に参加する
閉じる