class unreal.NiagaraDataInterfaceSkeletalMesh(outer=None, name='None')

Bases: unreal.NiagaraDataInterface

Data Interface allowing sampling of skeletal meshes.

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraDataInterfaceSkeletalMesh.h

Editor Properties: (see get_editor_property/set_editor_property)

  • exclude_bone (bool): [Read-Write] Exclude Bone

  • exclude_bone_name (Name): [Read-Write] Optionally remove a single bone from Random / Random Unfiltered access. You can still include this bone in filtered list and access using the direct index functionality.

  • filtered_bones (Array(Name)): [Read-Write] Set of filtered bones that can be used for sampling. Select from these with GetFilteredBoneAt and RandomFilteredBone.

  • filtered_sockets (Array(Name)): [Read-Write] Set of filtered sockets that can be used for sampling. Select from these with GetFilteredSocketAt and RandomFilteredSocket.

  • mesh_user_parameter (NiagaraUserParameterBinding): [Read-Write] Reference to a user parameter if we’re reading one.

  • preview_mesh (SkeletalMesh): [Read-Write] Mesh used to sample from when not overridden by a source actor from the scene. Only available in editor for previewing. This is removed in cooked builds.

  • require_current_frame_data (bool): [Read-Write] When this option is disabled, we use the previous frame’s data for the skeletal mesh and can often issue the simulation early. This greatly

    reduces overhead and allows the game thread to run faster, but comes at a tradeoff if the dependencies might leave gaps or other visual artifacts.

  • sampling_regions (Array(Name)): [Read-Write] Sampling regions on the mesh from which to sample. Leave this empty to sample from the whole mesh.

  • skinning_mode (NDISkeletalMesh_SkinningMode): [Read-Write] Selects which skinning mode to use, for most cases Skin On The Fly will cover your requirements, see individual tooltips for more information.

  • source (Actor): [Read-Write] The source actor from which to sample. Takes precedence over the direct mesh. Note that this can only be set when used as a user variable on a component in the world.

  • source_mode (NDISkeletalMesh_SourceMode): [Read-Write] Controls how to retrieve the Skeletal Mesh Component to attach to.

  • whole_mesh_lod (int32): [Read-Write] If no regions are specified, we’ll sample the whole mesh at this LODIndex. -1 indicates to use the last LOD.