Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Particles > Location > UParticleModuleLocationBoneSocket

Light Theme

Dark Theme

UParticleModuleLocationBoneSocket

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UParticleModule

UParticleModuleLocationBase

UParticleModuleLocationBoneSocket

References

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

Syntax

class UParticleModuleLocationBoneSocket : public UParticleModuleLocationBase

Variables

	Name	Description
uint32: 1	bInheritBoneVelocity	If true, particles inherit the associated bone velocity when spawned
uint32: 1	bOrientMeshEmitters	If true, rotate mesh emitter meshes to orient w/ the socket. Currently does nothing.
uint32: 1	bUpdatePositionEachFrame	If true, update the particle locations each frame with that of the bone/socket
USkeletalMesh &...	EditorSkelMesh	The name of the skeletal mesh to use in the editor
float	InheritVelocityScale	A scale on how much of the bone's velocity a particle will inherit.
int32	NumPreSelectedIndices	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.
TEnumAsByte< en...	SelectionMethod	The method by which to select the bone/socket to spawn at.
FName	SkelMeshActorParamName	The parameter name of the skeletal mesh actor that supplies the SkelMeshComponent for in-game.
EBoneSocketSour...	SourceIndexMode	How particle SourceIndex should be interpreted.
TArray< struct ...	SourceLocations	The name(s) of the bone/socket(s) to position at.
TEnumAsByte< en...	SourceType	Whether the module uses Bones or Sockets for locations.
FVector	UniversalOffset	An offset to apply to each bone/socket

Constructors

	Name	Description
	UParticleModuleLocationBoneSocket ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	GetBoneInfoForSourceIndex ( FModuleLocationBoneSocketInstancePa..., USkeletalMeshComponent* Source..., int32 SourceIndex, FMatrix& OutBoneMatrix, FVector& OutOffset )
int32	GetMaxSourceIndex ( FModuleLocationBoneSocketInstancePa..., USkeletalMeshComponent* Source... )
bool	GetParticleLocation ( FModuleLocationBoneSocketInstancePa..., FParticleEmitterInstance* Owne..., USkeletalMeshComponent* InSkel..., int32 InBoneSocketIndex, FVector& OutPosition, FQuat* OutRotation )	Retrieve the position for the given socket index.
void	GetSkeletalMeshComponentSource ( FParticleEmitterInstance* Owne..., FModuleLocationBoneSocketInstancePa... )	Retrieve the skeletal mesh component source to use for the current emitter instance.
bool	GetSocketInfoForSourceIndex ( FModuleLocationBoneSocketInstancePa..., USkeletalMeshComponent* Source..., int32 SourceIndex, USkeletalMeshSocket*& OutSocke..., FVector& OutOffset )
bool	InheritingBoneVelocity()	If we're updating our position each frame, there's no point in inheriting bone velocity.
void	RegeneratePreSelectedIndices ( FModuleLocationBoneSocketInstancePa..., USkeletalMeshComponent* Source..., FRandomStream& InRandomStream )
int32	SelectNextSpawnIndex ( FModuleLocationBoneSocketInstancePa..., USkeletalMeshComponent* Source..., FRandomStream& InRandomStream )	Selects the next socket or bone index to spawn from.
void	SetSourceIndexMode()
void	UpdatePrevBoneLocationsAndVelocities ( FModuleLocationBoneSocketInstancePa..., USkeletalMeshComponent* Source..., float DeltaTime )
void	ValidateLODLevels ( UParticleEmitter* Emitter, int32 iModule )	Validate that all LOD levels will not have issues with indexing into SourceLocations

Overridden from UParticleModule

	Name	Description
void	AutoPopulateInstanceProperties ( UParticleSystemComponent* PSys... )	Helper function used by the editor to auto-populate a placed AEmitter with any instance parameters that are utilized.
bool	CanTickInAnyThread()	Return false if this emitter requires a game thread tick
void	FinalUpdate ( FParticleEmitterInstance* Owne..., int32 Offset, float DeltaTime )	Called on an emitter when all other update operations have taken place INCLUDING bounding box cacluations!
bool	GetCustomMenuEntryDisplayString ( int32 InEntryIndex, FString& OutDisplayString )	Get the display name of the custom menu entry.
int32	GetNumberOfCustomMenuOptions()	Custom Cascade module menu entries support Get the number of custom entries this module has.
bool	PerformCustomMenuEntry ( int32 InEntryIndex )	Perform the custom menu entry option.
uint32	PrepPerInstanceBlock ( FParticleEmitterInstance* Owne..., void* InstData )	Allows the module to prep its 'per-instance' data block.
uint32	RequiredBytes ( UParticleModuleTypeDataBase* T... )	Returns the number of bytes that the module requires in the particle payload block.
uint32	RequiredBytesPerInstance()	Returns the number of bytes the module requires in the emitters 'per-instance' data block.
void	Spawn ( FParticleEmitterInstance* Owne..., int32 Offset, float SpawnTime, FBaseParticle* ParticleBase )	Called on a particle that is freshly spawned by the emitter.
bool	TouchesMeshRotation()	Return true if this module impacts rotation of Mesh emitters
void	Update ( FParticleEmitterInstance* Owne..., int32 Offset, float DeltaTime )	Called on a particle that is being updated by its emitter.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss