UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FParticleBeam2EmitterInstance Struct Reference

#include <ParticleEmitterInstances.h>

+ Inheritance diagram for FParticleBeam2EmitterInstance:

Public Member Functions

 FParticleBeam2EmitterInstance (IParticleEmitterInstanceOwner &InComponent)
 
virtual ~FParticleBeam2EmitterInstance ()
 
virtual void SetBeamEndPoint (FVector NewEndPoint) override
 
virtual void SetBeamSourcePoint (FVector NewSourcePoint, int32 SourceIndex) override
 
virtual void SetBeamSourceTangent (FVector NewTangentPoint, int32 SourceIndex) override
 
virtual void SetBeamSourceStrength (float NewSourceStrength, int32 SourceIndex) override
 
virtual void SetBeamTargetPoint (FVector NewTargetPoint, int32 TargetIndex) override
 
virtual void SetBeamTargetTangent (FVector NewTangentPoint, int32 TargetIndex) override
 
virtual void SetBeamTargetStrength (float NewTargetStrength, int32 TargetIndex) override
 
virtual void ApplyWorldOffset (FVector InOffset, bool bWorldShift) override
 
virtual bool GetBeamEndPoint (FVector &OutEndPoint) const override
 
virtual bool GetBeamSourcePoint (int32 SourceIndex, FVector &OutSourcePoint) const override
 
virtual bool GetBeamSourceTangent (int32 SourceIndex, FVector &OutTangentPoint) const override
 
virtual bool GetBeamSourceStrength (int32 SourceIndex, float &OutSourceStrength) const override
 
virtual bool GetBeamTargetPoint (int32 TargetIndex, FVector &OutTargetPoint) const override
 
virtual bool GetBeamTargetTangent (int32 TargetIndex, FVector &OutTangentPoint) const override
 
virtual bool GetBeamTargetStrength (int32 TargetIndex, float &OutTargetStrength) const override
 
virtual void InitParameters (UParticleEmitter *InTemplate) override
 
virtual void Init () override
 
virtual void Tick (float DeltaTime, bool bSuppressSpawning) override
 
virtual void Tick_ModulePostUpdate (float DeltaTime, UParticleLODLevel *CurrentLODLevel) override
 
virtual void SetCurrentLODIndex (int32 InLODIndex, bool bInFullyProcess) override
 
virtual void PostSpawn (FBaseParticle *Particle, float InterpolationPercentage, float SpawnTime) override
 
virtual void UpdateBoundingBox (float DeltaTime) override
 
virtual void ForceUpdateBoundingBox () override
 
virtual uint32 RequiredBytes () override
 
float SpawnBeamParticles (float OldLeftover, float Rate, float DeltaTime, int32 Burst=0, float BurstTime=0.0f)
 
virtual void KillParticles () override
 
void SetupBeamModifierModulesOffsets ()
 
void ResolveSource ()
 
void ResolveTarget ()
 
void DetermineVertexAndTriangleCount ()
 
virtual FDynamicEmitterDataBaseGetDynamicData (bool bSelected, ERHIFeatureLevel::Type InFeatureLevel) override
 
virtual FDynamicEmitterReplayDataBaseGetReplayData () override
 
virtual void GetAllocatedSize (int32 &OutNum, int32 &OutMax) override
 
virtual void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize) override
 
virtual void OnEmitterInstanceKilled (FParticleEmitterInstance *Instance) override
 
- Public Member Functions inherited from FParticleEmitterInstance
ENGINE_API FParticleEmitterInstance (IParticleEmitterInstanceOwner &InComponent)
 
virtual ENGINE_API ~FParticleEmitterInstance ()
 
virtual ENGINE_API bool Resize (int32 NewMaxActiveParticles, bool bSetMaxActiveCount=true)
 
ENGINE_API void CheckEmitterFinished ()
 
ENGINE_API void FakeBursts ()
 
