unreal.NiagaraSimCacheCaptureParameters

class unreal.NiagaraSimCacheCaptureParameters(append_to_sim_cache: bool = False, capture_fixed_number_of_frames: bool = False, num_frames: int = 0, capture_rate: int = 0, use_timeout: bool = False, timeout_frame_count: int = 0, capture_all_frames_immediatly: bool = False, immediate_capture_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)

• append_to_sim_cache (bool): [Read-Write] When enabled we will append to the existing simulation cache rather than destroying the existing contents.

• capture_all_frames_immediatly (bool): [Read-Write] When enabled we will capture all the requested frames immediatly. This will capture the simulation outside of the main work tick, i.e. if you request a 10 frame capture we will loop capturing 10 frames on the capture call rather than over 10 world ticks.

• capture_fixed_number_of_frames (bool): [Read-Write] When enabled we capture NumFrames number of frames, otherwise the capture will continue until cancelled or the simulation is complete.

• 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.

• immediate_capture_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).

• 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.

• timeout_frame_count (int32): [Read-Write] When we fail to capture a new frame after this many frames the capture will complete automatically.

• use_timeout (bool): [Read-Write] When enabled the capture will time out if we reach the defined number of frames without anything new to capture.

property append_to_sim_cache: bool

[Read-Write] When enabled we will append to the existing simulation cache rather than destroying the existing contents.

Type:

(bool)

property capture_all_frames_immediatly: bool

[Read-Write] When enabled we will capture all the requested frames immediatly. This will capture the simulation outside of the main work tick, i.e. if you request a 10 frame capture we will loop capturing 10 frames on the capture call rather than over 10 world ticks.

Type:

(bool)

property capture_fixed_number_of_frames: bool

[Read-Write] When enabled we capture NumFrames number of frames, otherwise the capture will continue until cancelled or the simulation is complete.

Type:

(bool)

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 immediate_capture_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 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)

property timeout_frame_count: int

[Read-Write] When we fail to capture a new frame after this many frames the capture will complete automatically.

Type:

(int32)

property use_timeout: bool

[Read-Write] When enabled the capture will time out if we reach the defined number of frames without anything new to capture.

Type:

(bool)