Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > Engine > Particles > UParticleLODLevel

Light Theme

Dark Theme

UParticleLODLevel

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UParticleLODLevel

References

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

Syntax

class UParticleLODLevel : public UObject

Variables

		Name	Description
	uint32: 1	bEnabled	True if the LOD level is enabled, meaning it should be updated and rendered.
	uint32: 1	ConvertedModules
	TObjectPtr< cla...	EventGenerator	The optional EventGenerator module.
	TArray< TObject...	EventReceiverModules	Event receiver modules only!
	int32	Level	The index value of the LOD level
	TArray< TObject...	Modules	An array of particle modules that contain the adjusted data for the LOD level
	TArray< TObject...	OrbitModules	OrbitModules These are used to do offsets of the sprite from the particle location.
	int32	PeakActiveParticles
	TObjectPtr< cla...	RequiredModule	The required module for this LOD level
	TArray< TObject...	SpawningModules	SpawningModules - These are called to determine how many particles to spawn.
	TObjectPtr< cla...	SpawnModule	The SpawnRate/Burst module - required by all emitters.
	TArray< TObject...	SpawnModules	SpawnModules - These are called when particles are spawned.
	TObjectPtr< cla...	TypeDataModule	Module used for emitter type "extension".
	TArray< TObject...	UpdateModules	UpdateModules - These are called when particles are updated.

Constructors

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

Functions

		Name	Description
	void	AddCurvesToEditor ( UInterpCurveEdSetup* EdSetup )	For Cascade.
	int32	CalculateMaxActiveParticleCount()	CalculateMaxActiveParticleCount Determine the maximum active particles that could occur with this emitter.
	void	ChangeEditorColor ( FColor& Color, UInterpCurveEdSetup* EdSetup )
	void	CompileModules ( FParticleEmitterBuildInfo& Emitter... )	Compiles all modules for this LOD level.
	void	ConvertToSpawnModule()	Update to the new SpawnModule method
	bool	GenerateFromLODLevel ( UParticleLODLevel* SourceLODLe..., float Percentage, bool bGenerateModuleData )
	UParticleMod...	GetModuleAtIndex ( int32 InIndex )
	int32	GetModuleIndex ( UParticleModule* InModule )
	void	GetUsedMaterials ( TArray< UMaterialInterface* > ..., const TArray< struct FNamedEmitterM..., const TArray< UMaterialInterface&#... )	Append all used materials to the material list.
	bool	IsModuleEditable ( UParticleModule* InModule )	Return true if the given module is editable for this LOD level.
	void	RemoveCurvesFromEditor ( UInterpCurveEdSetup* EdSetup )
	void	SetLevelIndex ( int32 InLevelIndex )	Sets the LOD 'Level' to the given value, properly updating the modules LOD validity settings.
	void	UpdateModuleLists()

Overridden from UObject

		Name	Description
	bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.