1. Epic GamesDeveloper
  3. UNiagaraFunctionLibrary

UNiagaraFunctionLibrary

A C++ and Blueprint accessible library of utility functions for accessing Niagara simulations All positions & orientations are returned in Unreal reference frame & units, assuming the Leap device is located at the origin.

API > API/Plugins > API/Plugins/Niagara

A C++ and Blueprint accessible library of utility functions for accessing Niagara simulations All positions & orientations are returned in Unreal reference frame & units, assuming the Leap device is located at the origin.

   
Name UNiagaraFunctionLibrary
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraFunctionLibrary.h
Include Path #include "NiagaraFunctionLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UNiagaraFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraFunctionLibrary ( const FObjectInitializer& ObjectInitializer
)

   NiagaraFunctionLibrary.h  

Constants

Name Type Remarks Include Path
VectorVMOps TArray< FNiagaraFunctionSignature >   NiagaraFunctionLibrary.h
VectorVMOpsHLSL TArray< FString >   NiagaraFunctionLibrary.h

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static int32 AcquireNiagaraGPURayTracedCollisionGroup ( UObject* WorldContextObject
)

 Returns a free collision group for use in HWRT collision group filtering. Returns -1 on failure. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(Keywords="niagara collision ray tracing", WorldContext="WorldContextObject")

static bool DefineFunctionHLSL ( const FNiagaraFunctionSignature& FunctionSignature,
FString& HlslOutput
)

   NiagaraFunctionLibrary.h  

static UNiagaraDataInterface * GetDataInterface ( UClass* DIClass,
UNiagaraComponent* NiagaraSystem,
FName OverrideName
)

 Finds an array interface of the given class. NiagaraFunctionLibrary.h  

static TDIType * GetDataInterface ( UNiagaraComponent* NiagaraSystem,
FName OverrideName
)

 Finds an array interface of the given class. NiagaraFunctionLibrary.h  

static UNiagaraParameterCollectionInstance * GetNiagaraParameterCollection ( UObject* WorldContextObject,
UNiagaraParameterCollection* Collection
)

 This is gonna be totally reworked. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(Keywords="niagara parameter collection", WorldContext="WorldContextObject")

static UNiagaraDataInterfaceSkeletalMesh * GetSkeletalMeshDataInterface ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName
)

 Get the skeletal mesh data interface by name . NiagaraFunctionLibrary.h  

static bool GetVectorVMFastPathExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
FVMExternalFunction& OutFunc
)

   NiagaraFunctionLibrary.h  

static const TArray< FNiagaraFunctionSignature > & GetVectorVMFastPathOps ( bool bIgnoreConsoleVariable
)

   NiagaraFunctionLibrary.h  

static void InitVectorVMFastPathOps()

   NiagaraFunctionLibrary.h  

static void OverrideSystemUserVariableSkeletalMeshComponent ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName,
USkeletalMeshComponent* SkeletalMeshComponent
)

 Sets a Niagara StaticMesh parameter by name, overriding locally if necessary. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Skeletal Mesh Component")

static void OverrideSystemUserVariableStaticMesh ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName,
UStaticMesh* StaticMesh
)

   NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Static Mesh Directly")

static void OverrideSystemUserVariableStaticMeshComponent ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName,
UStaticMeshComponent* StaticMeshComponent
)

 Sets a Niagara StaticMesh parameter by name, overriding locally if necessary. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Static Mesh Component")

static void ReleaseNiagaraGPURayTracedCollisionGroup ( UObject* WorldContextObject,
int32 CollisionGroup
)

 Releases a collision group back to the system for use by ohers. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(Keywords="niagara collision ray tracing", WorldContext="WorldContextObject")

static void SetActorNiagaraGPURayTracedCollisionGroup ( UObject* WorldContextObject,
AActor* Actor,
int32 CollisionGroup
)

 Sets the Niagara GPU ray traced collision group for all primitive components on the given actor. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(Keywords="niagara collision ray tracing", WorldContext="WorldContextObject")

