unreal.NiagaraSimCacheCreateParameters

class unreal.NiagaraSimCacheCreateParameters(attribute_capture_mode: NiagaraSimCacheAttributeCaptureMode = Ellipsis, allow_rebasing: bool = False, allow_data_interface_caching: bool = False, rebase_include_attributes: Array[Name] = [], rebase_exclude_attributes: Array[Name] = [], explicit_capture_attributes: Array[Name] = [])

Bases: StructBase

Niagara Sim Cache Create Parameters

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraSimCache.h

Editor Properties: (see get_editor_property/set_editor_property)

  • allow_data_interface_caching (bool): [Read-Write] Allow Data Interface Caching: When enabled Data Interface data will be stored in the SimCache. This can result in a large increase to the cache size, depending on what Data Interfaces are used

  • allow_rebasing (bool): [Read-Write] Allow Rebasing: When enabled allows the SimCache to be re-based. i.e. World space emitters can be moved to the new component’s location

  • attribute_capture_mode (NiagaraSimCacheAttributeCaptureMode): [Read-Write] Attribute Capture Mode: How do we want to capture attributes for the simulation cache. The mode selected depends on what situations the cache can be used in.

  • explicit_capture_attributes (Array[Name]): [Read-Write] Explicit Capture Attributes: List of attributes to capture when the capture attribute capture mode is set to explicit. For example, adding MyEmitter.Particles.Position will only gather that attribute inside the cache.

  • rebase_exclude_attributes (Array[Name]): [Read-Write] Rebase Exclude Attributes: List of Attributes to force exclude from the SimCache rebase, they should be the full path to the attribute For example, MyEmitter.Particles.MyQuat would force the particle attribute MyQuat to be included for MyEmitter

  • rebase_include_attributes (Array[Name]): [Read-Write] Rebase Include Attributes: List of Attributes to force include in the SimCache rebase, they should be the full path to the attribute For example, MyEmitter.Particles.MyQuat would force the particle attribute MyQuat to be included for MyEmitter

property allow_data_interface_caching: bool

[Read-Write] Allow Data Interface Caching: When enabled Data Interface data will be stored in the SimCache. This can result in a large increase to the cache size, depending on what Data Interfaces are used

Type:

(bool)

property allow_rebasing: bool

[Read-Write] Allow Rebasing: When enabled allows the SimCache to be re-based. i.e. World space emitters can be moved to the new component’s location

Type:

(bool)

property attribute_capture_mode: NiagaraSimCacheAttributeCaptureMode

[Read-Write] Attribute Capture Mode: How do we want to capture attributes for the simulation cache. The mode selected depends on what situations the cache can be used in.

Type:

(NiagaraSimCacheAttributeCaptureMode)

property explicit_capture_attributes: Array[Name]

[Read-Write] Explicit Capture Attributes: List of attributes to capture when the capture attribute capture mode is set to explicit. For example, adding MyEmitter.Particles.Position will only gather that attribute inside the cache.

Type:

(Array[Name])

property rebase_exclude_attributes: Array[Name]

[Read-Write] Rebase Exclude Attributes: List of Attributes to force exclude from the SimCache rebase, they should be the full path to the attribute For example, MyEmitter.Particles.MyQuat would force the particle attribute MyQuat to be included for MyEmitter

Type:

(Array[Name])

property rebase_include_attributes: Array[Name]

[Read-Write] Rebase Include Attributes: List of Attributes to force include in the SimCache rebase, they should be the full path to the attribute For example, MyEmitter.Particles.MyQuat would force the particle attribute MyQuat to be included for MyEmitter

Type:

(Array[Name])