Navigation
API > API/Plugins > API/Plugins/NiagaraEditor
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.
| Name | UNiagaraParameterDefinitions |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraParameterDefinitions.h |
| Include Path | #include "NiagaraParameterDefinitions.h" |
Syntax
UCLASS (MinimalAPI)
class UNiagaraParameterDefinitions : public UNiagaraParameterDefinitionsBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNiagaraParameterDefinitionsBase → UNiagaraParameterDefinitions
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNiagaraParameterDefinitions
(
const FObjectInitializer& ObjectInitializer |
NiagaraParameterDefinitions.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~UNiagaraParameterDefinitions() |
NiagaraParameterDefinitions.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bPromoteToTopInAddMenus | bool | If true then these parameters will appear as top level entry in add menus (e.g. in the module editor) | NiagaraParameterDefinitions.h |
|
| ExternalParameterDefinitionsSubscriptions | TArray< FParameterDefinitionsBindingNameSubscription > | NiagaraParameterDefinitions.h | ||
| MenuSortOrder | int32 | Defines the sort order in add menus. Entries with smaller numbers are displayed first. | NiagaraParameterDefinitions.h |
|
| ScriptVariables | TArray< TObjectPtr< UNiagaraScriptVariable > > | NiagaraParameterDefinitions.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddParameter
(
const FNiagaraVariable& NewVariable |
NiagaraParameterDefinitions.h | ||
void FindOrAddParameter
(
const FNiagaraVariable& Variable |
NiagaraParameterDefinitions.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. | NiagaraParameterDefinitions.h | |
bool GetIsPromotedToTopInAddMenus() |
NiagaraParameterDefinitions.h | ||
int32 GetMenuSortOrder() |
NiagaraParameterDefinitions.h | ||
const TArray< UNiagaraScriptVariable * > & GetParametersConst() |
NiagaraParameterDefinitions.h | ||
UNiagaraScriptVariable * GetScriptVariable
(
const FNiagaraVariable& Var |
Getters for script variables. | NiagaraParameterDefinitions.h | |
UNiagaraScriptVariable * GetScriptVariable
(
const FGuid& ScriptVarId |
NiagaraParameterDefinitions.h | ||
bool HasParameter
(
const FNiagaraVariable& Variable |
NiagaraParameterDefinitions.h | ||
void NotifyParameterDefinitionsChanged() |
NiagaraParameterDefinitions.h | ||
void RemoveParameter
(
const FNiagaraVariable& VariableToRemove |
NiagaraParameterDefinitions.h | ||
void RenameParameter
(
const FNiagaraVariable& VariableToRename, |
NiagaraParameterDefinitions.h | ||
void SubscribeBindingNameToExternalParameterDefinitions
(
UNiagaraParameterDefinitions* NewParameterDefinitions, |
NiagaraParameterDefinitions.h | ||
void SynchronizeWithSubscribedParameterDefinitions() |
Synchronize all parameter names in subscribed external parameter libraries to local parameters. | NiagaraParameterDefinitions.h | |
void UnsubscribeBindingNameFromExternalParameterDefinitions
(
const FGuid& InternalScriptVarToUnsubscribeId |
NiagaraParameterDefinitions.h |
Overridden from UNiagaraParameterDefinitionsBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 GetChangeIdHash() |
NiagaraParameterDefinitions.h | ||
| NiagaraParameterDefinitions.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
NiagaraParameterDefinitions.h | ||
virtual void PostLoad() |
NiagaraParameterDefinitions.h |