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 > TypeData > UParticleModuleTypeDataMesh

Light Theme

Dark Theme

UParticleModuleTypeDataMesh

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UParticleModule

UParticleModuleTypeDataBase

UParticleModuleTypeDataMesh

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Particles/TypeData/ParticleModuleTypeDataMesh.h
Include	#include "Particles/TypeData/ParticleModuleTypeDataMesh.h"

Syntax

class UParticleModuleTypeDataMesh : public UParticleModuleTypeDataBase

Variables

	Name	Description
TEnumAsByte< EP...	AxisLockOption	The axis to lock the mesh on.
uint8: 1	bApplyParticleRotationAsSpin	If true, apply 'sprite' particle rotation about the orientation axis (direction mesh is pointing).
uint8: 1	bCameraFacing	If true, then point the X-axis of the mesh towards the camera.
uint8: 1	bCollisionsConsiderPartilceSize	If true, all collisions for mesh particle on this emitter will take the particle size into account.
uint8: 1	bEnableMotionBlur
uint8: 1	bFaceCameraDirectionRatherThanPosition	If true, all camera facing options will point the mesh against the camera's view direction rather than pointing at the cameras location.
uint8: 1	bOverrideDefaultMotionBlurSettings
uint8: 1	bOverrideMaterial	If true, use the emitter material when rendering rather than the one applied to the static mesh model.
uint8: 1	bUseStaticMeshLODs	Use the static mesh's LOD setup and switch LODs based on largest particle's screen size
TEnumAsByte< en...	CameraFacingOption	The camera facing option to use: All camera facing options without locked axis assume X-axis will be facing the camera.
uint8: 1	CastShadows	If true, has the meshes cast shadows
uint8: 1	DoCollisions	UNUSED (the collision module dictates doing collisions)
float	LODSizeScale	Use the static mesh's LOD setup and switch LODs based on largest particle's screen size
TObjectPtr< USt...	Mesh	The static mesh to render at the particle positions
TEnumAsByte< en...	MeshAlignment	The alignment to use on the meshes emitted.
FRandomStream	RandomStream	Random stream for the initial rotation distribution
FRawDistributio...	RollPitchYawRange	The 'pre' rotation pitch (in degrees) to apply to the static mesh used.

Constructors

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

Functions

		Name	Description
	void	CreateDistribution()
	int32	GetCurrentDetailMode()
	int32	GetMeshParticleMotionBlurMinDetailMode()
	void	OnMeshChanged()

Overridden from UParticleModuleTypeDataBase

	Name	Description
FParticleEmi...	CreateInstance ( UParticleEmitter* InEmitterPar..., UParticleSystemComponent* InCo... )
bool	IsAMeshEmitter()
bool	IsMotionBlurEnabled()	Determine if motion blur is enabled for the owning emitter.
bool	SupportsSpecificScreenAlignmentFlags()
bool	SupportsSubUV()

Overridden from UParticleModule

		Name	Description
	void	SetToSensibleDefaults ( UParticleEmitter* Owner )	For Cascade.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
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.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	TEnumAsByte< en...	CameraFacingUpAxisOption_DEPRECATED	The axis of the mesh to point up when camera facing the X-axis.