1. Epic GamesDeveloper
  3. UParticleModuleLocationSkelVertSurface

UParticleModuleLocationSkelVertSurface

API > API/Runtime > API/Runtime/Engine

   
Name UParticleModuleLocationSkelVertSurface
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Particles/Location/ParticleModuleLocationSkelVertSurface.h
Include Path #include "Particles/Location/ParticleModuleLocationSkelVertSurface.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UParticleModuleLocationSkelVertSurface ( const FObjectInitializer& ObjectInitializer
)

   Particles/Location/ParticleModuleLocationSkelVertSurface.h  

Variables

Public

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetParticleLocation ( const FContext& Context,
FModuleLocationVertSurfaceInstancePayload* InstPayload,
USkeletalMeshComponent* InSkelMeshComponent,
int32 InPrimaryVertexIndex,
FVector& OutPosition,
FQuat& OutRotation,
bool bSpawning
)

 Retrieve the position for the given socket index. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

void GetSkeletalMeshComponentSource ( const FContext& Context,
FModuleLocationVertSurfaceInstancePayload* InstancePayload
)

 Retrieve the skeletal mesh component source to use for the current emitter instance. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

void UpdateBoneIndicesList ( FParticleEmitterInstance* Owner
)

 Updates the indices list with the bone index for each named bone in the editor exposed values. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

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. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

Overridden from UParticleModule

Name Remarks Include Path Unreal Specifiers

virtual void AutoPopulateInstanceProperties ( UParticleSystemComponent* PSysComp
)

 Helper function used by the editor to auto-populate a placed AEmitter with any instance parameters that are utilized. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual bool CanTickInAnyThread()

 Return false if this emitter requires a game thread tick Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual void FinalUpdate ( const FUpdateContext& Context
)

 Called on an emitter when all other update operations have taken place INCLUDING bounding box cacluations! Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual bool GetCustomMenuEntryDisplayString ( int32 InEntryIndex,
FString& OutDisplayString
) const

 Get the display name of the custom menu entry. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual int32 GetNumberOfCustomMenuOptions ()

 Custom Cascade module menu entries support Get the number of custom entries this module has. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual bool IsValidForLODLevel ( UParticleLODLevel* LODLevel,
FString& OutErrorString
)

 Returns true if the module is valid for the provided LOD level. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual bool PerformCustomMenuEntry ( int32 InEntryIndex
)

 Perform the custom menu entry option. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual uint32 PrepPerInstanceBlock ( FParticleEmitterInstance* Owner,
void* InstData
)

 Allows the module to prep its 'per-instance' data block. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual uint32 RequiredBytes ( UParticleModuleTypeDataBase* TypeData
)

 Returns the number of bytes that the module requires in the particle payload block. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual uint32 RequiredBytesPerInstance()

 Returns the number of bytes the module requires in the emitters 'per-instance' data block. Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual void Spawn ( const FSpawnContext& Context
)

   Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual bool TouchesMeshRotation()

 Return true if this module impacts rotation of Mesh emitters Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual void Update ( const FUpdateContext& Context
)

   Particles/Location/ParticleModuleLocationSkelVertSurface.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Particles/Location/ParticleModuleLocationSkelVertSurface.h  

virtual void PostLoad()

   Particles/Location/ParticleModuleLocationSkelVertSurface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page