unreal.FXConverterUtilitiesLibrary

class unreal.FXConverterUtilitiesLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

A C++ and Blueprint accessible library for converting fx type assets (Cascade and Niagara)

C++ Source:

  • Plugin: CascadeToNiagaraConverter

  • Module: CascadeToNiagaraConverter

  • File: NiagaraStackGraphUtilitiesAdapterLibrary.h

classmethod create_asset_data(path) → AssetData

Create Asset Data

Parameters:

path (str)

Return type:

AssetData

classmethod create_component_renderer_properties() → NiagaraComponentRendererProperties

Create Component Renderer Properties

Return type:

NiagaraComponentRendererProperties

classmethod create_float_curve_di(keys) → NiagaraDataInterfaceCurve

Create Float Curve DI

Parameters:

keys (Array[RichCurveKeyBP])

Return type:

NiagaraDataInterfaceCurve

classmethod create_light_renderer_properties() → NiagaraLightRendererProperties

Create Light Renderer Properties

Return type:

NiagaraLightRendererProperties

classmethod create_mesh_renderer_properties() → NiagaraMeshRendererProperties

Create Mesh Renderer Properties

Return type:

NiagaraMeshRendererProperties

classmethod create_ribbon_renderer_properties() → NiagaraRibbonRendererProperties

Create Ribbon Renderer Properties

Return type:

NiagaraRibbonRendererProperties

classmethod create_script_context(args) → NiagaraScriptConversionContext

Niagara Script and Script Input Helpers

Parameters:

args (CreateScriptContextArgs)

Return type:

NiagaraScriptConversionContext

classmethod create_script_input_bool(value) → NiagaraScriptConversionContextInput

Create Script Input Bool

Parameters:

value (bool)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_di(value) → NiagaraScriptConversionContextInput

Create Script Input DI

Parameters:

value (NiagaraDataInterface)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_dynamic(value, input_type) → NiagaraScriptConversionContextInput

Create Script Input Dynamic

Parameters:
Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_enum(user_defined_enum_asset_path, user_defined_enum_value_name_string) → NiagaraScriptConversionContextInput

Create Script Input Enum

Parameters:

  • user_defined_enum_asset_path (str)

  • user_defined_enum_value_name_string (str)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_float(value) → NiagaraScriptConversionContextInput

Create Script Input Float

Parameters:

value (float)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_int(value) → NiagaraScriptConversionContextInput

Create Script Input Int

Parameters:

value (int32)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_linear_color(value) → NiagaraScriptConversionContextInput

Create Script Input Linear Color

Parameters:

value (LinearColor)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_linked_enum(parameter_name_string, user_defined_enum_asset_path) → NiagaraScriptConversionContextInput

Create Script Input Linked Enum

Parameters:

  • parameter_name_string (str)

  • user_defined_enum_asset_path (str)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_linked_parameter(parameter_name_string, input_type) → NiagaraScriptConversionContextInput

Create Script Input Linked Parameter

Parameters:
Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_linked_parameter_ex(parameter_name_string, base_input) → NiagaraScriptConversionContextInput

Create Script Input Linked Parameter Ex

Parameters:
Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_matrix(value) → NiagaraScriptConversionContextInput

Create Script Input Matrix

Parameters:

value (Matrix44f)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_quat(value) → NiagaraScriptConversionContextInput

Create Script Input Quat

Parameters:

value (Quat4f)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_struct(value) → NiagaraScriptConversionContextInput

Create Script Input Struct

Parameters:

value (UserDefinedStruct)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_vec2(value) → NiagaraScriptConversionContextInput

Create Script Input Vec 2

Parameters:

value (Vector2D)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_vec4(value) → NiagaraScriptConversionContextInput

Create Script Input Vec 4

Parameters:

value (Vector4f)

Return type:

NiagaraScriptConversionContextInput

classmethod create_script_input_vector(value) → NiagaraScriptConversionContextInput

Create Script Input Vector

Parameters:

value (Vector)

Return type:

NiagaraScriptConversionContextInput

classmethod create_skeletal_mesh_data_interface() → NiagaraDataInterfaceSkeletalMesh

Niagara DI Helpers

Return type:

NiagaraDataInterfaceSkeletalMesh

classmethod create_system_conversion_context(system) → NiagaraSystemConversionContext

Niagara System and Emitter Helpers

Parameters:

system (NiagaraSystem)

Return type:

NiagaraSystemConversionContext

classmethod create_vec2_curve_di(x_keys, y_keys) → NiagaraDataInterfaceVector2DCurve

Create Vec 2Curve DI

Parameters:
Return type:

NiagaraDataInterfaceVector2DCurve

classmethod create_vec3_curve_di(x_keys, y_keys, z_keys) → NiagaraDataInterfaceVectorCurve

Create Vec 3Curve DI

Parameters:
Return type:

NiagaraDataInterfaceVectorCurve

classmethod create_vec4_curve_di(x_keys, y_keys, z_keys, w_keys) → NiagaraDataInterfaceVector4Curve

Create Vec 4Curve DI

Parameters:
Return type:

NiagaraDataInterfaceVector4Curve

classmethod get_cascade_emitter_lod_level(emitter, idx) → ParticleLODLevel

Get Cascade Emitter Lod Level

Parameters:
Return type:

ParticleLODLevel

classmethod get_cascade_emitter_name(emitter) → Name

Get Cascade Emitter Name

Parameters:

emitter (ParticleEmitter)

Return type:

Name

classmethod get_cascade_emitter_render_mode(emitter) → int32

Get Cascade Emitter Render Mode

Parameters:

emitter (ParticleEmitter)

Return type:

int32

classmethod get_cascade_system_emitters(system) → Array[ParticleEmitter]

Cascade Emitter and ParticleLodLevel Getters

Parameters:

system (ParticleSystem)

Return type:

Array[ParticleEmitter]

classmethod get_distribution_locked_axes(distribution) → Array[DistributionVectorLockFlags]

Get Distribution Locked Axes

Parameters:

