Navigation
API > API/Plugins > API/Plugins/NiagaraEditor
Interface for viewmodels to classes that subscribe to UNiagaraParameterDefinitions.
| Name | INiagaraParameterDefinitionsSubscriberViewModel |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h |
| Include Path | #include "ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h" |
Syntax
class INiagaraParameterDefinitionsSubscriberViewModel
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~INiagaraParameterDefinitionsSubscriberViewModel() |
ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNiagaraScriptVariable * FindScriptVarById
(
const FGuid& ScriptVarId |
Find a viewed object owned UNiagaraScriptVariable with a matching Id GUID, or otherwise return nullptr. | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
UNiagaraParameterDefinitions * FindSubscribedParameterDefinitionsById
(
const FGuid& LibraryId |
Find a subscribed Parameter Definitions with a matching Id GUID, or otherwise return nullptr. | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
UNiagaraScriptVariable * FindSubscribedParameterDefinitionsScriptVarByName
(
const FName& ScriptVarName |
Find a parameter definitions owned UNiagaraSCriptVariable with a matching parameter name FName, or otherwise return nullptr. | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
TArray< UNiagaraScriptVariable * > GetAllScriptVars() |
Get all UNiagaraScriptVariables held by the UNiagaraGraphs of the UNiagaraScriptSourceBases from GetAllSourceScripts(). | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
TArray< UNiagaraParameterDefinitions * > GetAvailableParameterDefinitions
(
bool bSkipSubscribedParameterDefinitions |
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. | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
FOnSubscribedParameterDefinitionsChanged & GetOnSubscribedParameterDefinitionsChangedDelegate() |
Public passthrough to get the OnChanged() delegate owned by the viewed INiagaraParameterDefinitionsSubscriber. | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
TArray< UNiagaraParameterDefinitions * > GetSubscribedParameterDefinitions() |
ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | ||
void SetParameterIsOverridingLibraryDefaultValue
(
const FGuid& ScriptVarId, |
Find the parameter owned by the object viewed by the INiagaraParameterDefinitionsSubscriberViewModel and set its overriding state with a valid Parameter Definitions if possible. | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
void SetParameterIsSubscribedToDefinitions
(
const FGuid& ScriptVarId, |
Find the parameter owned by the object viewed by the INiagaraParameterDefinitionsSubscriberViewModel and set its synchronizing state with a valid Parameter Definitions if possible. | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
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. | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
void SubscribeToParameterDefinitions
(
UNiagaraParameterDefinitions* NewParameterDefinitions |
ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | ||
void SynchronizeScriptVarWithParameterDefinitions
(
UNiagaraScriptVariable* ScriptVarToSynchronize, |
Synchronizes a specific graph parameter with a subscribed parameter definition library's matching parameter (if it exists.) | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
void SynchronizeWithParameterDefinitions
(
FSynchronizeWithParameterDefinitionsArgs Args |
Synchronizes all Parameter Definitions UNiagaraScriptVariables with all graph parameters. | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | |
void UnsubscribeFromParameterDefinitions
(
const FGuid& ParameterDefinitionsToRemoveUniqueId |
ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
INiagaraParameterDefinitionsSubscriber * GetParameterDefinitionsSubscriber() |
ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h | ||
FString GetSourceObjectPackagePathName() |
Get the path to the package of the UObject this viewmodel is editing. | ViewModels/NiagaraParameterDefinitionsSubscriberViewModel.h |