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

Light Theme

Dark Theme

UParticleModuleOrbit

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UParticleModule

UParticleModuleOrbitBase

UParticleModuleOrbit

References

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

Syntax

class UParticleModuleOrbit : public UParticleModuleOrbitBase

Variables

	Name	Description
TEnumAsByte< en...	ChainMode	Orbit modules will chain together in the order they appear in the module stack.
FRawDistributio...	OffsetAmount	The amount to offset the sprite from the particle position.
FOrbitOptions	OffsetOptions	The options associated with the OffsetAmount look-up.
FRawDistributio...	RotationAmount	The amount (in 'turns') to rotate the offset about the particle position.
FOrbitOptions	RotationOptions	The options associated with the RotationAmount look-up.
FRawDistributio...	RotationRateAmount	The rate (in 'turns') at which to rotate the offset about the particle positon.
FOrbitOptions	RotationRateOptions	The options associated with the RotationRateAmount look-up.

Constructors

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

Functions

		Name	Description
	void	InitializeDefaults()	Initializes the default values for this property

Overridden from UParticleModule

	Name	Description
void	CompileModule ( FParticleEmitterBuildInfo& Emitter... )	Called once to compile the effects of this module on runtime simulation.
bool	IsValidForLODLevel ( UParticleLODLevel* LODLevel, FString& OutErrorString )	Returns true if the module is valid for the provided LOD level.
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.
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	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

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

Take our survey

Dismiss