distribution (Distribution)

Return type:

Array[DistributionVectorLockFlags]

classmethod get_distribution_min_max_values(distribution) -> (out_success=bool, out_min_value=Vector, out_max_value=Vector)

Cascade Distribution Getters

Parameters:

distribution (Distribution)

Returns:

out_success (bool):

out_min_value (Vector):

out_max_value (Vector):

Return type:

tuple

classmethod get_distribution_type(distribution) -> (out_distribution_type=DistributionType, out_cascade_distribution_value_type=DistributionValueType)

Get Distribution Type

Parameters:

distribution (Distribution)

Returns:

out_distribution_type (DistributionType):

out_cascade_distribution_value_type (DistributionValueType):

Return type:

tuple

classmethod get_float_distribution_const_curve_values(distribution) → InterpCurveFloat

Get Float Distribution Const Curve Values

Parameters:

distribution (DistributionFloatConstantCurve)

Returns:

out_interp_curve_float (InterpCurveFloat):

Return type:

InterpCurveFloat

classmethod get_float_distribution_const_values(distribution) → float

Get Float Distribution Const Values

Parameters:

distribution (DistributionFloatConstant)

Returns:

out_const_float (float):

Return type:

float

classmethod get_float_distribution_parameter_values(distribution) -> (out_parameter_name=Name, out_min_input=float, out_max_input=float, out_min_output=float, out_max_output=float)

Get Float Distribution Parameter Values

Parameters:

distribution (DistributionFloatParameterBase)

Returns:

out_parameter_name (Name):

out_min_input (float):

out_max_input (float):

out_min_output (float):

out_max_output (float):

Return type:

tuple

classmethod get_float_distribution_uniform_curve_values(distribution) → InterpCurveVector2D

Get Float Distribution Uniform Curve Values

Parameters:

distribution (DistributionFloatUniformCurve)

Returns:

out_interp_curve_vector2d (InterpCurveVector2D):

Return type:

InterpCurveVector2D

classmethod get_float_distribution_uniform_values(distribution) -> (out_min=float, out_max=float)

Get Float Distribution Uniform Values

Parameters:

distribution (DistributionFloatUniform)

Returns:

out_min (float):

out_max (float):

Return type:

tuple

classmethod get_lod_level_is_enabled(lod_level) → bool

Get Lod Level Is Enabled

Parameters:

lod_level (ParticleLODLevel)

Return type:

bool

classmethod get_lod_level_modules(lod_level) → Array[ParticleModule]

Get Lod Level Modules

Parameters:

lod_level (ParticleLODLevel)

Return type:

Array[ParticleModule]

classmethod get_lod_level_required_module(lod_level) → ParticleModuleRequired

Get Lod Level Required Module

Parameters:

lod_level (ParticleLODLevel)

Return type:

ParticleModuleRequired

classmethod get_lod_level_spawn_module(lod_level) → ParticleModuleSpawn

Get Lod Level Spawn Module

Parameters:

lod_level (ParticleLODLevel)

Return type:

ParticleModuleSpawn

classmethod get_lod_level_type_data_module(lod_level) → ParticleModuleTypeDataBase

Get Lod Level Type Data Module

Parameters:

lod_level (ParticleLODLevel)

Return type:

ParticleModuleTypeDataBase

classmethod get_long_package_path(long_package_name) → str

Generic Utilities

Parameters:

long_package_name (str)

Return type:

str

classmethod get_particle_module_acceleration_drag_props(particle_module) → Distribution

Get Particle Module Acceleration Drag Props

Parameters:

particle_module (ParticleModuleAccelerationDrag)

Returns:

out_drag_coefficient_raw (Distribution):

Return type:

Distribution

classmethod get_particle_module_acceleration_drag_scale_over_life_props(particle_module) → Distribution

Get Particle Module Acceleration Drag Scale Over Life Props

Parameters:

particle_module (ParticleModuleAccelerationDragScaleOverLife)

Returns:

out_drag_scale_raw (Distribution):

Return type:

Distribution

classmethod get_particle_module_acceleration_over_lifetime_props(particle_module) → Distribution

Get Particle Module Acceleration Over Lifetime Props

Parameters:

particle_module (ParticleModuleAccelerationOverLifetime)

Returns:

out_accel_over_life (Distribution):

Return type:

Distribution

classmethod get_particle_module_acceleration_props(particle_module) -> (out_acceleration=Distribution, out_apply_owner_scale=bool)

Get Particle Module Acceleration Props

Parameters:

particle_module (ParticleModuleAcceleration)

Returns:

out_acceleration (Distribution):

out_apply_owner_scale (bool):

Return type:

tuple

classmethod get_particle_module_attractor_line_props(particle_module) -> (out_start_point=Vector, out_end_point=Vector, out_range=Distribution, out_strength=Distribution)

Get Particle Module Attractor Line Props

Parameters:

particle_module (ParticleModuleAttractorLine)

Returns:

out_start_point (Vector):

out_end_point (Vector):

out_range (Distribution):

out_strength (Distribution):

Return type:

tuple

classmethod get_particle_module_attractor_particle_props(particle_module) -> (out_emitter_name=Name, out_range=Distribution, out_strength_by_distance=bool, out_strength=Distribution, out_affect_base_velocity=bool, out_selection_method=AttractorParticleSelectionMethod, out_renew_source=bool, out_inherit_source_velocity=bool)

Get Particle Module Attractor Particle Props

Parameters:

particle_module (ParticleModuleAttractorParticle)

Returns:

out_emitter_name (Name):

out_range (Distribution):

out_strength_by_distance (bool):

out_strength (Distribution):

out_affect_base_velocity (bool):

out_selection_method (AttractorParticleSelectionMethod):

out_renew_source (bool):

out_inherit_source_velocity (bool):

Return type:

tuple

