unreal.ParticleModuleLocationSkelVertSurface

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

Bases: ParticleModuleLocationBase

Particle Module Location Skel Vert Surface

C++ Source:

  • Module: Engine

  • File: ParticleModuleLocationSkelVertSurface.h

Editor Properties: (see get_editor_property/set_editor_property)

  • b3d_draw_mode (bool): [Read-Write] If true, the module should render its 3D visualization helper

  • editor_skel_mesh (SkeletalMesh): [Read-Write] The name of the skeletal mesh to use in the editor

  • enforce_normal_check (bool): [Read-Write] When true use the RestrictToNormal and NormalTolerance values to check surface normals

  • inherit_bone_velocity (bool): [Read-Write] If true, particles inherit the associated bone velocity when spawned

  • inherit_uv (bool): [Read-Write] If true, particles inherit the associated UV data on spawn. Accessed through dynamic parameter module X and Y, must be a “Spawn Time Only” parameter on “AutoSet” mode. This feature is not supported for GPU particles.

  • inherit_uv_channel (uint32): [Read-Write] UV channel to inherit from the spawn mesh, internally clamped to those available.

  • inherit_velocity_scale (float): [Read-Write] A scale on how much of the bone’s velocity a particle will inherit.

  • inherit_vertex_color (bool): [Read-Write] If true, particles inherit the associated vertex color on spawn. This feature is not supported for GPU particles.

  • module_editor_color (Color): [Read-Write] The color to draw the modules curves in the curve editor.

    If bCurvesAsColor is true, it overrides this value.

  • normal_check_tolerance_degrees (float): [Read-Write] Normal tolerance. 0 degrees means it must be an exact match, 180 degrees means it can be any angle.

  • normal_to_compare (Vector): [Read-Write] Use this normal to restrict spawning locations

  • orient_mesh_emitters (bool): [Read-Write] If true, rotate mesh emitter meshes to orient w/ the vert/surface

  • skel_mesh_actor_param_name (Name): [Read-Write] The parameter name of the skeletal mesh actor that supplies the SkelMeshComponent for in-game.

  • source_type (LocationSkelVertSurfaceSource): [Read-Write] Whether the module uses Verts or Surfaces for locations.

    VERTSURFACESOURCE_Vert - Use Verts as the source locations. VERTSURFACESOURCE_Surface - Use Surfaces as the source locations.

  • universal_offset (Vector): [Read-Write] An offset to apply to each vert/surface

  • update_position_each_frame (bool): [Read-Write] If true, update the particle locations each frame with that of the vert/surface

  • valid_associated_bones (Array[Name]): [Read-Write] This module will only spawn from verts or surfaces associated with the bones in this list

  • valid_material_indices (Array[int32]): [Read-Write] Array of material indices that are valid materials to spawn from. If empty, any material will be considered valid