1. Epic GamesDeveloper
  3. FNiagaraFunctionSignature

FNiagaraFunctionSignature

API > API/Plugins > API/Plugins/Niagara

References

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

Syntax

USTRUCT ()  
struct FNiagaraFunctionSignature

Variables

  Type Name Description
Public variable UProperty uint32: 1 bExperimental Is this function experimental?
Public variable UProperty Transient uint32: 1 bHidden Hidden functions can not be placed but may be bound and used.
Public variable UProperty uint32: 1 bIsCompileTagGenerator Whether or not this function should be treated as a compile tag.
Public variable UProperty uint32: 1 bMemberFunction True if this is the signature for a "member" function of a data interface.
Public variable UProperty uint32: 1 bReadFunction Reads data owned by the data interface. Any stage using it will be marked as an Input stage.
Public variable UProperty uint32: 1 bRequiresContext  
Public variable UProperty 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.
Public variable UProperty uint32: 1 bSoftDeprecatedFunction Whether or not this function should show up in normal usage.
Public variable UProperty uint32: 1 bSupportsCPU Support running on the CPU.
Public variable UProperty uint32: 1 bSupportsGPU Support running on the GPU.
Public variable UProperty uint32: 1 bWriteFunction Writes data owned by the data interface. Any stage using it will be marked as an Output stage.
Public variable UProperty int32 ContextStageIndex When using simulation stages and bRequiresContext is true this will be the index of the stage that is associated with the function.
Public variable UProperty Meta FText Description Localized description of this node.
Public variable UProperty Category, EditAnywhere, Meta FText ExperimentalMessage The message to display when a function is marked experimental.
Public variable UProperty TMap< FName, FName > FunctionSpecifiers Function specifiers verified at bind time.
Public variable UProperty uint32 FunctionVersion Per function version, it is up to the discretion of the function as to what the version means.
Public variable UProperty Meta TMap< FNiagaraVariableBase, FText > InputDescriptions  
Public variable UProperty TArray< FNiagaraVariable > Inputs Input parameters to this function. The data stored in the variables is used for default values.
Public variable UProperty Meta uint16 MiscUsageBitMask Bit mask for misc usage.
Public variable UProperty Meta int32 ModuleUsageBitmask Bitmask for which scripts are supported for this function.
Public variable UProperty FName Name Name of the function.
Public variable UProperty TArray< FNiagaraVariableBase > NoDefaultValueInputs All the inputs here must be wired to something in the graph and will produce a compile error if that's not the case.
Public variable UProperty Meta TMap< FNiagaraVariableBase, FText > OutputDescriptions  
Public variable UProperty TArray< FNiagaraVariableBase > Outputs Output parameters of this function.
Public variable UProperty FName OwnerName Id of the owner is this is a member function.
Public variable UProperty int16 RequiredInputs Number of required inputs.
Public variable UProperty int16 RequiredOutputs Number of required outputs.
Public variable UProperty Meta FString SourceFile  
Public variable UProperty Meta int32 SourceLine  

Constructors

  Type Name Description
Public function    
Public function  

FNiagaraFunctionSignature ( FName InName,
TArray< FNiagaraVariable >& InInputs,
TArray< FNiagaraVariable >& InOutputs,
FName InSource,
bool bInRequiresContext,
bool bInMemberFunction
)

  

Functions

  Type Name Description
Public function void

AddInput ( const FNiagaraVariable& InputVar,
const FText& Tooltip
)

  
Public function void

AddInputWithDefault ( FNiagaraVariable InputVar,
const T& Default,
const FText& Tooltip
)

  
Public function void

AddInputWithoutDefault ( const FNiagaraVariable& InputVar,
const FText& Tooltip
)

  
Public function void

AddOutput ( const FNiagaraVariable& OutputVar,
const FText& Tooltip
)

  
Public function Const bool  
Public function Const FText  
Public function Const TArray< FNiagaraVariableBase >  
Public function Const FString  
Public function Const TConstArrayView< FNiagaraVariableBase >  
Public function Const void

GetVariadicInputs ( TArray< FNiagaraVariableBase >& OutVariadicInputs
)

  
Public function Const void

GetVariadicOutputs ( TArray< FNiagaraVariableBase >& OutVariadicOutputs
)

  
Public function Const bool

IsValid ()

  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function void

SetDescription ( const FText& Desc
)

  
Public function void  
Public function void

SetInputDescription ( const FNiagaraVariableBase& Variable,
const FText& Desc
)

  
Public function void

SetOutputDescription ( const FNiagaraVariableBase& Variable,
const FText& Desc
)

  
Public function Const bool  
Public function Const int32  
Public function Const bool  
Public function Const int32  

Operators

  Type Name Description
Public function Const bool  
Public function Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page