Navigation
API > API/Plugins > API/Plugins/Niagara > API/Plugins/Niagara/UNiagaraSimCacheFunctionLibrary
Description
Captures the simulations current frame data into the SimCache. This happens immediately so you may need to be careful with tick order of the component you are capturing from. The return can be invalid if the component can not be captured for some reason (i.e. not active). When AdvanceSimulation is true we will manually advance the simulation one frame using the provided AdvanceDeltaTime before capturing.
| Name | CaptureNiagaraSimCacheImmediate |
| Type | function |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheFunctionLibrary.h |
| Include Path | #include "NiagaraSimCacheFunctionLibrary.h" |
| Source | /Engine/Plugins/FX/Niagara/Source/Niagara/Private/NiagaraSimCacheFunctionLibrary.cpp |
UFUNCTION (BlueprintCallable, Category=NiagaraSimCache, Meta=(ReturnDisplayName="Success"))
static bool CaptureNiagaraSimCacheImmediate
(
UNiagaraSimCache * SimCache,
FNiagaraSimCacheCreateParameters CreateParameters,
UNiagaraComponent * NiagaraComponent,
UNiagaraSimCache *& OutSimCache,
bool bAdvanceSimulation,
float AdvanceDeltaTime
)