classmethod get_particle_module_attractor_point_props(particle_module) -> (out_position=Distribution, out_range=Distribution, out_strength=Distribution, bout_strength_by_distance=bool, out_affects_base_velocity=bool, out_override_velocity=bool, out_use_world_space_position=bool, out_positive_x=bool, out_positive_y=bool, out_positive_z=bool, out_negative_x=bool, out_negative_y=bool, out_negative_z=bool)

Get Particle Module Attractor Point Props

Parameters:

particle_module (ParticleModuleAttractorPoint)

Returns:

out_position (Distribution):

out_range (Distribution):

out_strength (Distribution):

bout_strength_by_distance (bool):

out_affects_base_velocity (bool):

out_override_velocity (bool):

out_use_world_space_position (bool):

out_positive_x (bool):

out_positive_y (bool):

out_positive_z (bool):

out_negative_x (bool):

out_negative_y (bool):

out_negative_z (bool):

Return type:

tuple

classmethod get_particle_module_beam_noise_props(particle_module) → None

Get Particle Module Beam Noise Props

Parameters:

particle_module (ParticleModuleBeamNoise)

classmethod get_particle_module_beam_source_props(particle_module) -> (out_source=Distribution, out_source_absolute=bool)

Get Particle Module Beam Source Props

Parameters:

particle_module (ParticleModuleBeamSource)

Returns:

out_source (Distribution):

out_source_absolute (bool):

Return type:

tuple

classmethod get_particle_module_beam_target_props(particle_module) -> (out_target=Distribution, out_target_absolute=bool)

Get Particle Module Beam Target Props

Parameters:

particle_module (ParticleModuleBeamTarget)

Returns:

out_target (Distribution):

out_target_absolute (bool):

Return type:

tuple

classmethod get_particle_module_camera_offset_props(particle_module) -> (out_camera_offset=Distribution, out_spawn_time_only=bool, out_update_method=ParticleCameraOffsetUpdateMethod)

Get Particle Module Camera Offset Props

Parameters:

particle_module (ParticleModuleCameraOffset)

Returns:

out_camera_offset (Distribution):

out_spawn_time_only (bool):

out_update_method (ParticleCameraOffsetUpdateMethod):

Return type:

tuple

classmethod get_particle_module_collision_props(particle_module) -> (out_damping_factor=Distribution, out_damping_factor_rotation=Distribution, out_max_collisions=Distribution, out_collision_complete_option=ParticleCollisionComplete, out_collision_types=Array[ObjectTypeQuery], out_apply_physics=bool, out_ignore_trigger_volumes=bool, out_particle_mass=Distribution, out_dir_scalar=float, out_pawns_do_not_decrement_count=bool, out_only_vertical_normals_decrement_count=bool, out_vertical_fudge_factor=float, out_delay_amount=Distribution, out_drop_detail=bool, out_collide_only_if_visible=bool, out_ignore_source_actor=bool, out_max_collision_distance=float)

Get Particle Module Collision Props

Parameters:

particle_module (ParticleModuleCollision)

Returns:

out_damping_factor (Distribution):

out_damping_factor_rotation (Distribution):

out_max_collisions (Distribution):

out_collision_complete_option (ParticleCollisionComplete):

out_collision_types (Array[ObjectTypeQuery]):

out_apply_physics (bool):

out_ignore_trigger_volumes (bool):

out_particle_mass (Distribution):

out_dir_scalar (float):

out_pawns_do_not_decrement_count (bool):

out_only_vertical_normals_decrement_count (bool):

out_vertical_fudge_factor (float):

out_delay_amount (Distribution):

out_drop_detail (bool):

out_collide_only_if_visible (bool):

out_ignore_source_actor (bool):

out_max_collision_distance (float):

Return type:

tuple

classmethod get_particle_module_color_over_life_props(particle_module) -> (out_color_over_life=Distribution, out_alpha_over_life=Distribution, out_clamp_alpha=bool)

Get Particle Module Color Over Life Props

Parameters:

particle_module (ParticleModuleColorOverLife)

Returns:

out_color_over_life (Distribution):

out_alpha_over_life (Distribution):

out_clamp_alpha (bool):

Return type:

tuple

classmethod get_particle_module_color_props(particle_module) -> (out_start_color=Distribution, out_start_alpha=Distribution, out_clamp_alpha=bool)

Get Particle Module Color Props

Parameters:

particle_module (ParticleModuleColor)

Returns:

out_start_color (Distribution):

out_start_alpha (Distribution):

out_clamp_alpha (bool):

Return type:

tuple

classmethod get_particle_module_color_scale_over_life_props(particle_module) -> (out_color_scale_over_life=Distribution, out_alpha_scale_over_life=Distribution, out_emitter_time=bool)

Get Particle Module Color Scale Over Life Props

Parameters:

particle_module (ParticleModuleColorScaleOverLife)

Returns:

out_color_scale_over_life (Distribution):

out_alpha_scale_over_life (Distribution):

out_emitter_time (bool):

Return type:

tuple

classmethod get_particle_module_constant_acceleration_props(particle_module) → Vector

Get Particle Module Constant Acceleration Props

Parameters:

particle_module (ParticleModuleAccelerationConstant)

Returns:

out_const_acceleration (Vector):

Return type:

Vector

classmethod get_particle_module_is_enabled(module) → bool

Get Particle Module Is Enabled

Parameters:

module (ParticleModule)

Return type:

bool

classmethod get_particle_module_kill_box_props(particle_module) -> (out_lower_left_corner=Distribution, out_upper_right_corner=Distribution, out_world_space_coords=bool, out_kill_inside=bool, out_axis_aligned_and_fixed_size=bool)

Get Particle Module Kill Box Props

Parameters:

particle_module (ParticleModuleKillBox)

Returns:

out_lower_left_corner (Distribution):

out_upper_right_corner (Distribution):

out_world_space_coords (bool):

out_kill_inside (bool):

out_axis_aligned_and_fixed_size (bool):

Return type:

tuple

classmethod get_particle_module_lifetime_props(particle_module) → Distribution

Get Particle Module Lifetime Props

Parameters:

particle_module (ParticleModuleLifetime)

