unreal.ParticleModuleLocationBoneSocket

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

Bases: ParticleModuleLocationBase

Particle Module Location Bone Socket

C++ Source:

  • Module: Engine

  • File: ParticleModuleLocationBoneSocket.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

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

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

  • 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.

  • num_pre_selected_indices (int32): [Read-Write] When we have no source locations and we need to track bone velocities due to bInheritBoneVelocity, we pre select a set of bones to use each frame. This property determines how big the list is. Too low and the randomness of selection may suffer, too high and memory will be wasted.

  • selection_method (LocationBoneSocketSelectionMethod): [Read-Write] The method by which to select the bone/socket to spawn at.

    SEL_Sequential - loop through the bone/socket array in order SEL_Random - randomly select a bone/socket from the array

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

  • source_locations (Array[LocationBoneSocketInfo]): [Read-Write] The name(s) of the bone/socket(s) to position at. If this is empty, the module will attempt to spawn from all bones or sockets.

  • source_type (LocationBoneSocketSource): [Read-Write] Whether the module uses Bones or Sockets for locations.

    BONESOCKETSOURCE_Bones - Use Bones as the source locations. BONESOCKETSOURCE_Sockets - Use Sockets as the source locations.

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

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