FNiagaraTypeDefinition

API > API/Plugins > API/Plugins/Niagara

References

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

Syntax

USTRUCT ()  
struct FNiagaraTypeDefinition

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere TObjectPtr< UObject > ClassStructOrEnum Underlying type for this variable, use FUnderlyingType to determine type without casting This can be a UClass, UStruct or UEnum.
Public variable UProperty Category, EditAnywhere uint16 UnderlyingType See enumeration FUnderlyingType for possible values.

Constructors

  Type Name Description
Public function   Construct a blank raw type definition.
Public function   Construct blank raw type definition.
Public function    
Public function  

FNiagaraTypeDefinition ( UEnum* EnumDef
)

  
Public function    
Public function  

FNiagaraTypeDefinition ( UScriptStruct* StructDef,
EAllowUnfriendlyStruct AllowUnfriendlyStruct
)

  
Public function  

FNiagaraTypeDefinition ( FProperty* Property,
EAllowUnfriendlyStruct AllowUnfriendlyStruct
)

  

Functions

  Type Name Description
Public function Const bool  
Public function Static const FNiagaraTypeDefinition &

Get ()

 Helper to get the correct typedef for templated code.
Public function Const int32  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Const UClass * Gets the class ptr for this type if it is a class.
Public function Static const FNiagaraTypeDefinition &  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static UEnum *  
Public function Const UEnum *

GetEnum ()

  
Public function Static UEnum *  
Public function Static UEnum *  
Public function Const uint32  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Const FName  
Public function Static UEnum *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Const FString

GetName ()

  
Public function Const FText  
Public function Static FNiagaraTypeDefinition

GetNumericOutputType ( TConstArrayView< FNiagaraTypeDefinition > TypeDefinintions,
ENiagaraNumericOutputTypeSelectionMode SelectionMode
)

  
Public function Static const TArray< FNiagaraTypeDefinition > &  
Public function Static UEnum *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static UEnum *  
Public function Static UEnum *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static UEnum *  
Public function Const UScriptStruct *  
Public function Static UEnum *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UEnum *  
Public function Const int32

GetSize ()

  
Public function Const UStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static const FNiagaraTypeDefinition &  
Public function Static const FNiagaraTypeDefinition &  
Public function Static const FNiagaraTypeDefinition &  
Public function Static const FNiagaraTypeDefinition &  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static const FNiagaraTypeDefinition &  
Public function Static UScriptStruct *  
Public function Static void

Init ()

  
Public function Const bool  
Public function Const bool

IsEnum ()

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Static bool  
Public function Const bool  
Public function Static bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function Static bool  
Public function Static void  
Public function Const FNiagaraTypeDefinition  
Public function bool  
Public function void

SetFlags ( FTypeFlags InFlags
)

  
Public function Const FNiagaraTypeDefinition  
Public function Const FString

ToString ( const uint8* ValueData
)

  
Public function Static bool

TypesAreAssignable ( const FNiagaraTypeDefinition& InputPinType,
const FNiagaraTypeDefinition& OutputPinType,
bool bAllowLossyLWCConversions
)

 Evaluates if two pin types are compatible for assignment. Note that the assignment being evaluated is InputPinType = OutputPinType.

Operators

  Type Name Description
Public function Const bool  
Public function Const bool  

Enums

  Type Name Description
Public enum EAllowUnfriendlyStruct    
Public enum FTypeFlags    
Public enum FUnderlyingType    

Constants

Name Description
BoolDef  
BoolStruct  
BoolStructs  
CollisionEventDef  
ColorDef  
ColorStruct  
CoordinateSpaceEnum  
ExecutionStateEnum  
ExecutionStateSourceEnum  
FloatDef  
FloatStruct  
FloatStructs  
FunctionDebugStateEnum  
HalfDef  
HalfStruct  
HalfVec2Def  
HalfVec2Struct  
HalfVec3Def  
HalfVec3Struct  
HalfVec4Def  
HalfVec4Struct  
IDDef  
IDStruct  
IntDef  
IntStruct  
IntStructs  
Matrix4Def  
Matrix4Struct  
NumericDef  
NumericStruct  
NumericStructs  
OrderedNumericTypes  
OrientationAxisEnum  
ParameterMapDef  
ParameterMapStruct  
ParameterPanelCategoryEnum  
ParameterScopeEnum  
PositionDef  
PositionStruct  
QuatDef  
QuatStruct  
RandInfoDef  
RandInfoStruct  
ScalarStructs  
ScriptContextEnum  
ScriptUsageEnum  
SimulationTargetEnum  
UMaterialClass  
UMaterialDef  
UObjectClass  
UObjectDef  
USimCacheClassDef  
UStaticMeshDef  
UTextureClass  
UTextureDef  
UTextureRenderTargetClass  
UTextureRenderTargetDef  
Vec2Def  
Vec2Struct  
Vec3Def  
Vec3Struct  
Vec4Def  
Vec4Struct  
WildcardDef  
WildcardStruct  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page