Navigation
API > API/Plugins > API/Plugins/Niagara > API/Plugins/Niagara/UAsyncNiagaraCaptureSimCache
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheFunctionLibrary.h |
| Include | #include "NiagaraSimCacheFunctionLibrary.h" |
| Source | /Engine/Plugins/FX/Niagara/Source/Niagara/Private/NiagaraSimCacheFunctionLibrary.cpp |
UFUNCTION (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
)
Remarks
Capture frames from the provided simulation into a SimCache until the simulation becomes inactive or completes. Capture occurs at the end of each frame with the first frame being this frame. CaptureRate allows you to reduce the rate of capture, i.e. a rate of 2 would capture frames 0, 2, 4, etc. When AdvanceSimulation is true we will manually advance the simulation until the capture is complete inside a loop, rather than reading from the component each frame.