Returns:

out_lifetime (Distribution):

Return type:

Distribution

classmethod get_particle_module_light_props(particle_module) -> (out_use_inverse_squared_falloff=bool, out_affects_translucency=bool, out_preview_light_radius=bool, out_spawn_fraction=float, out_color_scale_over_life=Distribution, out_brightness_over_life=Distribution, out_radius_scale=Distribution, out_light_exponent=Distribution, out_lighting_channels=LightingChannels, out_volumetric_scattering_intensity=float, out_high_quality_lights=bool, out_shadow_casting_lights=bool)

Get Particle Module Light Props

Parameters:

particle_module (ParticleModuleLight)

Returns:

out_use_inverse_squared_falloff (bool):

out_affects_translucency (bool):

out_preview_light_radius (bool):

out_spawn_fraction (float):

out_color_scale_over_life (Distribution):

out_brightness_over_life (Distribution):

out_radius_scale (Distribution):

out_light_exponent (Distribution):

out_lighting_channels (LightingChannels):

out_volumetric_scattering_intensity (float):

out_high_quality_lights (bool):

out_shadow_casting_lights (bool):

Return type:

tuple

classmethod get_particle_module_location_bone_socket_props(particle_module) -> (out_source_type=LocationBoneSocketSource, out_universal_offset=Vector, out_source_locations=Array[LocationBoneSocketInfoBP], out_selection_method=LocationBoneSocketSelectionMethod, out_update_position_each_frame=bool, out_orient_mesh_emitters=bool, out_inherit_bone_velocity=bool, out_inherit_velocity_scale=float, out_skel_mesh_actor_param_name=Name, out_num_pre_selected_indices=int32, out_editor_skel_mesh=SkeletalMesh)

Get Particle Module Location Bone Socket Props

Parameters:

particle_module (ParticleModuleLocationBoneSocket)

Returns:

out_source_type (LocationBoneSocketSource):

out_universal_offset (Vector):

out_source_locations (Array[LocationBoneSocketInfoBP]):

out_selection_method (LocationBoneSocketSelectionMethod):

out_update_position_each_frame (bool):

out_orient_mesh_emitters (bool):

out_inherit_bone_velocity (bool):

out_inherit_velocity_scale (float):

out_skel_mesh_actor_param_name (Name):

out_num_pre_selected_indices (int32):

out_editor_skel_mesh (SkeletalMesh):

Return type:

tuple

classmethod get_particle_module_location_direct_props(particle_module) -> (out_location=Distribution, out_location_offset=Distribution, out_scale_factor=Distribution)

Get Particle Module Location Direct Props

Parameters:

particle_module (ParticleModuleLocationDirect)

Returns:

out_location (Distribution):

out_location_offset (Distribution):

out_scale_factor (Distribution):

Return type:

tuple

classmethod get_particle_module_location_primitive_cylinder_props(particle_module) -> (out_radial_velocity=bool, out_start_radius=Distribution, out_start_height=Distribution, out_height_axis=CylinderHeightAxis, out_positive_x=bool, out_positive_y=bool, out_positive_z=bool, out_negative_x=bool, out_negative_y=bool, out_negative_z=bool, out_surface_only=bool, out_velocity=bool, out_velocity_scale=Distribution, out_start_location=Distribution)

Get Particle Module Location Primitive Cylinder Props

Parameters:

particle_module (ParticleModuleLocationPrimitiveCylinder)

Returns:

out_radial_velocity (bool):

out_start_radius (Distribution):

out_start_height (Distribution):

out_height_axis (CylinderHeightAxis):

out_positive_x (bool):

out_positive_y (bool):

out_positive_z (bool):

out_negative_x (bool):

out_negative_y (bool):

out_negative_z (bool):

out_surface_only (bool):

out_velocity (bool):

out_velocity_scale (Distribution):

out_start_location (Distribution):

Return type:

tuple

classmethod get_particle_module_location_primitive_sphere_props(particle_module) -> (out_start_radius=Distribution, out_positive_x=bool, out_positive_y=bool, out_positive_z=bool, out_negative_x=bool, out_negative_y=bool, out_negative_z=bool, out_surface_only=bool, out_velocity=bool, out_velocity_scale=Distribution, out_start_location=Distribution)

Get Particle Module Location Primitive Sphere Props

Parameters:

particle_module (ParticleModuleLocationPrimitiveSphere)

Returns:

out_start_radius (Distribution):

out_positive_x (bool):

out_positive_y (bool):

out_positive_z (bool):

out_negative_x (bool):

out_negative_y (bool):

out_negative_z (bool):

out_surface_only (bool):

out_velocity (bool):

out_velocity_scale (Distribution):

out_start_location (Distribution):

Return type:

tuple

classmethod get_particle_module_location_props(particle_module) -> (out_start_location=Distribution, out_distribute_over_n_points=float, out_distribute_threshold=float)

Get Particle Module Location Props

Parameters:

particle_module (ParticleModuleLocation)

Returns:

out_start_location (Distribution):

out_distribute_over_n_points (float):

out_distribute_threshold (float):

Return type:

tuple

classmethod get_particle_module_location_skel_vert_surface_props(particle_module) -> (out_source_type=LocationSkelVertSurfaceSource, out_universal_offset=Vector, out_update_position_each_frame=bool, out_orient_mesh_emitters=bool, out_inherit_bone_velocity=bool, out_inherit_velocity_scale=float, out_skel_mesh_actor_param_name=Name, out_editor_skel_mesh=SkeletalMesh, out_valid_associated_bones=Array[Name], out_enforce_normal_check=bool, out_normal_to_compare=Vector, out_normal_check_tolerance_degrees=float, out_normal_check_tolerance=float, out_valid_material_indices=Array[int32], out_inherit_vertex_color=bool, out_inherit_uv=bool, out_inherit_uv_channel=int32)

Get Particle Module Location Skel Vert Surface Props

Parameters:

particle_module (ParticleModuleLocationSkelVertSurface)

Returns:

