Navigation
API > API/Plugins > API/Plugins/Niagara
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UBlueprintAsyncActionBase
- UCancellableAsyncAction
- UAsyncNiagaraCaptureSimCache
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheFunctionLibrary.h |
| Include | #include "NiagaraSimCacheFunctionLibrary.h" |
Syntax
UCLASS&40;&41;
class UAsyncNiagaraCaptureSimCache : public UCancellableAsyncAction
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bIsRunning | ||
| FOnCaptureComplete | CaptureComplete | ||
| TObjectPtr< UNiagaraComponent > | CaptureComponent | ||
| FNiagaraSimCacheCaptureParameters | CaptureParameters | ||
| TObjectPtr< UNiagaraSimCache > | CaptureSimCache | ||
| FNiagaraSimCacheCreateParameters | CreateParameters | ||
| FNiagaraSimCacheCapture | SimCacheCapture |
Functions
| Type | Name | Description | |
|---|---|---|---|
| UAsyncNiagaraCaptureSimCache * | CaptureNiagaraSimCache
(
UNiagaraSimCache* SimCache, |
Capture a simulation cache with customizable capture parameters. | |
| UAsyncNiagaraCaptureSimCache * | CaptureNiagaraSimCacheMultiFrame
(
UNiagaraSimCache* SimCache, |
Capture multiple frames from the provided simulation into a SimCache until the simulation becomes inactive, completes or we hit the NumFrames limit. | |
| UAsyncNiagaraCaptureSimCache * | CaptureNiagaraSimCacheUntilComplete
(
UNiagaraSimCache* SimCache, |
Capture frames from the provided simulation into a SimCache until the simulation becomes inactive or completes. |
Overridden from UCancellableAsyncAction
| Type | Name | Description | |
|---|---|---|---|
| void | Cancel () |
Cancel an asynchronous action, this attempts to cancel any lower level processes and also prevents delegates from being fired |
Overridden from UBlueprintAsyncActionBase
| Type | Name | Description | |
|---|---|---|---|
| void | Activate () |
Called to trigger the action once the delegates have been bound | |
| void | Call when the action is completely done, this makes the action free to delete, and will unregister it with the game instance |
Classes
| Type | Name | Description | |
|---|---|---|---|
| FOnCaptureComplete |