unreal.NiagaraSimCacheCreateParameters

class unreal.NiagaraSimCacheCreateParameters(attribute_capture_mode: NiagaraSimCacheAttributeCaptureMode = Ellipsis, allow_rebasing: bool = False, allow_data_interface_caching: bool = False, allow_interpolation: bool = False, allow_velocity_extrapolation: bool = False, allow_serialize_large_cache: bool = False, rebase_include_attributes: None = [], rebase_exclude_attributes: None = [], interpolation_include_attributes: None = [], interpolation_exclude_attributes: None = [], explicit_capture_attributes: None = [])

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] 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_interpolation (bool): [Read-Write] When enabled we allow the cache to be generated for interpolation. This will increase the memory usage for the cache slightly but can allow you to reduce the capture rate. By default we will capture and interpolate all Position & Quat types, you can adjust this using the include / exclude list.

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

• allow_serialize_large_cache (bool): [Read-Write] When enabled the cache will support serializing large amounts of cache data.

• allow_velocity_extrapolation (bool): [Read-Write] When enabled we allow the cache to be generated for extrapolation. This will force the velocity attribute to be maintained.

• attribute_capture_mode (NiagaraSimCacheAttributeCaptureMode): [Read-Write] 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] 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.

• interpolation_exclude_attributes (Array[Name]): [Read-Write] List of specific Attributes to exclude interpolation for. They must be types that are supported for interpolation. For example, MyEmitter.Particles.MyPosition would force MyPosition to be interpolated.

• interpolation_include_attributes (Array[Name]): [Read-Write] List of specific Attributes to include when using interpolation. They must be types that are supported for interpolation. For example, MyEmitter.Particles.MyPosition would force MyPosition to be interpolated.

• rebase_exclude_attributes (Array[Name]): [Read-Write] 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] 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] 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_interpolation: bool

[Read-Write] When enabled we allow the cache to be generated for interpolation. This will increase the memory usage for the cache slightly but can allow you to reduce the capture rate. By default we will capture and interpolate all Position & Quat types, you can adjust this using the include / exclude list.

Type:

(bool)

property allow_rebasing: bool

[Read-Write] 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 allow_serialize_large_cache: bool

[Read-Write] When enabled the cache will support serializing large amounts of cache data.

Type:

(bool)

property allow_velocity_extrapolation: bool

[Read-Write] When enabled we allow the cache to be generated for extrapolation. This will force the velocity attribute to be maintained.

Type:

(bool)

property attribute_capture_mode: NiagaraSimCacheAttributeCaptureMode

[Read-Write] 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: None

[Read-Write] 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 interpolation_exclude_attributes: None

[Read-Write] List of specific Attributes to exclude interpolation for. They must be types that are supported for interpolation. For example, MyEmitter.Particles.MyPosition would force MyPosition to be interpolated.

Type:

(Array[Name])

property interpolation_include_attributes: None

[Read-Write] List of specific Attributes to include when using interpolation. They must be types that are supported for interpolation. For example, MyEmitter.Particles.MyPosition would force MyPosition to be interpolated.

Type:

(Array[Name])

property rebase_exclude_attributes: None

[Read-Write] 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: None

[Read-Write] 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])