unreal.MovieSceneNiagaraCacheParams

class unreal.MovieSceneNiagaraCacheParams

Bases: MovieSceneBaseCacheParams

Movie Scene Niagara Cache Params

C++ Source:

  • Plugin: NiagaraSimCaching

  • Module: NiagaraSimCaching

  • File: MovieSceneNiagaraCacheSection.h

Editor Properties: (see get_editor_property/set_editor_property)

  • cache_parameters (NiagaraSimCacheCreateParameters): [Read-Write]

  • cache_record_rate_fps (float): [Read-Write] The rate at which the cache should be recorded. Will be ignored if the sequence plays at a lower rate than this number. This option is useful if you need to play the sequence at a very high fps for simulation stability (e.g. 240fps), but then later want to play back the cache at a normal rate (e.g. 24fps). Please note that using this option might result in rendering artifacts for things like motion blur, velocity interpolation or inconsistent grid data in fluids, due to the dropped cache frames.

  • cache_replay_play_mode (NiagaraSimCacheSectionPlayMode): [Read-Write] What should the effect do when the track has no cache data to display

  • end_frame_offset (FrameNumber): [Read-Write] The offset into the end of the animation clip

  • first_loop_start_frame_offset (FrameNumber): [Read-Write] The offset for the first loop of the animation clip

  • lock_cache_to_read_only (bool): [Read-Write] If true then the section properties might still be changed (so the section itself is not locked), but the cache cannot be rerecorded to prevent accidentally overriding the data within

  • override_quality_level (bool): [Read-Write]

  • override_record_rate (bool): [Read-Write] True if the cache should be recorded at a rate that is slower than the sequencer play rate.

  • play_rate (float): [Read-Write] The playback rate of the animation clip

  • record_quality_level (PerQualityLevels): [Read-Write] If set, then the engine scalability setting will be overriden with this value when recording a new cache for this track

  • reverse (bool): [Read-Write] Reverse the playback of the animation clip

  • section_stretch_mode (NiagaraSimCacheSectionStretchMode): [Read-Write] What should the effect do when the cache section is stretched?

  • sim_cache (NiagaraSimCache): [Read-Write] The sim cache this section plays and records into

  • start_frame_offset (FrameNumber): [Read-Write] The offset into the beginning of the animation clip