virtual ENGINE_API float Tick_EmitterTimeSetup (float DeltaTime, UParticleLODLevel *CurrentLODLevel)
 
virtual ENGINE_API float Tick_SpawnParticles (float DeltaTime, UParticleLODLevel *CurrentLODLevel, bool bSuppressSpawning, bool bFirstTime)
 
virtual ENGINE_API void Tick_ModuleUpdate (float DeltaTime, UParticleLODLevel *CurrentLODLevel)
 
virtual ENGINE_API void Tick_ModuleFinalUpdate (float DeltaTime, UParticleLODLevel *CurrentLODLevel)
 
virtual ENGINE_API void Rewind ()
 
virtual ENGINE_API FBox GetBoundingBox ()
 
ENGINE_API uint32 GetModuleDataOffset (UParticleModule *Module)
 
ENGINE_API uint8GetModuleInstanceData (UParticleModule *Module)
 
ENGINE_API FParticleRandomSeedInstancePayloadGetModuleRandomSeedInstanceData (UParticleModule *Module)
 
virtual ENGINE_API uint8GetTypeDataModuleInstanceData ()
 
virtual ENGINE_API uint32 CalculateParticleStride (uint32 ParticleSize)
 
virtual ENGINE_API void ResetBurstList ()
 
virtual ENGINE_API float GetCurrentBurstRateOffset (float &DeltaTime, int32 &Burst)
 
virtual ENGINE_API void ResetParticleParameters (float DeltaTime)
 
ENGINE_API void CalculateOrbitOffset (FOrbitChainModuleInstancePayload &Payload, FVector &AccumOffset, FVector &AccumRotation, FVector &AccumRotationRate, float DeltaTime, FVector &Result, FMatrix &RotationMat)
 
virtual ENGINE_API void UpdateOrbitData (float DeltaTime)
 
virtual ENGINE_API void ParticlePrefetch ()
 
virtual ENGINE_API float Spawn (float DeltaTime)
 
ENGINE_API void SpawnParticles (int32 Count, float StartTime, float Increment, const FVector &InitialLocation, const FVector &InitialVelocity, struct FParticleEventInstancePayload *EventPayload)
 
virtual ENGINE_API void ForceSpawn (float DeltaTime, int32 InSpawnCount, int32 InBurstCount, FVector &InLocation, FVector &InVelocity)
 
ENGINE_API void CheckSpawnCount (int32 InNewCount, int32 InMaxCount)
 
virtual ENGINE_API void PreSpawn (FBaseParticle *Particle, const FVector &InitialLocation, const FVector &InitialVelocity)
 
virtual ENGINE_API bool HasCompleted ()
 
virtual ENGINE_API void KillParticle (int32 Index)
 
virtual ENGINE_API void KillParticlesForced (bool bFireEvents=false)
 
virtual void SetHaltSpawning (bool bInHaltSpawning)
 
virtual void SetHaltSpawningExternal (bool bInHaltSpawning)
 
void SetFakeBurstWhenSpawningSupressed (bool bInFakeBurstsWhenSpawningSupressed)
 
ENGINE_API int32 GetOrbitPayloadOffset ()
 
ENGINE_API FVector GetParticleLocationWithOrbitOffset (FBaseParticle *Particle)
 
virtual ENGINE_API FBaseParticleGetParticle (int32 Index)
 
int32 GetParticleDirectIndex (int32 InIndex)
 
virtual ENGINE_API FBaseParticleGetParticleDirect (int32 InDirectIndex)
 
ENGINE_API void SetupEmitterDuration ()
 
bool HasActiveParticles ()
 
virtual ENGINE_API bool IsDynamicDataRequired (UParticleLODLevel *CurrentLODLevel)
 
virtual ENGINE_API void ProcessParticleEvents (float DeltaTime, bool bSuppressSpawning)
 
virtual void OnDeactivateSystem ()
 
virtual int32 GetMeshRotationOffset () const
 
virtual bool IsMeshRotationActive () const
 
