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.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraFunctionLibrary.h

Include

#include "NiagaraFunctionLibrary.h"

Syntax

UCLASS()
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

Name Description

Public function

UNiagaraFunctionLibrary

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category, Meta

int32

 

AcquireNiagaraGPURayTracedCollisionGroup

(
    UObject* WorldContextObject
)

Returns a free collision group for use in HWRT collision group filtering. Returns -1 on failure.

Public function Static

bool

 

DefineFunctionHLSL

(
    const FNiagaraFunctionSignature& F...,
    FString& HlslOutput
)

Public function Static

UNiagaraData...

 

GetDataInterface

(
    UClass* DIClass,
    UNiagaraComponent* NiagaraSyst...,
    FName OverrideName
)

Finds an array interface of the given class.

Public function Static

TDIType *...

 

GetDataInterface

(
    UNiagaraComponent* NiagaraSyst...,
    FName OverrideName
)

Finds an array interface of the given class.

Public function Static UFunction BlueprintCallable, Category, Meta

UNiagaraPara...

 

GetNiagaraParameterCollection

(
    UObject* WorldContextObject,
    UNiagaraParameterCollection* C...
)

This is gonna be totally reworked.

Public function Static

UNiagaraData...

 

GetSkeletalMeshDataInterface

(
    UNiagaraComponent* NiagaraSyst...,
    const FString& OverrideName
)

Get the skeletal mesh data interface by name .

Public function Static

bool

 

GetVectorVMFastPathExternalFunction

(
    const FVMExternalFunctionBindingInf...,
    FVMExternalFunction& OutFunc
)

Public function Static

const TArray...

 

GetVectorVMFastPathOps

(
    bool bIgnoreConsoleVariable
)

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

OverrideSystemUserVariableSkeletalMeshComponent

(
    UNiagaraComponent* NiagaraSyst...,
    const FString& OverrideName,
    USkeletalMeshComponent* Skelet...
)

Sets a Niagara StaticMesh parameter by name, overriding locally if necessary.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

OverrideSystemUserVariableStaticMesh

(
    UNiagaraComponent* NiagaraSyst...,
    const FString& OverrideName,
    UStaticMesh* StaticMesh
)

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

OverrideSystemUserVariableStaticMeshComponent

(
    UNiagaraComponent* NiagaraSyst...,
    const FString& OverrideName,
    UStaticMeshComponent* StaticMe...
)

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

 

SetSkeletalMeshDataInterfaceSamplingRegions

(
    UNiagaraComponent* NiagaraSyst...,
    const FString& OverrideName,
    const TArray< FName >& SamplingReg...
)

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* NiagaraSyst...,
    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* NiagaraSyst...,
    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* NiagaraSyst...,
    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

UNiagaraComp...

 

SpawnSystemAtLocation

(
    const UObject* WorldContextObj...,
    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

UNiagaraComp...

 

SpawnSystemAtLocationWithParams

(
    FFXSystemSpawnParameters& SpawnPar...
)

Spawns a Niagara System at the specified world location/rotation

Public function Static UFunction BlueprintCallable, Category, Meta

UNiagaraComp...

 

SpawnSystemAttached

(
    UNiagaraSystem* SystemTemplate,
    USceneComponent* AttachToCompo...,
    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

UNiagaraComp...

 

SpawnSystemAttached

(
    UNiagaraSystem* SystemTemplate,
    USceneComponent* AttachToCompo...,
    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

UNiagaraComp...

 

SpawnSystemAttachedWithParams

(
    FFXSystemSpawnParameters& SpawnPar...
)

Spawns a Niagara System attached to a component

Constants

Name

Description

VectorVMOps

VectorVMOpsHLSL