INiagaraParameterDefinitionsSubscriberViewModel

Interface for viewmodels to classes that subscribe to [UNiagaraParameterDefinitions](API\Plugins\NiagaraEditor\UNiagaraParameterDefinitions).

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

NiagaraEditor

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h

Include

#include "ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h"

Syntax

class INiagaraParameterDefinitionsSubscriberViewModel

Remarks

Interface for viewmodels to classes that subscribe to UNiagaraParameterDefinitions.

Destructors

Functions

Name Description

Public function

UNiagaraScri...

 

FindScriptVarById

(
    const FGuid& ScriptVarId
)

Find a viewed object owned UNiagaraScriptVariable with a matching Id GUID, or otherwise return nullptr.

Public function

UNiagaraPara...

 

FindSubscribedParameterDefinitionsById

(
    const FGuid& LibraryId
)

Find a subscribed Parameter Definitions with a matching Id GUID, or otherwise return nullptr.

Public function

UNiagaraScri...

 

FindSubscribedParameterDefinitionsScriptVarByName

(
    const FName& ScriptVarName
)

Find a parameter definitions owned UNiagaraSCriptVariable with a matching parameter name FName, or otherwise return nullptr.

Public function

TArray< UNia...

 

GetAllScriptVars()

Get all UNiagaraScriptVariables held by the UNiagaraGraphs of the UNiagaraScriptSourceBases from GetAllSourceScripts().

Public function

TArray< UNia...

 

GetAvailableParameterDefinitions

(
    bool bSkipSubscribedParameterDefini...
)

Get all parameter libraries under the editor and niagara packages, along with those that are in the same package as the UObject this viewmodel is editing.

Public function

FOnSubscribe...

 

GetOnSubscribedParameterDefinitionsChangedDelegate()

Public passthrough to get the OnChanged() delegate owned by the viewed INiagaraParameterDefinitionsSubscriber.

Protected function

INiagaraPara...

 

GetParameterDefinitionsSubscriber()

Protected function

FString

 

GetSourceObjectPackagePathName()

Get the path to the package of the UObject this viewmodel is editing.

Public function

TArray< UNia...

 

GetSubscribedParameterDefinitions()

Public function

void

 

SetParameterIsOverridingLibraryDefaultValue

(
    const FGuid& ScriptVarId,
    bool bIsOverriding
)

Find the parameter owned by the object viewed by the INiagaraParameterDefinitionsSubscriberViewModel and set its overriding state with a valid Parameter Definitions if possible.

Public function

void

 

SetParameterIsSubscribedToDefinitions

(
    const FGuid& ScriptVarId,
    bool bIsSynchronizing
)

Find the parameter owned by the object viewed by the INiagaraParameterDefinitionsSubscriberViewModel and set its synchronizing state with a valid Parameter Definitions if possible.

Public function

void

 

SubscribeAllParametersToDefinitions

(
    const FGuid& DefinitionsUniqueId
)

Find all parameters owned by the object viewed by the INiagaraParameterDefinitionsSubscriberViewModel and mark them as synchronizing with the target Parameter Definitions, then synchronize them.

Public function

void

 

SubscribeToParameterDefinitions

Public function

void

 

SynchronizeScriptVarWithParameterDefinitions

(
    UNiagaraScriptVariable* Script...,
    bool bForce
)

Synchronizes a specific graph parameter with a subscribed parameter definition library's matching parameter (if it exists.)

Public function

void

 

SynchronizeWithParameterDefinitions

Synchronizes all Parameter Definitions UNiagaraScriptVariables with all graph parameters.

Public function

void

 

UnsubscribeFromParameterDefinitions

(
    const FGuid& ParameterDefinitionsT...
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss