Navigation
API > API/Plugins > API/Plugins/Niagara
| Name | FNiagaraTypeDefinition |
| Type | struct |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraTypes.h |
| Include Path | #include "NiagaraTypes.h" |
Syntax
USTRUCT ()
struct FNiagaraTypeDefinition
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNiagaraTypeDefinition
(
UScriptStruct* StructDef |
NiagaraTypes.h | ||
FNiagaraTypeDefinition
(
UEnum* EnumDef |
NiagaraTypes.h | ||
FNiagaraTypeDefinition
(
UClass* ClassDef |
NiagaraTypes.h | ||
FNiagaraTypeDefinition
(
UObject* Object |
Construct blank raw type definition. | NiagaraTypes.h | |
| Construct a blank raw type definition. | NiagaraTypes.h | ||
FNiagaraTypeDefinition
(
UScriptStruct* StructDef, |
NiagaraTypes.h | ||
FNiagaraTypeDefinition
(
FProperty* Property, |
NiagaraTypes.h |
Enums
Public
| Name | Remarks |
|---|---|
| EAllowUnfriendlyStruct | |
| FTypeFlags | |
| FUnderlyingType |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BoolDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| BoolStruct | UScriptStruct * | NiagaraTypes.h | |
| BoolStructs | TSet< UStruct * > | NiagaraTypes.h | |
| CollisionEventDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| ColorDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| ColorStruct | UScriptStruct * | NiagaraTypes.h | |
| CoordinateSpaceEnum | UEnum * | NiagaraTypes.h | |
| ExecutionStateEnum | UEnum * | NiagaraTypes.h | |
| ExecutionStateSourceEnum | UEnum * | NiagaraTypes.h | |
| FloatDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| FloatStruct | UScriptStruct * | NiagaraTypes.h | |
| FloatStructs | TSet< UStruct * > | NiagaraTypes.h | |
| FunctionDebugStateEnum | UEnum * | NiagaraTypes.h | |
| HalfDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| HalfStruct | UScriptStruct * | NiagaraTypes.h | |
| HalfVec2Def | FNiagaraTypeDefinition | NiagaraTypes.h | |
| HalfVec2Struct | UScriptStruct * | NiagaraTypes.h | |
| HalfVec3Def | FNiagaraTypeDefinition | NiagaraTypes.h | |
| HalfVec3Struct | UScriptStruct * | NiagaraTypes.h | |
| HalfVec4Def | FNiagaraTypeDefinition | NiagaraTypes.h | |
| HalfVec4Struct | UScriptStruct * | NiagaraTypes.h | |
| IDDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| IDStruct | UScriptStruct * | NiagaraTypes.h | |
| IntDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| IntStruct | UScriptStruct * | NiagaraTypes.h | |
| IntStructs | TSet< UStruct * > | NiagaraTypes.h | |
| Matrix4Def | FNiagaraTypeDefinition | NiagaraTypes.h | |
| Matrix4Struct | UScriptStruct * | NiagaraTypes.h | |
| NumericDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| NumericStruct | UScriptStruct * | NiagaraTypes.h | |
| NumericStructs | TSet< UScriptStruct * > | NiagaraTypes.h | |
| OrderedNumericTypes | TArray< FNiagaraTypeDefinition > | NiagaraTypes.h | |
| OrientationAxisEnum | UEnum * | NiagaraTypes.h | |
| ParameterMapDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| ParameterMapStruct | UScriptStruct * | NiagaraTypes.h | |
| ParameterPanelCategoryEnum | UEnum * | NiagaraTypes.h | |
| ParameterScopeEnum | UEnum * | NiagaraTypes.h | |
| PositionDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| PositionStruct | UScriptStruct * | NiagaraTypes.h | |
| QuatDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| QuatStruct | UScriptStruct * | NiagaraTypes.h | |
| RandInfoDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| RandInfoStruct | UScriptStruct * | NiagaraTypes.h | |
| ScalarStructs | TSet< UScriptStruct * > | NiagaraTypes.h | |
| ScriptContextEnum | UEnum * | NiagaraTypes.h | |
| ScriptUsageEnum | UEnum * | NiagaraTypes.h | |
| SimulationTargetEnum | UEnum * | NiagaraTypes.h | |
| UMaterialClass | UClass * | NiagaraTypes.h | |
| UMaterialDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| UObjectClass | UClass * | NiagaraTypes.h | |
| UObjectDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| USimCacheClassDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| UStaticMeshDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| UTextureClass | UClass * | NiagaraTypes.h | |
| UTextureDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| UTextureRenderTargetClass | UClass * | NiagaraTypes.h | |
| UTextureRenderTargetDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| Vec2Def | FNiagaraTypeDefinition | NiagaraTypes.h | |
| Vec2Struct | UScriptStruct * | NiagaraTypes.h | |
| Vec3Def | FNiagaraTypeDefinition | NiagaraTypes.h | |
| Vec3Struct | UScriptStruct * | NiagaraTypes.h | |
| Vec4Def | FNiagaraTypeDefinition | NiagaraTypes.h | |
| Vec4Struct | UScriptStruct * | NiagaraTypes.h | |
| WildcardDef | FNiagaraTypeDefinition | NiagaraTypes.h | |
| WildcardStruct | UScriptStruct * | NiagaraTypes.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClassStructOrEnum | TObjectPtr< UObject > | Underlying type for this variable, use FUnderlyingType to determine type without casting This can be a UClass, UStruct or UEnum. | NiagaraTypes.h |
|
| UnderlyingType | uint16 | See enumeration FUnderlyingType for possible values. | NiagaraTypes.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Alignment | int16 | NiagaraTypes.h | ||
| Flags | uint8 | NiagaraTypes.h |
|
|
| RegisteredTypeDefIndex | int32 | NiagaraTypes.h | ||
| Size | int16 | NiagaraTypes.h | ||
| UnderlyingTypePathNameHash | uint32 | The type hash of the full path name for the underlying type. | NiagaraTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AppendCompileHash
(
FNiagaraCompileHashVisitor* InVisitor |
NiagaraTypes.h | ||
int32 GetAlignment() |
NiagaraTypes.h | ||
UClass * GetClass() |
Gets the class ptr for this type if it is a class. | NiagaraTypes.h | |
UEnum * GetEnum() |
NiagaraTypes.h | ||
uint32 GetFlags() |
NiagaraTypes.h | ||
FName GetFName() |
NiagaraTypes.h | ||
FString GetName() |
NiagaraTypes.h | ||
FText GetNameText() |
NiagaraTypes.h | ||
UScriptStruct * GetScriptStruct() |
NiagaraTypes.h | ||
int32 GetSize() |
NiagaraTypes.h | ||
UStruct * GetStruct() |
NiagaraTypes.h | ||
bool ImportTextItem
(
const TCHAR*& Buffer, |
NiagaraTypes.h | ||
void Invalidate() |
NiagaraTypes.h | ||
bool IsDataInterface() |
NiagaraTypes.h | ||
bool IsEnum() |
NiagaraTypes.h | ||
bool IsFloatPrimitive() |
NiagaraTypes.h | ||
bool IsIndexType() |
NiagaraTypes.h | ||
bool IsIndexWildcard() |
NiagaraTypes.h | ||
bool IsInternalType() |
NiagaraTypes.h | ||
bool IsSameBaseDefinition
(
const FNiagaraTypeDefinition& Other |
NiagaraTypes.h | ||
bool IsStatic() |
NiagaraTypes.h | ||
bool IsUObject() |
NiagaraTypes.h | ||
bool IsValid() |
NiagaraTypes.h | ||
FNiagaraTypeDefinition RemoveStaticDef() |
NiagaraTypes.h | ||
bool Serialize
(
FArchive& Ar |
NiagaraTypes.h | ||
void SetFlags
(
FTypeFlags InFlags |
NiagaraTypes.h | ||
FNiagaraTypeDefinition ToStaticDef() |
NiagaraTypes.h | ||
FString ToString
(
const uint8* ValueData |
NiagaraTypes.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FNiagaraTypeDefinition & Get() |
Helper to get the correct typedef for templated code. | NiagaraTypes.h | |
static const FNiagaraTypeDefinition & GetBoolDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetBoolStruct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetCollisionEventDef() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetColorDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetColorStruct() |
NiagaraTypes.h | ||
static UEnum * GetCoordinateSpaceEnum() |
NiagaraTypes.h | ||
static UEnum * GetExecutionStateEnum() |
NiagaraTypes.h | ||
static UEnum * GetExecutionStateSouceEnum() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetFloatDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetFloatStruct() |
NiagaraTypes.h | ||
static UEnum * GetFunctionDebugStateEnum() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetGenericNumericDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetGenericNumericStruct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetHalfDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetHalfStruct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetHalfVec2Def() |
NiagaraTypes.h | ||
static UScriptStruct * GetHalfVec2Struct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetHalfVec3Def() |
NiagaraTypes.h | ||
static UScriptStruct * GetHalfVec3Struct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetHalfVec4Def() |
NiagaraTypes.h | ||
static UScriptStruct * GetHalfVec4Struct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetIDDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetIDStruct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetIntDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetIntStruct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetMatrix4Def() |
NiagaraTypes.h | ||
static UScriptStruct * GetMatrix4Struct() |
NiagaraTypes.h | ||
static FNiagaraTypeDefinition GetNumericOutputType
(
TConstArrayView< FNiagaraTypeDefinition > TypeDefinintions, |
NiagaraTypes.h | ||
static const TArray< FNiagaraTypeDefinition > & GetNumericTypes() |
NiagaraTypes.h | ||
static UEnum * GetOrientationAxisEnum() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetParameterMapDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetParameterMapStruct() |
NiagaraTypes.h | ||
static UEnum * GetParameterPanelCategoryEnum() |
NiagaraTypes.h | ||
static UEnum * GetParameterScopeEnum() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetPositionDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetPositionStruct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetQuatDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetQuatStruct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetRandInfoDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetRandInfoStruct() |
NiagaraTypes.h | ||
static UEnum * GetScriptContextEnum() |
NiagaraTypes.h | ||
static UEnum * GetScriptUsageEnum() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetSimCacheClassDef() |
NiagaraTypes.h | ||
static UEnum * GetSimulationTargetEnum() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetUMaterialDef() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetUObjectDef() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetUStaticMeshDef() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetUTextureDef() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetUTextureRenderTargetDef() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetVec2Def() |
NiagaraTypes.h | ||
static UScriptStruct * GetVec2Struct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetVec3Def() |
NiagaraTypes.h | ||
static UScriptStruct * GetVec3Struct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetVec4Def() |
NiagaraTypes.h | ||
static UScriptStruct * GetVec4Struct() |
NiagaraTypes.h | ||
static const FNiagaraTypeDefinition & GetWildcardDef() |
NiagaraTypes.h | ||
static UScriptStruct * GetWildcardStruct() |
NiagaraTypes.h | ||
static void Init() |
NiagaraTypes.h | ||
static bool IsLossyConversion
(
const FNiagaraTypeDefinition& FromType, |
NiagaraTypes.h | ||
static bool IsScalarDefinition
(
const FNiagaraTypeDefinition& Type |
NiagaraTypes.h | ||
static bool IsValidNumericInput
(
const FNiagaraTypeDefinition& TypeDef |
NiagaraTypes.h | ||
static void RecreateUserDefinedTypeRegistry() |
NiagaraTypes.h | ||
static bool TypesAreAssignable
(
const FNiagaraTypeDefinition& InputPinType, |
Evaluates if two pin types are compatible for assignment. Note that the assignment being evaluated is InputPinType = OutputPinType. | NiagaraTypes.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FNiagaraTypeDefinition& Other |
NiagaraTypes.h | ||
bool operator==
(
const FNiagaraTypeDefinition& Other |
NiagaraTypes.h |