out_source_type (LocationSkelVertSurfaceSource):

out_universal_offset (Vector):

out_update_position_each_frame (bool):

out_orient_mesh_emitters (bool):

out_inherit_bone_velocity (bool):

out_inherit_velocity_scale (float):

out_skel_mesh_actor_param_name (Name):

out_editor_skel_mesh (SkeletalMesh):

out_valid_associated_bones (Array[Name]):

out_enforce_normal_check (bool):

out_normal_to_compare (Vector):

out_normal_check_tolerance_degrees (float):

out_normal_check_tolerance (float):

out_valid_material_indices (Array[int32]):

out_inherit_vertex_color (bool):

out_inherit_uv (bool):

out_inherit_uv_channel (int32):

Return type:

tuple

classmethod get_particle_module_location_world_offset_props(particle_module) -> (out_start_location=Distribution, out_distribute_over_n_points=float, out_distribute_threshold=float)

Get Particle Module Location World Offset Props

Parameters:

particle_module (ParticleModuleLocationWorldOffset)

Returns:

out_start_location (Distribution):

out_distribute_over_n_points (float):

out_distribute_threshold (float):

Return type:

tuple

classmethod get_particle_module_mesh_material_props(particle_module) → Array[MaterialInterface]

Get Particle Module Mesh Material Props

Parameters:

particle_module (ParticleModuleMeshMaterial)

Returns:

out_mesh_materials (Array[MaterialInterface]):

Return type:

Array[MaterialInterface]

classmethod get_particle_module_mesh_rotation_props(particle_module) -> (out_start_rotation=Distribution, out_inherit_parent_rotation=bool)

Get Particle Module Mesh Rotation Props

Parameters:

particle_module (ParticleModuleMeshRotation)

Returns:

out_start_rotation (Distribution):

out_inherit_parent_rotation (bool):

Return type:

tuple

classmethod get_particle_module_mesh_rotation_rate_multiply_life_props(particle_module) → Distribution

Get Particle Module Mesh Rotation Rate Multiply Life Props

Parameters:

particle_module (ParticleModuleMeshRotationRateMultiplyLife)

Returns:

out_life_multiplier (Distribution):

Return type:

Distribution

classmethod get_particle_module_mesh_rotation_rate_over_life_props(particle_module) -> (out_rot_rate=Distribution, out_scale_rot_rate=bool)

Get Particle Module Mesh Rotation Rate Over Life Props

Parameters:

particle_module (ParticleModuleMeshRotationRateOverLife)

Returns:

out_rot_rate (Distribution):

out_scale_rot_rate (bool):

Return type:

tuple

classmethod get_particle_module_mesh_rotation_rate_props(particle_module) → Distribution

Get Particle Module Mesh Rotation Rate Props

Parameters:

particle_module (ParticleModuleMeshRotationRate)

Returns:

out_start_rotation_rate (Distribution):

Return type:

Distribution

classmethod get_particle_module_orbit_props(particle_module) -> (out_chain_mode=OrbitChainMode, out_offset_amount=Distribution, out_offset_options=OrbitOptionsBP, out_rotation_amount=Distribution, out_rotation_options=OrbitOptionsBP, out_rotation_rate_amount=Distribution, out_rotation_rate_options=OrbitOptionsBP)

Get Particle Module Orbit Props

Parameters:

particle_module (ParticleModuleOrbit)

Returns:

out_chain_mode (OrbitChainMode):

out_offset_amount (Distribution):

out_offset_options (OrbitOptionsBP):

out_rotation_amount (Distribution):

out_rotation_options (OrbitOptionsBP):

out_rotation_rate_amount (Distribution):

out_rotation_rate_options (OrbitOptionsBP):

Return type:

tuple

classmethod get_particle_module_orientation_axis_lock_props(particle_module) → ParticleAxisLock

Get Particle Module Orientation Axis Lock Props

Parameters:

particle_module (ParticleModuleOrientationAxisLock)

Returns:

out_lock_axis_flags (ParticleAxisLock):

Return type:

ParticleAxisLock

classmethod get_particle_module_parameter_dynamic_props(particle_module) -> (out_dynamic_params=Array[EmitterDynamicParameterBP], out_uses_velocity=bool)

Get Particle Module Parameter Dynamic Props

Parameters:

particle_module (ParticleModuleParameterDynamic)

Returns:

out_dynamic_params (Array[EmitterDynamicParameterBP]):

out_uses_velocity (bool):

Return type:

tuple

classmethod get_particle_module_pivot_offset_props(particle_module) → Vector2D

Get Particle Module Pivot Offset Props

Parameters:

particle_module (ParticleModulePivotOffset)

Returns:

out_pivot_offset (Vector2D):

Return type:

Vector2D

classmethod get_particle_module_required_per_emitter_props(particle_module_required) -> (out_emitter_origin=Vector, out_emitter_rotation=Rotator, out_use_local_space=bool, out_kill_on_deactivate=bool, out_kill_on_completed=bool, out_use_legacy_emitter_time=bool, out_emitter_duration_use_range=bool, out_emitter_duration=float, out_emitter_duration_low=float, o_ut_emitter_delay_use_range=bool, out_delay_first_loop_only=bool, out_emitter_delay=float, out_emitter_delay_low=float, out_duration_recalc_each_loop=bool, out_emitter_loops=int32)

Get Particle Module Required Per Emitter Props

Parameters:

particle_module_required (ParticleModuleRequired)

Returns:

out_emitter_origin (Vector):

out_emitter_rotation (Rotator):

out_use_local_space (bool):

out_kill_on_deactivate (bool):

out_kill_on_completed (bool):

out_use_legacy_emitter_time (bool):

out_emitter_duration_use_range (bool):

out_emitter_duration (float):

out_emitter_duration_low (float):

o_ut_emitter_delay_use_range (bool):

out_delay_first_loop_only (bool):

out_emitter_delay (float):

out_emitter_delay_low (float):

out_duration_recalc_each_loop (bool):

out_emitter_loops (int32):