static void SetComponentNiagaraGPURayTracedCollisionGroup ( UObject* WorldContextObject,
UPrimitiveComponent* Primitive,
int32 CollisionGroup
)

 Sets the Niagara GPU ray traced collision group for the give primitive component. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(Keywords="niagara collision ray tracing", WorldContext="WorldContextObject")

static void SetSceneCapture2DDataInterfaceManagedMode ( UNiagaraComponent* NiagaraSystem,
const FName& DIName,
ESceneCaptureSource ManagedCaptureSource,
FIntPoint ManagedTextureSize,
ETextureRenderTargetFormat ManagedTextureFormat,
ECameraProjectionMode::Type ManagedProjectionType,
float ManagedFOVAngle,
float ManagedOrthoWidth,
bool bManagedCaptureEveryFrame,
bool bManagedCaptureOnMovement,
const TArray< AActor* >& ShowOnlyActors
)

 Sets managed mode parameters for the Scene capture 2D data interface, this is destructive as it modifies the data interface. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara

static void SetSkeletalMeshDataInterfaceFilteredBones ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName,
const TArray< FName >& FilteredBones
)

 Sets the Filtered Bones to use on the skeletal mesh data interface, this is destructive as it modifies the data interface. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara

static void SetSkeletalMeshDataInterfaceFilteredSockets ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName,
const TArray< FName >& FilteredSockets
)

 Sets the Filtered Sockets to use on the skeletal mesh data interface, this is destructive as it modifies the data interface. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara

static void SetSkeletalMeshDataInterfaceSamplingRegions ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName,
const TArray< FName >& SamplingRegions
)

 Sets the SamplingRegion to use on the skeletal mesh data interface, this is destructive as it modifies the data interface. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara

static void SetTexture2DArrayObject ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName,
UTexture2DArray* Texture
)

 Overrides the 2D Array Texture for a Niagara 2D Array Texture Data Interface User Parameter. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara

static void SetTextureObject ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName,
UTexture* Texture
)

 Overrides the Texture Object for a Niagara Texture Data Interface User Parameter. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara

static void SetVolumeTextureObject ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName,
UVolumeTexture* Texture
)

 Overrides the Volume Texture for a Niagara Volume Texture Data Interface User Parameter. NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara

static UNiagaraComponent * SpawnSystemAtLocation ( const UObject* WorldContextObject,
UNiagaraSystem* SystemTemplate,
FVector Location,
FRotator Rotation,
FVector Scale,
bool bAutoDestroy,
bool bAutoActivate,
ENCPoolMethod PoolingMethod,
bool bPreCullCheck
)

 Spawns a Niagara System at the specified world location/rotation NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(Keywords="niagara System", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static UNiagaraComponent * SpawnSystemAtLocationWithParams ( const FFXSystemSpawnParameters& SpawnParams
)

 Spawns a Niagara System at the specified world location/rotation NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(Keywords="niagara System", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static UNiagaraComponent * SpawnSystemAttached ( UNiagaraSystem* SystemTemplate,
USceneComponent* AttachToComponent,
FName AttachPointName,
FVector Location,
FRotator Rotation,
EAttachLocation::Type LocationType,
bool bAutoDestroy,
bool bAutoActivate,
ENCPoolMethod PoolingMethod,
bool bPreCullCheck
)

 Spawns a Niagara System attached to a component NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(Keywords="niagara System", UnsafeDuringActorConstruction="true")

static UNiagaraComponent * SpawnSystemAttached ( UNiagaraSystem* SystemTemplate,
USceneComponent* AttachToComponent,
FName AttachPointName,
FVector Location,
FRotator Rotation,
FVector Scale,
EAttachLocation::Type LocationType,
bool bAutoDestroy,
ENCPoolMethod PoolingMethod,
bool bAutoActivate,
bool bPreCullCheck
)

   NiagaraFunctionLibrary.h  

static UNiagaraComponent * SpawnSystemAttachedWithParams ( const FFXSystemSpawnParameters& SpawnParams
)

 Spawns a Niagara System attached to a component NiagaraFunctionLibrary.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(Keywords="niagara System", UnsafeDuringActorConstruction="true")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page