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

Light Theme

Dark Theme

FParticleBeam2EmitterInstance

Windows

MacOS

Linux

Inheritance Hierarchy

FParticleEmitterInstance

FParticleBeam2EmitterInstance

References

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

Syntax

struct FParticleBeam2EmitterInstance : public FParticleEmitterInstance

Variables

	Name	Description
int32	BeamCount	The number of live beams
int32	BeamMethod	The method to utilize when forming the beam.
UParticleModule...	BeamModule_Noise
UParticleModule...	BeamModule_Source
UParticleModule...	BeamModule_SourceModifier
int32	BeamModule_SourceModifier_Offset
UParticleModule...	BeamModule_Target
UParticleModule...	BeamModule_TargetModifier
int32	BeamModule_TargetModifier_Offset
TArray< int32 >	BeamTrianglesPerSheet
UParticleModule...	BeamTypeData
TArray< float >	DistanceArray	The distance of each beam, if utilizing the distance method.
bool	FirstEmission
int32	ForceSpawnCount
AActor *	SourceActor	The actor to get the source point from.
FParticleEmitte...	SourceEmitter	The emitter to get the source point from.
AActor *	TargetActor	The actor to get the target point from.
FParticleEmitte...	TargetEmitter	The emitter to get the Target point from.
TArray< FVector...	TargetPointArray	The target point of each beam, when using the end point method.
TArray< FName >	TargetPointSourceNames	The target point sources of each beam, when using the end point method.
TArray< FVector...	TargetTangentArray	The target tangent of each beam, when using the end point method.
TArray< int32 >	TextureTiles	How many times to tile the texture along the beam.
int32	TickCount
int32	TriangleCount
TArray< FVector...	UserSetSourceArray	User set Source points of each beam - primarily for weapon effects.
TArray< float >	UserSetSourceStrengthArray	User set Source strengths of each beam - primarily for weapon effects.
TArray< FVector...	UserSetSourceTangentArray	User set Source tangents of each beam - primarily for weapon effects.
TArray< FVector...	UserSetTargetArray	User set target points of each beam - primarily for weapon effects.
TArray< float >	UserSetTargetStrengthArray	User set Target strengths of each beam - primarily for weapon effects.
TArray< FVector...	UserSetTargetTangentArray	User set target tangents of each beam - primarily for weapon effects.
int32	VertexCount	The number of vertices and triangles, for rendering

Constructors

	Name	Description
	FParticleBeam2EmitterInstance()	Constructor Beam particle stat objects Structure for beam emitter instancesConstructor

Name

Description

FParticleBeam2EmitterInstance()

Constructor

Beam particle stat objects Structure for beam emitter instancesConstructor

Destructors

	Name	Description
	~FParticleBeam2EmitterInstance()	Destructor

Functions

	Name	Description
void	DetermineVertexAndTriangleCount()	Determine the vertex and triangle counts for the emitter
UMaterialInt...	GetCurrentMaterial()	Get the current material to render with.
void	ResolveSource()	Resolve the source for the beam
void	ResolveTarget()	Resolve the target for the beam
void	SetupBeamModifierModulesOffsets()	Setup the offsets to the BeamModifier modules...
float	SpawnBeamParticles ( float OldLeftover, float Rate, float DeltaTime, int32 Burst, float BurstTime )	Spawn particles for this instance

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	ForceUpdateBoundingBox()	Force the bounding box to be updated.
void	GetAllocatedSize ( int32& OutNum, int32& OutMax )	Retrieve the allocated size of this instance.
bool	GetBeamEndPoint ( FVector& OutEndPoint )	Get the end point position
bool	GetBeamSourcePoint ( int32 SourceIndex, FVector& OutSourcePoint )	Get the source point at the given index
bool	GetBeamSourceStrength ( int32 SourceIndex, float& OutSourceStrength )	Get the source strength at the given index
bool	GetBeamSourceTangent ( int32 SourceIndex, FVector& OutTangentPoint )	Get the source tangent at the given index
bool	GetBeamTargetPoint ( int32 TargetIndex, FVector& OutTargetPoint )	Get the target point at the given index
bool	GetBeamTargetStrength ( int32 TargetIndex, float& OutTargetStrength )	Get the target strength at the given index
bool	GetBeamTargetTangent ( int32 TargetIndex, FVector& OutTangentPoint )	Get the target tangent at the given index
FDynamicEmit...	GetDynamicData ( bool bSelected, ERHIFeatureLevel::Type InFeatureLev... )	Retrieves the dynamic data for the emitter 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	Init()	Initialize the instance
void	InitParameters ( UParticleEmitter* InTemplate, UParticleSystemComponent* InCo... )
void	KillParticles()	Kill off any dead particles. (Remove them from the active array)
void	OnEmitterInstanceKilled ( FParticleEmitterInstance* Inst... )	When an emitter is killed, this will check other emitters and clean up anything pointing to this one
void	PostSpawn ( FBaseParticle* Particle, float InterpolationPercentage, float SpawnTime )	Handle any post-spawning actions required by the instance
uint32	RequiredBytes()	Retrieved the per-particle bytes that this emitter type requires.
void	SetBeamEndPoint ( FVector NewEndPoint )	Set the end point position
void	SetBeamSourcePoint ( FVector NewSourcePoint, int32 SourceIndex )	Set the source point
void	SetBeamSourceStrength ( float NewSourceStrength, int32 SourceIndex )	Set the source strength
void	SetBeamSourceTangent ( FVector NewTangentPoint, int32 SourceIndex )	Set the source tangent
void	SetBeamTargetPoint ( FVector NewTargetPoint, int32 TargetIndex )	Set the target point
void	SetBeamTargetStrength ( float NewTargetStrength, int32 TargetIndex )	Set the target strength
void	SetBeamTargetTangent ( FVector NewTangentPoint, int32 TargetIndex )	Set the target tangent
void	SetCurrentLODIndex ( int32 InLODIndex, bool bInFullyProcess )	Set the LOD to the given index
void	Tick ( float DeltaTime, bool bSuppressSpawning )	Tick the instance.
void	Tick_ModulePostUpdate ( float DeltaTime, UParticleLODLevel* CurrentLODL... )	Tick sub-function that handles module post updates
void	UpdateBoundingBox ( float DeltaTime )	Update the bounding box for the emitter

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

Take our survey

Dismiss