Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NiagaraEditor > ViewModels > FNiagaraScriptViewModel

Light Theme

Dark Theme

FNiagaraScriptViewModel

A view model for Niagara scripts which manages other script related view models.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

TSharedFromThis

FEditorUndoClient

TNiagaraViewModelManager

INiagaraParameterDefinitionsSubscriberViewModel

FNiagaraScriptViewModel

FNiagaraScratchPadScriptViewModel

References

Module	NiagaraEditor
Header	/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/NiagaraScriptViewModel.h
Include	#include "ViewModels/NiagaraScriptViewModel.h"

Syntax

class FNiagaraScriptViewModel :
    public TSharedFromThis< FNiagaraScriptViewModel >,
    public FEditorUndoClient,
    public TNiagaraViewModelManager< UNiagaraScript, FNiagaraScriptViewModel >,
    public INiagaraParameterDefinitionsSubscriberViewModel

Remarks

A view model for Niagara scripts which manages other script related view models.

Variables

	Name	Description
bool	bIsForDataProcessingOnly	Whether or not this view model is going to be used for data processing only and will not be shown in the UI.
bool	bUpdatingSelectionInternally	A flag for preventing reentrancy when synchronizing selection.
TArray< FString...	CompileErrors
TArray< FString...	CompilePaths
TArray< ENiagar...	CompileStatuses
TArray< TPair< ...	CompileTypes
TSharedRef< FNi...	GraphViewModel	The view model for the graph.
TSharedRef< FNi...	InputCollectionViewModel	The view model for the input parameter collection.
ENiagaraScriptC...	LastCompileStatus	The stored latest compile status.
FDelegateHandle	OnGraphChangedHandle	The handle to the graph changed delegate needed for removing.
TSharedRef< FNi...	OutputCollectionViewModel	The view model for the output parameter collection .
TArray< TNiagar...	RegisteredHandles
TArray< FVersio...	Scripts	The script which provides the data for this view model.
TWeakObjectPtr<...	Source
TSharedRef< FNi...	VariableSelection	The set of variables currently selected in the graph or the parameters panel.

Constructors

	Name	Description
	FNiagaraScriptViewModel ( TAttribute< FText > DisplayName, ENiagaraParameterEditMode InParamet..., bool bInIsForDataProcessingOnly )

Destructors

	Name	Description
	~FNiagaraScriptViewModel()

Functions

	Name	Description
void	CompileStandaloneScript ( bool bForceCompile )	Compiles a script that isn't part of an emitter or System.
UNiagaraScri...	GetContainerScript ( ENiagaraScriptUsage InUsage, FGuid InUsageId )
FText	GetDisplayName()
TSharedRef< ...	GetGraphViewModel()	Gets the view model for the graph.
TSharedRef< ...	GetInputCollectionViewModel()	Gets the view model for the input parameter collection.
ENiagaraScri...	GetLatestCompileStatus ( FGuid VersionGuid )	Get the latest status of this view-model's script compilation.
TSharedRef< ...	GetOutputCollectionViewModel()	Gets the view model for the output parameter collection.
UNiagaraScri...	GetScript ( ENiagaraScriptUsage InUsage, FGuid InUsageId )	Implements a globally unique identifier.
ENiagaraScri...	GetScriptCompileStatus ( ENiagaraScriptUsage InUsage, FGuid InUsageId )
FText	GetScriptErrors ( ENiagaraScriptUsage InUsage, FGuid InUsageId )
const TArray...	GetScripts()
FVersionedNi...	GetStandaloneScript()	If this is editing a standalone script, returns the script being edited.
TSharedRef< ...	GetVariableSelection()	Gets the currently selected script variables.
bool	IsGraphDirty ( FGuid VersionGuid )
void	OnGPUScriptCompiled ( UNiagaraScript* InScript, const FGuid& ScriptVersion )
void	OnVMScriptCompiled ( UNiagaraScript* InScript, const FGuid& ScriptVersion )
void	RefreshNodes()	Refreshes the nodes in the script graph, updating the pins to match external changes.
void	SetScript ( FVersionedNiagaraScript InScript )	Sets the view model to a different script.
void	SetScripts ( UNiagaraEmitter* InEmitter )
void	UpdateCompileStatus ( ENiagaraScriptCompileStatus InAggre..., const FString& InAggregateCompileE..., const TArray< ENiagaraScriptCompile..., const TArray< FString >& InCompile..., const TArray< FString >& InCompile..., const TArray< UNiagaraScript* ... )	Updates the script with the latest compile status.

Overridden from FEditorUndoClient

		Name	Description
	void	PostRedo ( bool bSuccess )	Signal that client should run any PostRedo code
	void	PostUndo ( bool bSuccess )	Signal that client should run any PostUndo code

Overridden from INiagaraParameterDefinitionsSubscriberViewModel

		Name	Description
	INiagaraPara...	GetParameterDefinitionsSubscriber()