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

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;MinimalAPI&41;  
class UNiagaraFunctionLibrary : public UBlueprintFunctionLibrary

Remarks

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.

Constructors

  Type Name Description
Public function  

UNiagaraFunctionLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta int32 Returns a free collision group for use in HWRT collision group filtering. Returns -1 on failure.
Public function Static bool

DefineFunctionHLSL ( const FNiagaraFunctionSignature& FunctionSignature,
FString& HlslOutput
)

  
Public function Static UNiagaraDataInterface *

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

 Finds an array interface of the given class.
Public function Static TDIType *

GetDataInterface ( UNiagaraComponent* NiagaraSystem,
FName OverrideName
)

 Finds an array interface of the given class.
Public function Static UFunction BlueprintCallable, Category, Meta UNiagaraParameterCollectionInstance * This is gonna be totally reworked.
Public function Static UNiagaraDataInterfaceSkeletalMesh *

GetSkeletalMeshDataInterface ( UNiagaraComponent* NiagaraSystem,
const FString& OverrideName
)

 Get the skeletal mesh data interface by name .
Public function Static bool

GetVectorVMFastPathExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
FVMExternalFunction& OutFunc
)

  
Public function Static const TArray< FNiagaraFunctionSignature > &

GetVectorVMFastPathOps ( bool bIgnoreConsoleVariable
)

  
Public function Static UFunction BlueprintCallable, Category, Meta void

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

 Sets a Niagara StaticMesh parameter by name, overriding locally if necessary.
Public function Static UFunction BlueprintCallable, Category, Meta void

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

  
Public function Static UFunction BlueprintCallable, Category, Meta void

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

 Sets a Niagara StaticMesh parameter by name, overriding locally if necessary.
Public function Static UFunction BlueprintCallable, Category, Meta void

ReleaseNiagaraGPURayTracedCollisionGroup ( UObject* WorldContextObject,
int32 CollisionGroup
)

 Releases a collision group back to the system for use by ohers.
Public function Static UFunction BlueprintCallable, Category, Meta void

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

 Sets the Niagara GPU ray traced collision group for all primitive components on the given actor.
Public function Static UFunction BlueprintCallable, Category, Meta void

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

 Sets the Niagara GPU ray traced collision group for the give primitive component.
Public function Static UFunction BlueprintCallable, Category 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.
Public function Static UFunction BlueprintCallable, Category 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.
Public function Static UFunction BlueprintCallable, Category 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.
Public function Static UFunction BlueprintCallable, Category void

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

 Overrides the 2D Array Texture for a Niagara 2D Array Texture Data Interface User Parameter.
Public function Static UFunction BlueprintCallable, Category void

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

 Overrides the Texture Object for a Niagara Texture Data Interface User Parameter.
Public function Static UFunction BlueprintCallable, Category void

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

 Overrides the Volume Texture for a Niagara Volume Texture Data Interface User Parameter.
Public function Static UFunction BlueprintCallable, Category, Meta 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
Public function Static UFunction BlueprintCallable, Category, Meta UNiagaraComponent * Spawns a Niagara System at the specified world location/rotation
Public function Static UFunction BlueprintCallable, Category, Meta 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
Public function 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
)

  
Public function Static UFunction BlueprintCallable, Category, Meta UNiagaraComponent * Spawns a Niagara System attached to a component

Constants

Name Description
VectorVMOps  
VectorVMOpsHLSL  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page