1. Epic GamesDeveloper
  3. FNiagaraSimCacheCaptureParameters

FNiagaraSimCacheCaptureParameters

API > API/Plugins > API/Plugins/Niagara

   
Name FNiagaraSimCacheCaptureParameters
Type struct
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheCapture.h
Include Path #include "NiagaraSimCacheCapture.h"

Syntax

USTRUCT (BlueprintType )  
struct FNiagaraSimCacheCaptureParameters

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraSimCacheCaptureParameters()

   NiagaraSimCacheCapture.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAppendToSimCache uint32 When enabled we will append to the existing simulation cache rather than destroying the existing contents. NiagaraSimCacheCapture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="SimCache"
bCaptureAllFramesImmediatly uint32 When enabled we will capture all the requested frames immediatly. NiagaraSimCacheCapture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="SimCache"
bCaptureFixedNumberOfFrames uint32 When enabled we capture NumFrames number of frames, otherwise the capture will continue until cancelled or the simulation is complete. NiagaraSimCacheCapture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="SimCache"
bUseTimeout uint32 When enabled the capture will time out if we reach the defined number of frames without anything new to capture. NiagaraSimCacheCapture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="SimCache"
CaptureRate int32 Allows for reducing the frequency of captured frames in relation to the simulation's frames. NiagaraSimCacheCapture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="SimCache"
  • Meta=(ClampMin="1")
ImmediateCaptureDeltaTime float The delta time in seconds to use when manually advancing the simulation.Defaults to 1 / 60th of a second(0.01666). NiagaraSimCacheCapture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="SimCache"
  • Meta=(ClampMin="0.0001")
NumFrames int32 The max number of frames to capture. NiagaraSimCacheCapture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="SimCache"
  • Meta=(ClampMin="1")
TimeoutFrameCount int32 When we fail to capture a new frame after this many frames the capture will complete automatically. NiagaraSimCacheCapture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="SimCache"
  • Meta=(ClampMin="1")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Sanitize()

   NiagaraSimCacheCapture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page