1. Epic GamesDeveloper
  3. UParticleModuleLocationSkelVertSurface

UParticleModuleLocationSkelVertSurface

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Particles > API/Runtime/Engine/Particles/Location

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Particles/Location/ParticleModuleLocationSkelVertSurface.h
Include #include "Particles/Location/ParticleModuleLocationSkelVertSurface.h"

Syntax

UCLASS (EditInlineNew, HideCategories=Object, Meta=(DisplayName="Skel Vert/Surf Location"),  
       MinimalAPI)  
class UParticleModuleLocationSkelVertSurface : public UParticleModuleLocationBase

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere uint32: 1 bEnforceNormalCheck When true use the RestrictToNormal and NormalTolerance values to check surface normals
Public variable UProperty Category, EditAnywhere uint32: 1 bInheritBoneVelocity If true, particles inherit the associated bone velocity when spawned
Public variable UProperty Category, EditAnywhere uint32: 1 bInheritUV If true, particles inherit the associated UV data on spawn.
Public variable UProperty Category, EditAnywhere uint32: 1 bInheritVertexColor If true, particles inherit the associated vertex color on spawn.
Public variable UProperty Category, EditAnywhere uint32: 1 bOrientMeshEmitters If true, rotate mesh emitter meshes to orient w/ the vert/surface
Public variable UProperty Category, EditAnywhere uint32: 1 bUpdatePositionEachFrame If true, update the particle locations each frame with that of the vert/surface
Public variable UProperty Category, EditAnywhere TObjectPtr< class USkeletalMesh > EditorSkelMesh The name of the skeletal mesh to use in the editor
Public variable UProperty Category, EditAnywhere uint32 InheritUVChannel UV channel to inherit from the spawn mesh, internally clamped to those available.
Public variable UProperty Category, EditAnywhere float InheritVelocityScale A scale on how much of the bone's velocity a particle will inherit.
Public variable UProperty float NormalCheckTolerance Normal tolerance.
Public variable UProperty Category, EditAnywhere float NormalCheckToleranceDegrees Normal tolerance. 0 degrees means it must be an exact match, 180 degrees means it can be any angle.
Public variable UProperty Category, EditAnywhere FVector NormalToCompare Use this normal to restrict spawning locations
Public variable UProperty Category, EditAnywhere FName SkelMeshActorParamName The parameter name of the skeletal mesh actor that supplies the SkelMeshComponent for in-game.
Public variable UProperty Category, EditAnywhere TEnumAsByte< enum ELocationSkelVertSurfaceSource > SourceType Whether the module uses Verts or Surfaces for locations.
Public variable UProperty Category, EditAnywhere FVector UniversalOffset An offset to apply to each vert/surface
Public variable UProperty Category, EditAnywhere TArray< FName > ValidAssociatedBones This module will only spawn from verts or surfaces associated with the bones in this list
Public variable UProperty Category, EditAnywhere TArray< int32 > ValidMaterialIndices Array of material indices that are valid materials to spawn from.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function bool

GetParticleLocation ( FParticleEmitterInstance* Owner,
FModuleLocationVertSurfaceInstancePayload* InstPayload,
USkeletalMeshComponent* InSkelMeshComponent,
int32 InPrimaryVertexIndex,
FVector& OutPosition,
FQuat& OutRotation,
bool bSpawning
)

 Retrieve the position for the given socket index.
Public function void Retrieve the skeletal mesh component source to use for the current emitter instance.
Public function void Updates the indices list with the bone index for each named bone in the editor exposed values.
Public function bool

VertInfluencedByActiveBone ( FParticleEmitterInstance* Owner,
FModuleLocationVertSurfaceInstancePayload* InstPayload,
USkeletalMeshComponent* InSkelMeshComponent,
int32 InVertexIndex,
int32* OutBoneIndex
)

 Check to see if the vert is influenced by a bone on our approved list.

Overridden from UParticleModule

  Type Name Description
Public function Virtual void Helper function used by the editor to auto-populate a placed AEmitter with any instance parameters that are utilized.
Public function Virtual bool Return false if this emitter requires a game thread tick
Public function Virtual void

FinalUpdate ( FParticleEmitterInstance* Owner,
int32 Offset,
float DeltaTime
)

 Called on an emitter when all other update operations have taken place INCLUDING bounding box cacluations!
Public function Virtual Const bool

GetCustomMenuEntryDisplayString ( int32 InEntryIndex,
FString& OutDisplayString
)

 Get the display name of the custom menu entry.
Public function Virtual Const int32 Custom Cascade module menu entries support Get the number of custom entries this module has.
Public function Virtual bool

IsValidForLODLevel ( UParticleLODLevel* LODLevel,
FString& OutErrorString
)

 Returns true if the module is valid for the provided LOD level.
Public function Virtual bool

PerformCustomMenuEntry ( int32 InEntryIndex
)

 Perform the custom menu entry option.
Public function Virtual uint32

PrepPerInstanceBlock ( FParticleEmitterInstance* Owner,
void* InstData
)

 Allows the module to prep its 'per-instance' data block.
Public function Virtual uint32 Returns the number of bytes that the module requires in the particle payload block.
Public function Virtual uint32 Returns the number of bytes the module requires in the emitters 'per-instance' data block.
Public function Virtual void

Spawn ( FParticleEmitterInstance* Owner,
int32 Offset,
float SpawnTime,
FBaseParticle* ParticleBase
)

 Called on a particle that is freshly spawned by the emitter.
Public function Virtual Const bool Return true if this module impacts rotation of Mesh emitters
Public function Virtual void

Update ( FParticleEmitterInstance* Owner,
int32 Offset,
float DeltaTime
)

 Called on a particle that is being updated by its emitter.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page