virtual void SetMeshMaterials (const TArray< UMaterialInterface * > &InMaterials)
 
virtual ENGINE_API void GatherMaterialRelevance (FMaterialRelevance *OutMaterialRelevance, const UParticleLODLevel *LODLevel, ERHIFeatureLevel::Type InFeatureLevel) const
 
virtual ENGINE_API void GatherMaterialRelevance (FMaterialRelevance *OutMaterialRelevance, const UParticleLODLevel *LODLevel, EShaderPlatform InShaderPlatform) const
 
virtual bool IsTrailEmitter () const
 
virtual void BeginTrail ()
 
virtual void EndTrail ()
 
virtual void SetTrailSourceData (FName InFirstSocketName, FName InSecondSocketName, ETrailWidthMode InWidthMode, float InWidth)
 
virtual ENGINE_API void Tick_MaterialOverrides (int32 EmitterIndex)
 
ENGINE_API bool UseLocalSpace ()
 
ENGINE_API void GetScreenAlignmentAndScale (int32 &OutScreenAlign, FVector &OutScale)
 
- Public Member Functions inherited from FParticleEmitterInstanceFixLayout
virtual ~FParticleEmitterInstanceFixLayout ()=default
 

Public Attributes

UParticleModuleTypeDataBeam2BeamTypeData
 
UParticleModuleBeamSourceBeamModule_Source
 
UParticleModuleBeamTargetBeamModule_Target
 
UParticleModuleBeamNoiseBeamModule_Noise
 
UParticleModuleBeamModifierBeamModule_SourceModifier
 
int32 BeamModule_SourceModifier_Offset
 
UParticleModuleBeamModifierBeamModule_TargetModifier
 
int32 BeamModule_TargetModifier_Offset
 
bool FirstEmission
 
int32 TickCount
 
int32 ForceSpawnCount
 
int32 BeamMethod
 
TArray< int32TextureTiles
 
int32 BeamCount
 
AActorSourceActor
 
FParticleEmitterInstanceSourceEmitter
 
TArray< FVectorUserSetSourceArray
 
TArray< FVectorUserSetSourceTangentArray
 
TArray< floatUserSetSourceStrengthArray
 
TArray< floatDistanceArray
 
TArray< FVectorTargetPointArray
 
TArray< FVectorTargetTangentArray
 
TArray< floatUserSetTargetStrengthArray
 
AActorTargetActor
 
FParticleEmitterInstanceTargetEmitter
 
TArray< FNameTargetPointSourceNames
 
TArray< FVectorUserSetTargetArray
 
TArray< FVectorUserSetTargetTangentArray
 
int32 VertexCount
 
int32 TriangleCount
 
TArray< int32BeamTrianglesPerSheet
 
- Public Attributes inherited from FParticleEmitterInstance
UParticleEmitterSpriteTemplate
 
IParticleEmitterInstanceOwnerComponent
 
UParticleLODLevelCurrentLODLevel
 
int32 CurrentLODLevelIndex
 
int32 TypeDataOffset
 
int32 TypeDataInstanceOffset
 
int32 SubUVDataOffset
 
int32 DynamicParameterDataOffset
 
int32 LightDataOffset
 
float LightVolumetricScatteringIntensity
 
int32 OrbitModuleOffset
 
int32 CameraPayloadOffset
 
int32 PayloadOffset
 
FVector Location
 
FMatrix EmitterToSimulation
 
FMatrix SimulationToWorld
 
uint8 bEnabled: 1
 
uint8 bKillOnDeactivate:1
 
uint8 bKillOnCompleted:1
 
uint8 bRequiresSorting:1
 
uint8 bHaltSpawning: 1
 
uint8 bHaltSpawningExternal: 1
 
uint8 bRequiresLoopNotification:1
 
uint8 bIgnoreComponentScale:1
 
uint8 bIsBeam:1
 
uint8 bAxisLockEnabled: 1
 
uint8 bFakeBurstsWhenSpawningSupressed: 1
 
uint8 bEmitterIsDone:1
 
TEnumAsByte< EParticleAxisLockLockAxisFlags
 
int32 SortMode
 
uint8ParticleData
 
uint16ParticleIndices
 
uint8InstanceData
 
int32 InstancePayloadSize
 
int32 ParticleSize
 
int32 ParticleStride
 
int32 ActiveParticles
 
uint32 ParticleCounter
 
int32 MaxActiveParticles
 
float SpawnFraction
 
float SecondsSinceCreation
 
float EmitterTime
 
float LastDeltaTime
 
FVector OldLocation
 
FBox ParticleBoundingBox
 
TArray< struct FLODBurstFiredBurstFired
 
int32 LoopCount
 
int32 IsRenderDataDirty
 
float EmitterDuration
 
TArray< floatEmitterDurations
 
float CurrentDelay
 
int32 TrianglesToRender
 
int32 MaxVertexIndex
 
UMaterialInterfaceCurrentMaterial
 
int32 EventCount
 
int32 MaxEventCount
 
FVector PositionOffsetThisTick
 
FVector2D PivotOffset
 
TArray< class UPointLightComponent * > HighQualityLights
 

Protected Member Functions

UMaterialInterfaceGetCurrentMaterial ()
 
virtual bool FillReplayData (FDynamicEmitterReplayDataBase &OutData) override
 
- Protected Member Functions inherited from FParticleEmitterInstance
ENGINE_API void UpdateTransforms ()
 
ENGINE_API class UParticleLODLevelGetCurrentLODLevelChecked ()
 
ENGINE_API UMaterialInterfaceGetCurrentMaterial ()
 
ENGINE_API void FixupParticleIndices ()
 

Additional Inherited Members

- Static Public Attributes inherited from FParticleEmitterInstance
static ENGINE_API const float PeakActiveParticleUpdateDelta = 0.05f
 

Constructor & Destructor Documentation

◆ FParticleBeam2EmitterInstance()

FParticleBeam2EmitterInstance::FParticleBeam2EmitterInstance ( IParticleEmitterInstanceOwner InComponent)

Constructor

Structure for beam emitter instances Constructor

◆ ~FParticleBeam2EmitterInstance()

FParticleBeam2EmitterInstance::~FParticleBeam2EmitterInstance ( )
virtual

Destructor

Member Function Documentation

◆ ApplyWorldOffset()

void FParticleBeam2EmitterInstance::ApplyWorldOffset ( FVector  InOffset,
bool  bWorldShift 
)
overridevirtual

Reimplemented from FParticleEmitterInstance.

◆ DetermineVertexAndTriangleCount()

void FParticleBeam2EmitterInstance::DetermineVertexAndTriangleCount ( )

Determine the vertex and triangle counts for the emitter

◆ FillReplayData()

bool FParticleBeam2EmitterInstance::FillReplayData ( FDynamicEmitterReplayDataBase OutData)
overrideprotectedvirtual

Captures dynamic replay data for this particle system.

Parameters
OutData[Out] Data will be copied here
Returns
Returns true if successful

Reimplemented from FParticleEmitterInstance.

◆ ForceUpdateBoundingBox()

void FParticleBeam2EmitterInstance::ForceUpdateBoundingBox ( )
overridevirtual

Force the bounding box to be updated.

Reimplemented from FParticleEmitterInstance.

◆ GetAllocatedSize()

void FParticleBeam2EmitterInstance::GetAllocatedSize ( int32 OutNum,
int32 OutMax 
)
overridevirtual

Retrieve the allocated size of this instance.

Parameters
OutNumThe size of this instance
OutMaxThe maximum size of this instance

Reimplemented from FParticleEmitterInstance.

◆ GetBeamEndPoint()

bool FParticleBeam2EmitterInstance::GetBeamEndPoint ( FVector OutEndPoint) const
overridevirtual

Get the end point position

Parameters
OutEndPointCurrent end point position
Returns
true End point is set - OutEndPoint is valid false End point is not set - OutEndPoint is invalid

Reimplemented from FParticleEmitterInstance.

◆ GetBeamSourcePoint()

bool FParticleBeam2EmitterInstance::GetBeamSourcePoint ( int32  SourceIndex,
FVector OutSourcePoint 
) const
overridevirtual

Get the source point at the given index

Parameters
SourceIndexThe index of the source point
OutSourcePointValue of of source point
Returns
true SourceIndex is valid - OutSourcePoint is valid false SourceIndex is invalid - OutSourcePoint is invalid

Reimplemented from FParticleEmitterInstance.

◆ GetBeamSourceStrength()

bool FParticleBeam2EmitterInstance::GetBeamSourceStrength ( int32  SourceIndex,
float OutSourceStrength 
) const
overridevirtual

Get the source strength at the given index

Parameters
SourceIndexThe index of the source point
OutSourceStrengthValue of of source strength
Returns
true SourceIndex is valid - OutSourceStrength is valid false SourceIndex is invalid - OutSourceStrength is invalid

Reimplemented from FParticleEmitterInstance.

◆ GetBeamSourceTangent()

bool FParticleBeam2EmitterInstance::GetBeamSourceTangent ( int32  SourceIndex,
FVector OutSourcePoint 
) const
overridevirtual

Get the source tangent at the given index

Parameters
SourceIndexThe index of the source point
OutSourceTangentValue of of source tangent
Returns
true SourceIndex is valid - OutSourceTangent is valid false SourceIndex is invalid - OutSourceTangent is invalid

Reimplemented from FParticleEmitterInstance.

◆ GetBeamTargetPoint()

bool FParticleBeam2EmitterInstance::GetBeamTargetPoint ( int32  TargetIndex,
FVector OutTargetPoint 
) const
overridevirtual

Get the target point at the given index

Parameters
TargetIndexThe index of the target point
OutTargetPointValue of of target point
Returns
true TargetIndex is valid - OutTargetPoint is valid false TargetIndex is invalid - OutTargetPoint is invalid

Reimplemented from FParticleEmitterInstance.

◆ GetBeamTargetStrength()

bool FParticleBeam2EmitterInstance::GetBeamTargetStrength ( int32  TargetIndex,
float OutTargetStrength 
) const
overridevirtual

Get the target strength at the given index

Parameters
TargetIndexThe index of the target point
OutTargetStrengthValue of of target strength
Returns
true TargetIndex is valid - OutTargetStrength is valid false TargetIndex is invalid - OutTargetStrength is invalid

Reimplemented from FParticleEmitterInstance.

◆ GetBeamTargetTangent()

bool FParticleBeam2EmitterInstance::GetBeamTargetTangent ( int32  TargetIndex,
FVector OutTangentPoint 
) const
overridevirtual

Get the target tangent at the given index

Parameters
TargetIndexThe index of the target point
OutTangentPointValue of of target tangent
Returns
true TargetIndex is valid - OutTangentPoint is valid false TargetIndex is invalid - OutTangentPoint is invalid

Reimplemented from FParticleEmitterInstance.

◆ GetCurrentMaterial()

UMaterialInterface * FParticleBeam2EmitterInstance::GetCurrentMaterial ( )
protected

Get the current material to render with.

◆ GetDynamicData()

FDynamicEmitterDataBase * FParticleBeam2EmitterInstance::GetDynamicData ( bool  bSelected,
ERHIFeatureLevel::Type  InFeatureLevel 
)
overridevirtual

Retrieves the dynamic data for the emitter

Retrieves the dynamic data for the emitter

Parameters
bSelectedWhether the emitter is selected in the editor
InFeatureLevelThe relevant shader feature level.
Returns
FDynamicEmitterDataBase* The dynamic data, or NULL if it shouldn't be rendered

Reimplemented from FParticleEmitterInstance.

◆ GetReplayData()

FDynamicEmitterReplayDataBase * FParticleBeam2EmitterInstance::GetReplayData ( )
overridevirtual

Retrieves replay data for the emitter

Returns
The replay data, or NULL on failure

Reimplemented from FParticleEmitterInstance.

◆ GetResourceSizeEx()

void FParticleBeam2EmitterInstance::GetResourceSizeEx ( FResourceSizeEx CumulativeResourceSize)
overridevirtual

Returns the size of the object/ resource for display to artists/ LDs in the Editor.

Parameters
ModeSpecifies which resource size should be displayed. ( see EResourceSizeMode::Type )
Returns
Size of resource as to be displayed to artists/ LDs in the Editor.

Reimplemented from FParticleEmitterInstance.

◆ Init()

void FParticleBeam2EmitterInstance::Init ( )
overridevirtual

Initialize the instance

Reimplemented from FParticleEmitterInstance.

◆ InitParameters()

void FParticleBeam2EmitterInstance::InitParameters ( UParticleEmitter InTemplate)
overridevirtual

Reimplemented from FParticleEmitterInstance.

◆ KillParticles()

void FParticleBeam2EmitterInstance::KillParticles ( )
overridevirtual

Kill off any dead particles. (Remove them from the active array)

Reimplemented from FParticleEmitterInstance.

◆ OnEmitterInstanceKilled()

virtual void FParticleBeam2EmitterInstance::OnEmitterInstanceKilled ( FParticleEmitterInstance Instance)
inlineoverridevirtual

When an emitter is killed, this will check other emitters and clean up anything pointing to this one

Reimplemented from FParticleEmitterInstance.

◆ PostSpawn()

void FParticleBeam2EmitterInstance::PostSpawn ( FBaseParticle Particle,
float  InterpolationPercentage,
float  SpawnTime 
)
overridevirtual

Handle any post-spawning actions required by the instance

Parameters
ParticleThe particle that was spawned
InterpolationPercentageThe percentage of the time slice it was spawned at
SpawnTImeThe time it was spawned at

Reimplemented from FParticleEmitterInstance.

◆ RequiredBytes()

uint32 FParticleBeam2EmitterInstance::RequiredBytes ( )
overridevirtual

Retrieved the per-particle bytes that this emitter type requires.

Returns
uint32 The number of required bytes for particles in the instance

Reimplemented from FParticleEmitterInstance.

◆ ResolveSource()

void FParticleBeam2EmitterInstance::ResolveSource ( )

Resolve the source for the beam

◆ ResolveTarget()

void FParticleBeam2EmitterInstance::ResolveTarget ( )

Resolve the target for the beam

◆ SetBeamEndPoint()

void FParticleBeam2EmitterInstance::SetBeamEndPoint ( FVector  NewEndPoint)
overridevirtual

Set the end point position

Parameters
NewEndPoint

Reimplemented from FParticleEmitterInstance.

◆ SetBeamSourcePoint()

void FParticleBeam2EmitterInstance::SetBeamSourcePoint ( FVector  NewSourcePoint,
int32  SourceIndex 
)
overridevirtual

Set the source point

Parameters
NewSourcePoint
SourceIndexThe index of the source being set

Reimplemented from FParticleEmitterInstance.

◆ SetBeamSourceStrength()

void FParticleBeam2EmitterInstance::SetBeamSourceStrength ( float  NewSourceStrength,
int32  SourceIndex 
)
overridevirtual

Set the source strength

Parameters
NewSourceStrengthThe source strenght to set it to
SourceIndexThe index of the source being set

Reimplemented from FParticleEmitterInstance.

◆ SetBeamSourceTangent()

void FParticleBeam2EmitterInstance::SetBeamSourceTangent ( FVector  NewTangentPoint,
int32  SourceIndex 
)
overridevirtual

Set the source tangent

Parameters
NewTangentPointThe tangent value to set it to
SourceIndexThe index of the source being set

Reimplemented from FParticleEmitterInstance.

◆ SetBeamTargetPoint()

void FParticleBeam2EmitterInstance::SetBeamTargetPoint ( FVector  NewTargetPoint,
int32  TargetIndex 
)
overridevirtual

Set the target point

Parameters
NewTargetPointThe target point to set it to
TargetIndexThe index of the target being set

Reimplemented from FParticleEmitterInstance.

◆ SetBeamTargetStrength()

void FParticleBeam2EmitterInstance::SetBeamTargetStrength ( float  NewTargetStrength,
int32  TargetIndex 
)
overridevirtual

Set the target strength

Parameters
NewTargetStrengthThe strength to set it ot
TargetIndexThe index of the target being set

Reimplemented from FParticleEmitterInstance.

◆ SetBeamTargetTangent()

void FParticleBeam2EmitterInstance::SetBeamTargetTangent ( FVector  NewTangentPoint,
int32  TargetIndex 
)
overridevirtual

Set the target tangent

Parameters
NewTangentPointThe tangent to set it to
TargetIndexThe index of the target being set

Reimplemented from FParticleEmitterInstance.

◆ SetCurrentLODIndex()

void FParticleBeam2EmitterInstance::SetCurrentLODIndex ( int32  InLODIndex,
bool  bInFullyProcess 
)
overridevirtual

Set the LOD to the given index

Parameters
InLODIndexThe index of the LOD to set as current
bInFullyProcessIf true, process burst lists, etc.

Reimplemented from FParticleEmitterInstance.

◆ SetupBeamModifierModulesOffsets()

void FParticleBeam2EmitterInstance::SetupBeamModifierModulesOffsets ( )

Setup the offsets to the BeamModifier modules... This must be done after the base Init call as that inserts modules into the offset map.

◆ SpawnBeamParticles()

float FParticleBeam2EmitterInstance::SpawnBeamParticles ( float  OldLeftover,
float  Rate,
float  DeltaTime,
int32  Burst = 0,
float  BurstTime = 0.0f 
)

Spawn particles for this instance

Parameters
OldLeftoverThe leftover time from the last spawn
RateThe rate at which particles should be spawned
DeltaTimeThe time slice to spawn over
BurstThe number of burst particle
BurstTimeThe burst time addition (faked time slice)
Returns
float The leftover fraction of spawning

◆ Tick()

void FParticleBeam2EmitterInstance::Tick ( float  DeltaTime,
bool  bSuppressSpawning 
)
overridevirtual

Tick the instance.

Parameters
DeltaTimeThe time slice to use
bSuppressSpawningIf true, do not spawn during Tick

Reimplemented from FParticleEmitterInstance.

◆ Tick_ModulePostUpdate()

void FParticleBeam2EmitterInstance::Tick_ModulePostUpdate ( float  DeltaTime,
UParticleLODLevel InCurrentLODLevel 
)
overridevirtual

Tick sub-function that handles module post updates

Parameters
DeltaTimeThe current time slice
CurrentLODLevelThe current LOD level for the instance

Reimplemented from FParticleEmitterInstance.

◆ UpdateBoundingBox()

void FParticleBeam2EmitterInstance::UpdateBoundingBox ( float  DeltaTime)
overridevirtual

Update the bounding box for the emitter

Parameters
DeltaTimeThe time slice to use

Reimplemented from FParticleEmitterInstance.

Member Data Documentation

◆ BeamCount

int32 FParticleBeam2EmitterInstance::BeamCount

The number of live beams

◆ BeamMethod

int32 FParticleBeam2EmitterInstance::BeamMethod

The method to utilize when forming the beam.

◆ BeamModule_Noise

UParticleModuleBeamNoise* FParticleBeam2EmitterInstance::BeamModule_Noise

◆ BeamModule_Source

UParticleModuleBeamSource* FParticleBeam2EmitterInstance::BeamModule_Source

◆ BeamModule_SourceModifier

UParticleModuleBeamModifier* FParticleBeam2EmitterInstance::BeamModule_SourceModifier

◆ BeamModule_SourceModifier_Offset

int32 FParticleBeam2EmitterInstance::BeamModule_SourceModifier_Offset

◆ BeamModule_Target

UParticleModuleBeamTarget* FParticleBeam2EmitterInstance::BeamModule_Target

◆ BeamModule_TargetModifier

UParticleModuleBeamModifier* FParticleBeam2EmitterInstance::BeamModule_TargetModifier

◆ BeamModule_TargetModifier_Offset

int32 FParticleBeam2EmitterInstance::BeamModule_TargetModifier_Offset

◆ BeamTrianglesPerSheet

TArray<int32> FParticleBeam2EmitterInstance::BeamTrianglesPerSheet

◆ BeamTypeData

UParticleModuleTypeDataBeam2* FParticleBeam2EmitterInstance::BeamTypeData

◆ DistanceArray

TArray<float> FParticleBeam2EmitterInstance::DistanceArray

The distance of each beam, if utilizing the distance method.

◆ FirstEmission

bool FParticleBeam2EmitterInstance::FirstEmission

◆ ForceSpawnCount

int32 FParticleBeam2EmitterInstance::ForceSpawnCount

◆ SourceActor

AActor* FParticleBeam2EmitterInstance::SourceActor

The actor to get the source point from.

◆ SourceEmitter

FParticleEmitterInstance* FParticleBeam2EmitterInstance::SourceEmitter

The emitter to get the source point from.

◆ TargetActor

AActor* FParticleBeam2EmitterInstance::TargetActor

The actor to get the target point from.

◆ TargetEmitter

FParticleEmitterInstance* FParticleBeam2EmitterInstance::TargetEmitter

The emitter to get the Target point from.

◆ TargetPointArray

TArray<FVector> FParticleBeam2EmitterInstance::TargetPointArray

The target point of each beam, when using the end point method.

◆ TargetPointSourceNames

TArray<FName> FParticleBeam2EmitterInstance::TargetPointSourceNames

The target point sources of each beam, when using the end point method.

◆ TargetTangentArray

TArray<FVector> FParticleBeam2EmitterInstance::TargetTangentArray

The target tangent of each beam, when using the end point method.

◆ TextureTiles

TArray<int32> FParticleBeam2EmitterInstance::TextureTiles

How many times to tile the texture along the beam.

◆ TickCount

int32 FParticleBeam2EmitterInstance::TickCount

◆ TriangleCount

int32 FParticleBeam2EmitterInstance::TriangleCount

◆ UserSetSourceArray

TArray<FVector> FParticleBeam2EmitterInstance::UserSetSourceArray

User set Source points of each beam - primarily for weapon effects.

◆ UserSetSourceStrengthArray

TArray<float> FParticleBeam2EmitterInstance::UserSetSourceStrengthArray

User set Source strengths of each beam - primarily for weapon effects.

◆ UserSetSourceTangentArray

TArray<FVector> FParticleBeam2EmitterInstance::UserSetSourceTangentArray

User set Source tangents of each beam - primarily for weapon effects.

◆ UserSetTargetArray

TArray<FVector> FParticleBeam2EmitterInstance::UserSetTargetArray

User set target points of each beam - primarily for weapon effects.

◆ UserSetTargetStrengthArray

TArray<float> FParticleBeam2EmitterInstance::UserSetTargetStrengthArray

User set Target strengths of each beam - primarily for weapon effects.

◆ UserSetTargetTangentArray

TArray<FVector> FParticleBeam2EmitterInstance::UserSetTargetTangentArray

User set target tangents of each beam - primarily for weapon effects.

◆ VertexCount

int32 FParticleBeam2EmitterInstance::VertexCount

The number of vertices and triangles, for rendering


The documentation for this struct was generated from the following files: