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 > FNiagaraTypeDefinition

Light Theme

Dark Theme

FNiagaraTypeDefinition

References

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

Syntax

USTRUCT()
struct FNiagaraTypeDefinition

Variables

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

Constructors

	Name	Description
	FNiagaraTypeDefinition()	Construct a blank raw type definition.
	FNiagaraTypeDefinition ( UObject* Object )	Construct blank raw type definition.
	FNiagaraTypeDefinition ( UClass* ClassDef )
	FNiagaraTypeDefinition ( UEnum* EnumDef )
	FNiagaraTypeDefinition ( UScriptStruct* StructDef )
	FNiagaraTypeDefinition ( const FNiagaraTypeDefinition& Othe... )
	FNiagaraTypeDefinition ( UScriptStruct* StructDef, EAllowUnfriendlyStruct AllowUnfrien... )
	FNiagaraTypeDefinition ( FProperty* Property, EAllowUnfriendlyStruct AllowUnfrien... )

Functions

	Name	Description
bool	AppendCompileHash ( FNiagaraCompileHashVisitor* In... )
const FNiaga...	Get()	Helper to get the correct typedef for templated code.
int32	GetAlignment()
const FNiaga...	GetBoolDef()
UScriptStruc...	GetBoolStruct()
UClass *	GetClass()	Gets the class ptr for this type if it is a class.
const FNiaga...	GetCollisionEventDef()
const FNiaga...	GetColorDef()
UScriptStruc...	GetColorStruct()
UEnum *	GetCoordinateSpaceEnum()
UEnum *	GetEnum()
UEnum *	GetExecutionStateEnum()
UEnum *	GetExecutionStateSouceEnum()
uint32	GetFlags()
const FNiaga...	GetFloatDef()
UScriptStruc...	GetFloatStruct()
FName	GetFName()
UEnum *	GetFunctionDebugStateEnum()
const FNiaga...	GetGenericNumericDef()
UScriptStruc...	GetGenericNumericStruct()
const FNiaga...	GetHalfDef()
UScriptStruc...	GetHalfStruct()
const FNiaga...	GetHalfVec2Def()
UScriptStruc...	GetHalfVec2Struct()
const FNiaga...	GetHalfVec3Def()
UScriptStruc...	GetHalfVec3Struct()
const FNiaga...	GetHalfVec4Def()
UScriptStruc...	GetHalfVec4Struct()
const FNiaga...	GetIDDef()
UScriptStruc...	GetIDStruct()
const FNiaga...	GetIntDef()
UScriptStruc...	GetIntStruct()
const FNiaga...	GetMatrix4Def()
UScriptStruc...	GetMatrix4Struct()
FString	GetName()
FText	GetNameText()
FNiagaraType...	GetNumericOutputType ( const TArray< FNiagaraTypeDefinitio..., ENiagaraNumericOutputTypeSelectionM... )
const TArray...	GetNumericTypes()
UEnum *	GetOrientationAxisEnum()
const FNiaga...	GetParameterMapDef()
UScriptStruc...	GetParameterMapStruct()
UEnum *	GetParameterPanelCategoryEnum()
UEnum *	GetParameterScopeEnum()
const FNiaga...	GetPositionDef()
UScriptStruc...	GetPositionStruct()
const FNiaga...	GetQuatDef()
UScriptStruc...	GetQuatStruct()
const FNiaga...	GetRandInfoDef()
UScriptStruc...	GetRandInfoStruct()
UEnum *	GetScriptContextEnum()
UScriptStruc...	GetScriptStruct()
UEnum *	GetScriptUsageEnum()
const FNiaga...	GetSimCacheClassDef()
UEnum *	GetSimulationTargetEnum()
int32	GetSize()
UStruct *...	GetStruct()
const FNiaga...	GetUMaterialDef()
const FNiaga...	GetUObjectDef()
const FNiaga...	GetUStaticMeshDef()
const FNiaga...	GetUTextureDef()
const FNiaga...	GetUTextureRenderTargetDef()
const FNiaga...	GetVec2Def()
UScriptStruc...	GetVec2Struct()
const FNiaga...	GetVec3Def()
UScriptStruc...	GetVec3Struct()
const FNiaga...	GetVec4Def()
UScriptStruc...	GetVec4Struct()
const FNiaga...	GetWildcardDef()
UScriptStruc...	GetWildcardStruct()
void	Init()
bool	IsDataInterface()
bool	IsEnum()
bool	IsFloatPrimitive()
bool	IsIndexType()
bool	IsIndexWildcard()
bool	IsInternalType()
bool	IsLossyConversion ( const FNiagaraTypeDefinition& From..., const FNiagaraTypeDefinition& ToTy... )
bool	IsSameBaseDefinition ( const FNiagaraTypeDefinition& Othe... )
bool	IsScalarDefinition ( const FNiagaraTypeDefinition& Type )
bool	IsStatic()
bool	IsUObject()
bool	IsValid()
bool	IsValidNumericInput ( const FNiagaraTypeDefinition& Type... )
void	RecreateUserDefinedTypeRegistry()
bool	Serialize ( FArchive& Ar )
void	SetFlags ( FTypeFlags InFlags )
FNiagaraType...	ToStaticDef()
FString	ToString ( const uint8* ValueData )
bool	TypesAreAssignable ( const FNiagaraTypeDefinition& Type..., const FNiagaraTypeDefinition& Type..., bool bAllowLossyLWCConversions )

Operators

		Name	Description
	bool	operator!= ( const FNiagaraTypeDefinition& Othe... )
	bool	operator== ( const FNiagaraTypeDefinition& Othe... )

Enums

	Name	Description
	EAllowUnfriendlyStruct
	FTypeFlags
	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

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

Take our survey

Cancel