1. Epic GamesDeveloper
  3. FNiagaraScriptViewModel

FNiagaraScriptViewModel

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

API > API/Plugins > API/Plugins/NiagaraEditor

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

   
Name FNiagaraScriptViewModel
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/NiagaraScriptViewModel.h
Include Path #include "ViewModels/NiagaraScriptViewModel.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraScriptViewModel ( TAttribute< FText > DisplayName,
ENiagaraParameterEditMode InParameterEditMode,
bool bInIsForDataProcessingOnly
)

   ViewModels/NiagaraScriptViewModel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FNiagaraScriptViewModel()

   ViewModels/NiagaraScriptViewModel.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CompileStandaloneScript ( bool bForceCompile
)

 Compiles a script that isn't part of an emitter or System. ViewModels/NiagaraScriptViewModel.h  

UNiagaraScript * GetContainerScript ( ENiagaraScriptUsage InUsage,
FGuid InUsageId
)

   ViewModels/NiagaraScriptViewModel.h  

FText GetDisplayName()

   ViewModels/NiagaraScriptViewModel.h  

TSharedRef< FNiagaraScriptGraphViewModel > GetGraphViewModel()

 Gets the view model for the graph. ViewModels/NiagaraScriptViewModel.h  

TSharedRef< FNiagaraScriptInputCollectionViewModel > GetInputCollectionViewModel()

 Gets the view model for the input parameter collection. ViewModels/NiagaraScriptViewModel.h  

virtual ENiagaraScriptCompileStatus GetLatestCompileStatus ( FGuid VersionGuid
)

 Get the latest status of this view-model's script compilation. ViewModels/NiagaraScriptViewModel.h  

TSharedRef< FNiagaraScriptOutputCollectionViewModel > GetOutputCollectionViewModel()

 Gets the view model for the output parameter collection. ViewModels/NiagaraScriptViewModel.h  

UNiagaraScript * GetScript ( ENiagaraScriptUsage InUsage,
FGuid InUsageId
)

   ViewModels/NiagaraScriptViewModel.h  

ENiagaraScriptCompileStatus GetScriptCompileStatus ( ENiagaraScriptUsage InUsage,
FGuid InUsageId
) const

   ViewModels/NiagaraScriptViewModel.h  

FText GetScriptErrors ( ENiagaraScriptUsage InUsage,
FGuid InUsageId
) const

   ViewModels/NiagaraScriptViewModel.h  

const TArray< FVersionedNiagaraScriptWeakPtr > & GetScripts()

   ViewModels/NiagaraScriptViewModel.h  

virtual FVersionedNiagaraScript GetStandaloneScript()

 If this is editing a standalone script, returns the script being edited. ViewModels/NiagaraScriptViewModel.h  

TSharedRef< FNiagaraObjectSelection > GetVariableSelection()

 Gets the currently selected script variables. ViewModels/NiagaraScriptViewModel.h  

void RefreshNodes()

 Refreshes the nodes in the script graph, updating the pins to match external changes. ViewModels/NiagaraScriptViewModel.h  

bool RenameParameter ( const FNiagaraVariable TargetParameter,
const FName NewName
)

   ViewModels/NiagaraScriptViewModel.h  

void SetScript ( FVersionedNiagaraScript InScript
)

 Sets the view model to a different script. ViewModels/NiagaraScriptViewModel.h  
  ViewModels/NiagaraScriptViewModel.h  

void UpdateCompileStatus ( ENiagaraScriptCompileStatus InAggregateCompileStatus,
const FString& InAggregateCompileErrors,
const TArray< ENiagaraScriptCompileStatus >& InCompileStatuses,
const TArray< FString >& InCompileErrors,
const TArray< FString >& InCompilePaths,
const TArray< UNiagaraScript* >& InCompileSources
)

 Updates the script with the latest compile status. ViewModels/NiagaraScriptViewModel.h  

Overridden from FEditorUndoClient

Name Remarks Include Path Unreal Specifiers

virtual void PostRedo ( bool bSuccess
)

   ViewModels/NiagaraScriptViewModel.h  

virtual void PostUndo ( bool bSuccess
)

   ViewModels/NiagaraScriptViewModel.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool IsGraphDirty ( FGuid VersionGuid
) const

   ViewModels/NiagaraScriptViewModel.h  

virtual void OnGPUScriptCompiled ( UNiagaraScript* InScript,
const FGuid& ScriptVersion
)

   ViewModels/NiagaraScriptViewModel.h  

virtual void OnVMScriptCompiled ( UNiagaraScript* InScript,
const FGuid& ScriptVersion
)

   ViewModels/NiagaraScriptViewModel.h  

Overridden from INiagaraParameterDefinitionsSubscriberViewModel

Name Remarks Include Path Unreal Specifiers

virtual INiagaraParameterDefinitionsSubscriber * GetParameterDefinitionsSubscriber()

   ViewModels/NiagaraScriptViewModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page