unreal.NiagaraSimCacheCaptureParameters

class unreal.NiagaraSimCacheCaptureParameters(num_frames: int = 0, capture_rate: int = 0, manually_advance_simulation: bool = False, advance_delta_time: float = 0.0)

Bases: StructBase

Niagara Sim Cache Capture Parameters

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraSimCacheCapture.h

Editor Properties: (see get_editor_property/set_editor_property)

  • advance_delta_time (float): [Read-Write] The delta time in seconds to use when manually advancing the simulation. Defaults to 1/60th of a second (0.01666).

  • capture_rate (int32): [Read-Write] Allows for reducing the frequency of captured frames in relation to the simulation’s frames. The ratio is 1 / CaptureRate, so a CaptureRate of 2 would captures frames 0, 2, 4, etc.

  • manually_advance_simulation (bool): [Read-Write] Controls manually advancing the simulation in a loop vs reading from it every frame. If bAdvanceSimulation is true, this capture will manually advance the simulation

  • num_frames (int32): [Read-Write] The max number of frames to capture. The capture will stop when the simulation completes or we have rendered this many frames, whichever happens first. Set to 0 to capture until simulation completes.

property advance_delta_time: float

[Read-Write] The delta time in seconds to use when manually advancing the simulation. Defaults to 1/60th of a second (0.01666).

Type:

(float)

property capture_rate: int

[Read-Write] Allows for reducing the frequency of captured frames in relation to the simulation’s frames. The ratio is 1 / CaptureRate, so a CaptureRate of 2 would captures frames 0, 2, 4, etc.

Type:

(int32)

property manually_advance_simulation: bool

[Read-Write] Controls manually advancing the simulation in a loop vs reading from it every frame. If bAdvanceSimulation is true, this capture will manually advance the simulation

Type:

(bool)

property num_frames: int

[Read-Write] The max number of frames to capture. The capture will stop when the simulation completes or we have rendered this many frames, whichever happens first. Set to 0 to capture until simulation completes.

Type:

(int32)