1. Epic GamesDeveloper
  3. UAsyncNiagaraCaptureSimCache

UAsyncNiagaraCaptureSimCache

API > API/Plugins > API/Plugins/Niagara

   
Name UAsyncNiagaraCaptureSimCache
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheFunctionLibrary.h
Include Path #include "NiagaraSimCacheFunctionLibrary.h"

Syntax

UCLASS ()  
class UAsyncNiagaraCaptureSimCache : public UCancellableAsyncAction

Inheritance Hierarchy

Classes

Name Remarks
FOnCaptureComplete  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsRunning bool   NiagaraSimCacheFunctionLibrary.h  
CaptureComplete FOnCaptureComplete   NiagaraSimCacheFunctionLibrary.h
  • BlueprintAssignable
CaptureComponent TObjectPtr< UNiagaraComponent >   NiagaraSimCacheFunctionLibrary.h  
CaptureParameters FNiagaraSimCacheCaptureParameters   NiagaraSimCacheFunctionLibrary.h  
CaptureSimCache TObjectPtr< UNiagaraSimCache >   NiagaraSimCacheFunctionLibrary.h  
CreateParameters FNiagaraSimCacheCreateParameters   NiagaraSimCacheFunctionLibrary.h  
SimCacheCapture FNiagaraSimCacheCapture   NiagaraSimCacheFunctionLibrary.h  

Functions

Public

Overridden from UCancellableAsyncAction

Name Remarks Include Path Unreal Specifiers

virtual void Cancel()

   NiagaraSimCacheFunctionLibrary.h  

Overridden from UBlueprintAsyncActionBase

Name Remarks Include Path Unreal Specifiers

virtual void Activate()

   NiagaraSimCacheFunctionLibrary.h  

virtual void SetReadyToDestroy()

   NiagaraSimCacheFunctionLibrary.h  

Static

Name Remarks Include Path Unreal Specifiers

static UAsyncNiagaraCaptureSimCache * CaptureNiagaraSimCache ( UNiagaraSimCache* SimCache,
FNiagaraSimCacheCreateParameters CreateParameters,
UNiagaraComponent* NiagaraComponent,
FNiagaraSimCacheCaptureParameters CaptureParameters,
UNiagaraSimCache*& OutSimCache
)

 Capture a simulation cache with customizable capture parameters. NiagaraSimCacheFunctionLibrary.h
  • BlueprintCallable
  • Meta=(BlueprintInternalUseOnly="true", Category=NiagaraSimCache)

static UAsyncNiagaraCaptureSimCache * CaptureNiagaraSimCacheImpl ( UNiagaraSimCache* SimCache,
const FNiagaraSimCacheCreateParameters& CreateParameters,
UNiagaraComponent* NiagaraComponent,
const FNiagaraSimCacheCaptureParameters& CaptureParameters,
UNiagaraSimCache*& OutSimCache
)

   NiagaraSimCacheFunctionLibrary.h  

static UAsyncNiagaraCaptureSimCache * CaptureNiagaraSimCacheMultiFrame ( UNiagaraSimCache* SimCache,
FNiagaraSimCacheCreateParameters CreateParameters,
UNiagaraComponent* NiagaraComponent,
UNiagaraSimCache*& OutSimCache,
int32 NumFrames,
int32 CaptureRate,
bool bAdvanceSimulation,
float AdvanceDeltaTime
)

 Capture multiple frames from the provided simulation into a SimCache until the simulation becomes inactive, completes or we hit the NumFrames limit. NiagaraSimCacheFunctionLibrary.h
  • BlueprintCallable
  • Meta=(BlueprintInternalUseOnly="true", Category=NiagaraSimCache, AdvancedDisplay="CaptureRate, bAdvanceSimulation, AdvanceDeltaTime")

static UAsyncNiagaraCaptureSimCache * CaptureNiagaraSimCacheUntilComplete ( UNiagaraSimCache* SimCache,
FNiagaraSimCacheCreateParameters CreateParameters,
UNiagaraComponent* NiagaraComponent,
UNiagaraSimCache*& OutSimCache,
int32 CaptureRate,
bool bAdvanceSimulation,
float AdvanceDeltaTime
)

 Capture frames from the provided simulation into a SimCache until the simulation becomes inactive or completes. NiagaraSimCacheFunctionLibrary.h
  • BlueprintCallable
  • Meta=(BlueprintInternalUseOnly="true", Category=NiagaraSimCache, AdvancedDisplay="CaptureRate, bAdvanceSimulation, AdvanceDeltaTime")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page