Return type:

tuple

classmethod get_particle_module_required_per_module_props(particle_module_required) -> (out_orbit_module_affects_velocity_alignment=bool, out_random_image_time=float, out_random_image_changes=int32, out_override_system_macro_uv=bool, out_macro_uv_position=Vector, out_macro_uv_radius=float)

Get Particle Module Required Per Module Props

Parameters:

particle_module_required (ParticleModuleRequired)

Returns:

out_orbit_module_affects_velocity_alignment (bool):

out_random_image_time (float):

out_random_image_changes (int32):

out_override_system_macro_uv (bool):

out_macro_uv_position (Vector):

out_macro_uv_radius (float):

Return type:

tuple

classmethod get_particle_module_required_per_renderer_props(particle_module_required) -> (out_material_interface=MaterialInterface, out_screen_alignment=ParticleScreenAlignment, out_sub_images_horizontal=int32, out_sub_images_vertical=int32, out_sort_mode=ParticleSortMode, out_interpolation_method=ParticleSubUVInterpMethod, out_remove_hmd_roll=uint8, out_min_facing_camera_blend_distance=float, out_max_facing_camera_blend_distance=float, out_cutout_texture=Texture2D, out_bounding_mode=SubUVBoundingVertexCount, out_opacity_source_mode=OpacitySourceMode, out_emitter_normals_mode=EmitterNormalsMode, out_alpha_threshold=float)

Get Particle Module Required Per Renderer Props

Parameters:

particle_module_required (ParticleModuleRequired)

Returns:

out_material_interface (MaterialInterface):

out_screen_alignment (ParticleScreenAlignment):

out_sub_images_horizontal (int32):

out_sub_images_vertical (int32):

out_sort_mode (ParticleSortMode):

out_interpolation_method (ParticleSubUVInterpMethod):

out_remove_hmd_roll (uint8):

out_min_facing_camera_blend_distance (float):

out_max_facing_camera_blend_distance (float):

out_cutout_texture (Texture2D):

out_bounding_mode (SubUVBoundingVertexCount):

out_opacity_source_mode (OpacitySourceMode):

out_emitter_normals_mode (EmitterNormalsMode):

out_alpha_threshold (float):

Return type:

tuple

classmethod get_particle_module_rotation_over_lifetime_props(particle_module) -> (out_rotation_over_life=Distribution, out_scale=bool)

Get Particle Module Rotation Over Lifetime Props

Parameters:

particle_module (ParticleModuleRotationOverLifetime)

Returns:

out_rotation_over_life (Distribution):

out_scale (bool):

Return type:

tuple

classmethod get_particle_module_rotation_props(particle_module) → Distribution

Get Particle Module Rotation Props

Parameters:

particle_module (ParticleModuleRotation)

Returns:

out_start_rotation (Distribution):

Return type:

Distribution

classmethod get_particle_module_rotation_rate_multiply_life_props(particle_module) → Distribution

Get Particle Module Rotation Rate Multiply Life Props

Parameters:

particle_module (ParticleModuleRotationRateMultiplyLife)

Returns:

out_life_multiplier (Distribution):

Return type:

Distribution

classmethod get_particle_module_rotation_rate_props(particle_module) → Distribution

Get Particle Module Rotation Rate Props

Parameters:

particle_module (ParticleModuleRotationRate)

Returns:

out_start_rotation_rate (Distribution):

Return type:

Distribution

classmethod get_particle_module_size_multiply_life_props(particle_module) -> (out_life_multiplier=Distribution, out_multiply_x=bool, out_multiply_y=bool, out_multiply_z=bool)

Get Particle Module Size Multiply Life Props

Parameters:

particle_module (ParticleModuleSizeMultiplyLife)

Returns:

out_life_multiplier (Distribution):

out_multiply_x (bool):

out_multiply_y (bool):

out_multiply_z (bool):

Return type:

tuple

classmethod get_particle_module_size_props(particle_module) → Distribution

Get Particle Module Size Props

Parameters:

particle_module (ParticleModuleSize)

Returns:

out_start_size (Distribution):

Return type:

Distribution

classmethod get_particle_module_size_scale_by_speed_props(particle_module) -> (out_speed_scale=Vector2D, out_max_scale=Vector2D)

Get Particle Module Size Scale by Speed Props

Parameters:

particle_module (ParticleModuleSizeScaleBySpeed)

Returns:

out_speed_scale (Vector2D):

out_max_scale (Vector2D):

Return type:

tuple

classmethod get_particle_module_size_scale_props(particle_module) → Distribution

Get Particle Module Size Scale Props

Parameters:

particle_module (ParticleModuleSizeScale)

Returns:

out_size_scale (Distribution):

Return type:

Distribution

classmethod get_particle_module_spawn_per_unit_props(particle_module) -> (out_unit_scalar=float, out_movement_tolerance=float, out_spawn_per_unit=Distribution, out_max_frame_distance=float, out_ignore_spawn_rate_when_moving=bool, out_ignore_movement_along_x=bool, out_ignore_movement_along_y=bool, out_ignore_movement_along_z=bool, out_process_spawn_rate=bool, out_process_burst_list=bool)

Get Particle Module Spawn Per Unit Props

Parameters:

particle_module (ParticleModuleSpawnPerUnit)

Returns:

out_unit_scalar (float):

out_movement_tolerance (float):

out_spawn_per_unit (Distribution):

out_max_frame_distance (float):

out_ignore_spawn_rate_when_moving (bool):

out_ignore_movement_along_x (bool):

out_ignore_movement_along_y (bool):

out_ignore_movement_along_z (bool):

out_process_spawn_rate (bool):

out_process_burst_list (bool):

Return type:

tuple

classmethod get_particle_module_spawn_props(particle_module_spawn) -> (out_rate=Distribution, out_rate_scale=Distribution, out_burst_method=ParticleBurstMethod, out_burst_list=Array[ParticleBurstBlueprint], out_burst_scale=Distribution, out_apply_global_spawn_rate_scale=bool, out_process_spawn_rate=bool, out_process_spawn_burst=bool)

