FNiagaraVariableMetaData | Unreal Engine 5.7 Documentation | Epic Developer Community

API > API/Plugins > API/Plugins/Niagara


Name	FNiagaraVariableMetaData
Type	struct
Header File	/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraVariableMetaData.h
Include Path	#include "NiagaraVariableMetaData.h"

Syntax

USTRUCT ()  
struct FNiagaraVariableMetaData

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FNiagaraVariableMetaData()		NiagaraVariableMetaData.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AlternateAliases	TArray< FName >		NiagaraVariableMetaData.h	EditAnywhere Category="Variable" DisplayName="Alternate Aliases For Variable" AdvancedDisplay Meta=(ToolTip="List of alternate/previous names for this variable. Note that this is not normally needed if you rename through the UX. However, if you delete and then add a different variable, intending for it to match, you will likely want to add the prior name here.\n\nYou may need to restart and reload assets after making this change to have it take effect on already loaded assets.")
bAdvancedDisplay	bool	Declares that this input is advanced and should only be visible if expanded inputs have been expanded.	NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(SkipForCompileHash="true")
bDisplayInOverviewStack	bool	Declares that this parameter's value will be shown in the overview node if it's set to a local value.	NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(SkipForCompileHash="true")
bEnableBoolOverride	bool		NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(InlineEditConditionToggle, ToolTip="Useful to override inline bool visualization in the overview.", SkipForCompileHash="true")
bInlineEditConditionToggle	bool	Declares the associated input is used as an inline edit condition toggle, so it should be hidden and edited as a checkbox inline with the input which was designated as its edit condition.	NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(SkipForCompileHash="true")
bOverrideColor	bool		NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(InlineEditConditionToggle, ToolTip="The color used to display a parameter in the overview. If no color is specified, the type color is used.", SkipForCompileHash="true")
Description	FText		NiagaraVariableMetaData.h	EditAnywhere Category="Variable" DisplayName="Tooltip" Meta=(MultiLine=true, SkipForCompileHash="true")
DisplayUnit	EUnit	The unit to display next to input fields for this parameter - note that this is only a visual indicator and does not change any of the calculations.	NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(SkipForCompileHash="true")
EditCondition	FNiagaraInputConditionMetadata	Declares the associated input should be conditionally editable based on the value of another input.	NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(SkipForCompileHash="true")
InlineParameterBoolOverride	FNiagaraBoolParameterMetaData		NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(EditCondition="bEnableBoolOverride", ToolTip="Useful to override inline bool visualization in the overview.", SkipForCompileHash="true")
InlineParameterColorOverride	FLinearColor		NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(EditCondition="bOverrideColor", ToolTip="The color used to display a parameter in the overview. If no color is specified, the type color is used.", SkipForCompileHash="true")
InlineParameterEnumOverrides	TArray< FNiagaraEnumParameterMetaData >		NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(EditCondition="bDisplayInOverviewStack", ToolTip="The index of the entry maps to the index of an enum value. Useful for overriding how an enum parameter is displayed in the overview.", SkipForCompileHash="true")
InlineParameterSortPriority	int32		NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(EditCondition="bDisplayInOverviewStack", ToolTip="Affects the sort order for parameters shown inline in the overview. Use a smaller number to push it to the top. Defaults to zero.", SkipForCompileHash="true")
PropertyMetaData	TMap< FName, FString >		NiagaraVariableMetaData.h	EditAnywhere Category="Variable" DisplayName="Property Metadata" Meta=(ToolTip="Property Metadata", SkipForCompileHash="true")
VisibleCondition	FNiagaraInputConditionMetadata	Declares the associated input should be conditionally visible based on the value of another input.	NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(SkipForCompileHash="true")
WidgetCustomization	FNiagaraInputParameterCustomization	Changes how the input is displayed.	NiagaraVariableMetaData.h	EditAnywhere Category="Variable" Meta=(SkipForCompileHash="true")

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
VariableGuid	FGuid	A unique identifier for the variable that can be used by function call nodes to find renamed variables.	NiagaraVariableMetaData.h	Meta=(SkipForCompileHash="true")

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
void CopyUserEditableMetaData ( const FNiagaraVariableMetaData& OtherMetaData )	Copies all the properties that are marked as editable for the user (e.g. EditAnywhere).	NiagaraVariableMetaData.h
void CreateNewGuid()		NiagaraVariableMetaData.h
FGuid GetVariableGuid()		NiagaraVariableMetaData.h
void SetVariableGuid ( const FGuid& InVariableGuid )	Note, the Variable Guid is generally expected to be immutable.	NiagaraVariableMetaData.h

Deprecated Functions

Name	Remarks	Include Path	Unreal Specifiers
FText GetCategoryName_DEPRECATED()		NiagaraVariableMetaData.h
int32 GetEditorSortPriority_DEPRECATED()		NiagaraVariableMetaData.h
bool GetIsStaticSwitch_DEPRECATED()		NiagaraVariableMetaData.h
FName GetParentAttribute_DEPRECATED()		NiagaraVariableMetaData.h
int32 GetStaticSwitchDefaultValue_DEPRECATED()		NiagaraVariableMetaData.h

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library