Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > FNiagaraFunctionSignature

Light Theme

Dark Theme

FNiagaraFunctionSignature

Windows

MacOS

Linux

References

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

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FNiagaraFunctionSignature

Variables

	Name	Description
uint32: 1	bExperimental	Is this function experimental?
uint32: 1	bHidden	Hidden functions can not be placed but may be bound and used.
uint32: 1	bIsCompileTagGenerator	Whether or not this function should be treated as a compile tag.
uint32: 1	bMemberFunction	True if this is the signature for a "member" function of a data interface.
uint32: 1	bRequiresContext
uint32: 1	bRequiresExecPin	Does this function need an exec pin for control flow because it has internal side effects that be seen by the script VM and could therefore be optimized out? If so, set to true.
uint32: 1	bSoftDeprecatedFunction	Whether or not this function should show up in normal usage.
uint32: 1	bSupportsCPU	Support running on the CPU.
uint32: 1	bSupportsGPU	Support running on the GPU.
uint32: 1	bWriteFunction	Writes to the variable this is bound to
int32	ContextStageMaxIndex
int32	ContextStageMinIndex	When using simulation stages and bRequiresContext is true this will be the index of the stage that is associated with the function.
FText	Description	Localized description of this node.
FText	ExperimentalMessage	The message to display when a function is marked experimental.
TMap< FName, FN...	FunctionSpecifiers	Function specifiers verified at bind time.
uint32	FunctionVersion	Per function version, it is up to the discretion of the function as to what the version means.
TMap< FNiagaraV...	InputDescriptions
TArray< FNiagar...	Inputs	Input parameters to this function.
int32	ModuleUsageBitmask	Bitmask for which scripts are supported for this function.
FName	Name	Name of the function.
TMap< FNiagaraV...	OutputDescriptions
TArray< FNiagar...	Outputs	Input parameters of this function.
FName	OwnerName	Id of the owner is this is a member function.

Constructors

	Name	Description
	FNiagaraFunctionSignature()
	FNiagaraFunctionSignature ( FName InName, TArray< FNiagaraVariable >& InInpu..., TArray< FNiagaraVariable >& InOutp..., FName InSource, bool bInRequiresContext, bool bInMemberFunction )

Functions

		Name	Description
	void	AddInput ( FNiagaraVariable InputVar, FText Tooltip )
	void	AddOutput ( FNiagaraVariable OutputVar, const FText& Tooltip )
	bool	EqualsIgnoringSpecifiers ( const FNiagaraFunctionSignature& O... )
	FText	GetDescription()
	FString	GetName()
	bool	IsValid()
	void	SetDescription ( const FText& Desc )

Operators

		Name	Description
	bool	operator== ( const FNiagaraFunctionSignature& O... )

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

Take our survey

Dismiss