Get Particle Module Spawn Props

Parameters:

particle_module_spawn (ParticleModuleSpawn)

Returns:

out_rate (Distribution):

out_rate_scale (Distribution):

out_burst_method (ParticleBurstMethod):

out_burst_list (Array[ParticleBurstBlueprint]):

out_burst_scale (Distribution):

out_apply_global_spawn_rate_scale (bool):

out_process_spawn_rate (bool):

out_process_spawn_burst (bool):

Return type:

tuple

classmethod get_particle_module_sub_uv_movie_props(particle_module) -> (out_use_emitter_time=bool, out_frame_rate=Distribution, out_starting_frame=int32)

Get Particle Module Sub UVMovie Props

Parameters:

particle_module (ParticleModuleSubUVMovie)

Returns:

out_use_emitter_time (bool):

out_frame_rate (Distribution):

out_starting_frame (int32):

Return type:

tuple

classmethod get_particle_module_sub_uv_props(particle_module) -> (out_animation=SubUVAnimation, out_sub_image_index=Distribution, out_use_real_time=bool)

Get Particle Module Sub UVProps

Parameters:

particle_module (ParticleModuleSubUV)

Returns:

out_animation (SubUVAnimation):

out_sub_image_index (Distribution):

out_use_real_time (bool):

Return type:

tuple

classmethod get_particle_module_trail_source_props(particle_module) -> (out_source_method=Trail2SourceMethod, out_source_name=Name, out_source_strength=Distribution, out_lock_source_strength=bool, out_source_offset_count=int32, out_source_offset_defaults=Array[Vector], out_selection_method=ParticleSourceSelectionMethod, out_inherit_rotation=bool)

Get Particle Module Trail Source Props

Parameters:

particle_module (ParticleModuleTrailSource)

Returns:

out_source_method (Trail2SourceMethod):

out_source_name (Name):

out_source_strength (Distribution):

out_lock_source_strength (bool):

out_source_offset_count (int32):

out_source_offset_defaults (Array[Vector]):

out_selection_method (ParticleSourceSelectionMethod):

out_inherit_rotation (bool):

Return type:

tuple

classmethod get_particle_module_type_data_beam2_props(particle_module) → None

Get Particle Module Type Data Beam 2Props

Parameters:

particle_module (ParticleModuleTypeDataBeam2)

classmethod get_particle_module_type_data_gpu_props(particle_module) → None

Get Particle Module Type Data Gpu Props

Parameters:

particle_module (ParticleModuleTypeDataGpu)

classmethod get_particle_module_type_data_mesh_props(particle_module) -> (out_mesh=StaticMesh, out_lod_size_scale=float, out_use_static_mesh_lo_ds=bool, out_cast_shadows=bool, out_do_collisions=bool, out_mesh_alignment=MeshScreenAlignment, out_override_material=bool, out_override_default_motion_blur_settings=bool, out_enable_motion_blur=bool, out_roll_pitch_yaw_range=Distribution, out_axis_lock_option=ParticleAxisLock, out_camera_facing=bool, out_camera_facing_up_axis_option=MeshCameraFacingUpAxis, out_camera_facing_option=MeshCameraFacingOptions, out_apply_particle_rotation_as_spin=bool, out_facing_camera_direction_rather_than_position=bool, out_collisions_consider_particle_size=bool)

Get Particle Module Type Data Mesh Props

Parameters:

particle_module (ParticleModuleTypeDataMesh)

Returns:

out_mesh (StaticMesh):

out_lod_size_scale (float):

out_use_static_mesh_lo_ds (bool):

out_cast_shadows (bool):

out_do_collisions (bool):

out_mesh_alignment (MeshScreenAlignment):

out_override_material (bool):

out_override_default_motion_blur_settings (bool):

out_enable_motion_blur (bool):

out_roll_pitch_yaw_range (Distribution):

out_axis_lock_option (ParticleAxisLock):

out_camera_facing (bool):

out_camera_facing_up_axis_option (MeshCameraFacingUpAxis):

out_camera_facing_option (MeshCameraFacingOptions):

out_apply_particle_rotation_as_spin (bool):

out_facing_camera_direction_rather_than_position (bool):

out_collisions_consider_particle_size (bool):

Return type:

tuple

classmethod get_particle_module_type_data_ribbon_class()

Get Particle Module Type Data Ribbon Class

Return type:

type(Class)

classmethod get_particle_module_type_data_ribbon_props(particle_module) -> (out_max_tessellation_between_particles=int32, out_sheets_per_trail=int32, out_max_trail_count=int32, out_max_particle_in_trail_count=int32, out_dead_trails_on_deactivate=bool, out_clip_source_segment=bool, out_enable_previous_tangent_recalculation=bool, out_tangent_recalculation_every_frame=bool, out_spawn_initial_particle=bool, out_render_axis=TrailsRenderAxisOption, out_tangent_spawning_scalar=float, out_render_geometry=bool, out_render_spawn_points=bool, out_render_tangents=bool, out_render_tessellation=bool, out_tiling_distance=float, out_distance_tessellation_step_size=float, out_enable_tangent_diff_interp_scale=bool, out_tangent_tessellation_scalar=float)

Get Particle Module Type Data Ribbon Props

Parameters:

particle_module (ParticleModuleTypeDataRibbon)

Returns:

out_max_tessellation_between_particles (int32):

out_sheets_per_trail (int32):

out_max_trail_count (int32):

out_max_particle_in_trail_count (int32):

out_dead_trails_on_deactivate (bool):

out_clip_source_segment (bool):

out_enable_previous_tangent_recalculation (bool):

out_tangent_recalculation_every_frame (bool):

out_spawn_initial_particle (bool):

out_render_axis (TrailsRenderAxisOption):

out_tangent_spawning_scalar (float):

out_render_geometry (bool):

out_render_spawn_points (bool):

out_render_tangents (bool):

