1. Epic GamesDeveloper
  3. UNiagaraParameterDefinitions

UNiagaraParameterDefinitions

Collection of Niagara parameters and their metadata, which is synced to all other assets in the project.

API > API/Plugins > API/Plugins/NiagaraEditor

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI)  
class UNiagaraParameterDefinitions : public UNiagaraParameterDefinitionsBase

Remarks

Collection of Niagara parameters and their metadata, which is synced to all other assets in the project. This can be used to enforce consistent naming and default values for commonly used parameters.

Constructors

  Type Name Description
Public function  

UNiagaraParameterDefinitions ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddParameter ( const FNiagaraVariable& NewVariable
)

  
Public function void

FindOrAddParameter ( const FNiagaraVariable& Variable
)

  
Public function Const 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.
Public function Const bool  
Public function Const int32  
Public function Const const TArray< UNiagaraScriptVariable * > &  
Public function UNiagaraScriptVariable * Getters for script variables.
Public function UNiagaraScriptVariable *

GetScriptVariable ( const FGuid& ScriptVarId
)

  
Public function bool

HasParameter ( const FNiagaraVariable& Variable
)

  
Public function void  
Public function void

RemoveParameter ( const FNiagaraVariable& VariableToRemove
)

  
Public function void

RenameParameter ( const FNiagaraVariable& VariableToRename,
const FName NewName
)

  
Public function void

SubscribeBindingNameToExternalParameterDefinitions ( UNiagaraParameterDefinitions* NewParameterDefinitions,
const FGuid& ExternalScriptVarId,
const FGuid& InternalScriptVarId
)

  
Public function void Synchronize all parameter names in subscribed external parameter libraries to local parameters.
Public function void

UnsubscribeBindingNameFromExternalParameterDefinitions ( const FGuid& InternalScriptVarToUnsubscribeId
)

  

Overridden from UNiagaraParameterDefinitionsBase

  Type Name Description
Public function Virtual Const int32  
Public function Virtual Const TSet< FGuid >  

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page