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 > FParticleRibbonEmitterInstance

Light Theme

Dark Theme

FParticleRibbonEmitterInstance

Windows

MacOS

Linux

Inheritance Hierarchy

FParticleEmitterInstance

FParticleTrailsEmitterInstance_Base

FParticleRibbonEmitterInstance

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/ParticleEmitterInstances.h
Include	#include "ParticleEmitterInstances.h"

Syntax

struct FParticleRibbonEmitterInstance : public FParticleTrailsEmitterInstance_Base

Variables

	Name	Description
TArray< float >	CurrentLifetimes	The lifetime to use for each ribbon
TArray< float >	CurrentSizes	The size to use for each ribbon
TArray< FVector...	CurrentSourcePosition	The current source position for each trail in this emitter
TArray< FQuat >	CurrentSourceRotation	The current source rotation for each trail in this emitter
TArray< FVector...	CurrentSourceTangent	The current source tangent for each trail in this emitter
TArray< float >	CurrentSourceTangentStrength	The current source tangent strength for each trail in this emitter
TArray< FVector...	CurrentSourceUp	The current source up for each trail in this emitter
int32	HeadOnlyParticles	TArray CurrentStartIndices;.
int32	LastSelectedParticleIndex	The last selected source index (for sequential selection)
TArray< FVector...	LastSourcePosition	The previous source position for each trail in this emitter
TArray< FQuat >	LastSourceRotation	The last source rotation for each trail in this emitter
TArray< FVector...	LastSourceTangent	The previous source tangent for each trail in this emitter
TArray< float >	LastSourceTangentStrength	The previous source tangent strength for each trail in this emitter
TArray< float >	LastSourceTimes	The time of the last partice source update
TArray< FVector...	LastSourceUp	The previous source up for each trail in this emitter
AActor *	SourceActor	If the source is an actor, this is it
FParticleEmitte...	SourceEmitter	If the source is an emitter, this is it
TArray< int32 >	SourceIndices	The indices for the source of each trail (if required)
UParticleModule...	SourceModule	Source module
TArray< FVector...	SourceOffsets	The offset from the source for each trail in this emitter
TArray< float >	SourceTimes	The time of the last partice source update
UParticleModule...	SpawnPerUnitModule	SpawnPerUnit module (hijacking it for trails here)
int32	TrailModule_Source_Offset	Payload offset for source module
UParticleModule...	TrailTypeData	The TypeData module for this trail emitter

Constructors

	Name	Description
	FParticleRibbonEmitterInstance()	Constructor

Destructors

	Name	Description
	~FParticleRibbonEmitterInstance()	Destructor

Functions

	Name	Description
void	DetermineVertexAndTriangleCount()	Determine the number of vertices and triangles in each trail
void	GetParticleLifetimeAndSize ( int32 InTrailIdx, const FBaseParticle* InParticl..., bool bInNoLivingParticles, float& OutOneOverMaxLifetime, float& OutSize )	Get the lifetime and size for a particle being added to the given trail
bool	GetSpawnPerUnitAmount ( float DeltaTime, int32 InTrailIdx, int32& OutCount, float& OutRate )
void	ResolveSource()
bool	ResolveSourcePoint ( int32 InTrailIdx, FVector& OutPosition, FQuat& OutRotation, FVector& OutUp, FVector& OutTangent, float& OutTangentStrength )	Virtual void UpdateStartParticles(float DeltaTime, bool bFirstTime);
float	Spawn_RateAndBurst ( float DeltaTime )	Spawn ribbon particles from SpawnRate and Burst settings.
bool	Spawn_Source ( float DeltaTime )	Spawn source-based ribbon particles.

Overridden from FParticleTrailsEmitterInstance_Base

	Name	Description
void	SetupTrailModules()
void	Tick_RecalculateTangents ( float DeltaTime, UParticleLODLevel* CurrentLODL... )	Tick sub-function that handles recalculation of tangents
void	UpdateSourceData ( float DeltaTime, bool bFirstTime )

Overridden from FParticleEmitterInstance

	Name	Description
void	ApplyWorldOffset ( FVector InOffset, bool bWorldShift )	Called on world origin changes
bool	FillReplayData ( FDynamicEmitterReplayDataBase& Out... )	Captures dynamic replay data for this particle system.
void	GetAllocatedSize ( int32& OutNum, int32& OutMax )	Retrieve the allocated size of this instance.
FDynamicEmit...	GetDynamicData ( bool bSelected, ERHIFeatureLevel::Type InFeatureLev... )	Retrieves the dynamic data for the emitter
FDynamicEmit...	GetReplayData()	Retrieves replay data for the emitter
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )	Returns the size of the object/ resource for display to artists/ LDs in the Editor.
void	InitParameters ( UParticleEmitter* InTemplate, UParticleSystemComponent* InCo... )
bool	IsDynamicDataRequired ( UParticleLODLevel* CurrentLODL... )	Checks some common values for GetDynamicData validity
void	OnEmitterInstanceKilled ( FParticleEmitterInstance* Inst... )	When an emitter is killed, this will check other emitters and clean up anything pointing to this one
float	Spawn ( float DeltaTime )	Spawn particles for this emitter instance

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

Take our survey

Dismiss