out_render_tessellation (bool):

out_tiling_distance (float):

out_distance_tessellation_step_size (float):

out_enable_tangent_diff_interp_scale (bool):

out_tangent_tessellation_scalar (float):

Return type:

tuple

classmethod get_particle_module_vector_field_local_props(particle_module, out_vector_field) -> (out_relative_translation=Vector, out_relative_rotation=Rotator, out_relative_scale3d=Vector, out_intensity=float, out_tightness=float, out_ignore_component_transform=bool, out_tile_x=bool, out_tile_y=bool, out_tile_z=bool, out_use_fix_dt=bool)

Get Particle Module Vector Field Local Props

Parameters:
Returns:

out_relative_translation (Vector):

out_relative_rotation (Rotator):

out_relative_scale3d (Vector):

out_intensity (float):

out_tightness (float):

out_ignore_component_transform (bool):

out_tile_x (bool):

out_tile_y (bool):

out_tile_z (bool):

out_use_fix_dt (bool):

Return type:

tuple

classmethod get_particle_module_vector_field_rotation_rate_props(particle_module) → Vector

Get Particle Module Vector Field Rotation Rate Props

Parameters:

particle_module (ParticleModuleVectorFieldRotationRate)

Returns:

out_rotation_rate (Vector):

Return type:

Vector

classmethod get_particle_module_velocity_cone_props(particle_module) -> (out_angle_distribution=Distribution, out_velocity_distribution=Distribution, out_direction=Vector, out_world_space=bool, out_apply_owner_scale=bool)

Get Particle Module Velocity Cone Props

Parameters:

particle_module (ParticleModuleVelocityCone)

Returns:

out_angle_distribution (Distribution):

out_velocity_distribution (Distribution):

out_direction (Vector):

out_world_space (bool):

out_apply_owner_scale (bool):

Return type:

tuple

classmethod get_particle_module_velocity_inherit_parent_props(particle_module) -> (out_scale=Distribution, out_in_world_space=bool, out_apply_owner_scale=bool)

Get Particle Module Velocity Inherit Parent Props

Parameters:

particle_module (ParticleModuleVelocityInheritParent)

Returns:

out_scale (Distribution):

out_in_world_space (bool):

out_apply_owner_scale (bool):

Return type:

tuple

classmethod get_particle_module_velocity_over_lifetime_props(particle_module) -> (out_vel_over_life=Distribution, out_absolute=bool, out_in_world_space=bool, out_apply_owner_scale=bool)

Get Particle Module Velocity Over Lifetime Props

Parameters:

particle_module (ParticleModuleVelocityOverLifetime)

Returns:

out_vel_over_life (Distribution):

out_absolute (bool):

out_in_world_space (bool):

out_apply_owner_scale (bool):

Return type:

tuple

classmethod get_particle_module_velocity_props(particle_module) -> (out_start_velocity=Distribution, out_start_velocity_radial=Distribution, out_in_world_space=bool, out_apply_owner_scale=bool)

Get Particle Module Velocity Props

Parameters:

particle_module (ParticleModuleVelocity)

Returns:

out_start_velocity (Distribution):

out_start_velocity_radial (Distribution):

out_in_world_space (bool):

out_apply_owner_scale (bool):

Return type:

tuple

classmethod get_vector_distribution_const_curve_values(distribution) → InterpCurveVector

Get Vector Distribution Const Curve Values

Parameters:

distribution (DistributionVectorConstantCurve)

Returns:

out_interp_curve_vector (InterpCurveVector):

Return type:

InterpCurveVector

classmethod get_vector_distribution_const_values(distribution) → Vector

Get Vector Distribution Const Values

Parameters:

distribution (DistributionVectorConstant)

Returns:

out_const_vector (Vector):

Return type:

Vector

classmethod get_vector_distribution_parameter_values(distribution) -> (out_parameter_name=Name, out_min_input=Vector, out_max_input=Vector, out_min_output=Vector, out_max_output=Vector)

Get Vector Distribution Parameter Values

Parameters:

distribution (DistributionVectorParameterBase)

Returns:

out_parameter_name (Name):

out_min_input (Vector):

out_max_input (Vector):

out_min_output (Vector):

out_max_output (Vector):

Return type:

tuple

classmethod get_vector_distribution_uniform_curve_values(distribution) → InterpCurveTwoVectors

Get Vector Distribution Uniform Curve Values

Parameters:

distribution (DistributionVectorUniformCurve)

Returns:

out_interp_curve_two_vectors (InterpCurveTwoVectors):

Return type:

InterpCurveTwoVectors

classmethod get_vector_distribution_uniform_values(distribution) -> (out_min=Vector, out_max=Vector)

Get Vector Distribution Uniform Values

Parameters:

distribution (DistributionVectorUniform)

Returns:

out_min (Vector):

out_max (Vector):

Return type:

tuple

classmethod get_warmup_time(system) → float

Get Warmup Time

Parameters:

system (ParticleSystem)

Return type:

float

classmethod keys_from_interp_curve_float(curve) → Array[RichCurveKeyBP]

Cascade curve helpers

Parameters:

curve (InterpCurveFloat)

Return type:

Array[RichCurveKeyBP]

classmethod keys_from_interp_curve_two_vectors(curve, component_idx) → Array[RichCurveKeyBP]

Keys from Interp Curve Two Vectors

Parameters:
Return type:

Array[RichCurveKeyBP]

classmethod keys_from_interp_curve_vector(curve, component_idx) → Array[RichCurveKeyBP]

Keys from Interp Curve Vector

Parameters:
Return type:

Array[RichCurveKeyBP]

classmethod keys_from_interp_curve_vector2d(curve, component_idx) → Array[RichCurveKeyBP]

Keys from Interp Curve Vector 2D

Parameters:
Return type:

Array[RichCurveKeyBP]

classmethod set_mesh_renderer_material_overrides_from_cascade(mesh_renderer_props, mesh_materials) → None

Set Mesh Renderer Material Overrides from Cascade

Parameters: