1. Epic GamesDeveloper
  3. FParticleBeam2EmitterInstance

FParticleBeam2EmitterInstance

API > API/Runtime > API/Runtime/Engine

   
Name FParticleBeam2EmitterInstance
Type struct
Header File /Engine/Source/Runtime/Engine/Public/ParticleEmitterInstances.h
Include Path #include "ParticleEmitterInstances.h"

Syntax

struct FParticleBeam2EmitterInstance : public FParticleEmitterInstance

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FParticleBeam2EmitterInstance ( IParticleEmitterInstanceOwner& InComponent
)

 ConstructorBeam particle stat objects Structure for beam emitter instances Constructor ParticleEmitterInstances.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FParticleBeam2EmitterInstance()

 Destructor ParticleEmitterInstances.h  

Variables

Public

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DetermineVertexAndTriangleCount()

 Determine the vertex and triangle counts for the emitter ParticleEmitterInstances.h  

void ResolveSource()

 Resolve the source for the beam ParticleEmitterInstances.h  

void ResolveTarget()

 Resolve the target for the beam ParticleEmitterInstances.h  
Setup the offsets to the BeamModifier modules... ParticleEmitterInstances.h  

float SpawnBeamParticles ( float OldLeftover,
float Rate,
float DeltaTime,
int32 Burst,
float BurstTime
)

 Spawn particles for this instance ParticleEmitterInstances.h  

Overridden from FParticleEmitterInstance

Name Remarks Include Path Unreal Specifiers

virtual void ApplyWorldOffset ( FVector InOffset,
bool bWorldShift
)

 Called on world origin changes. ParticleEmitterInstances.h  

virtual void ForceUpdateBoundingBox()

 Force the bounding box to be updated. ParticleEmitterInstances.h  

virtual void GetAllocatedSize ( int32& OutNum,
int32& OutMax
)

 Retrieve the allocated size of this instance. ParticleEmitterInstances.h  

virtual bool GetBeamEndPoint ( FVector& OutEndPoint
) const

 Get the end point position ParticleEmitterInstances.h  

virtual bool GetBeamSourcePoint ( int32 SourceIndex,
FVector& OutSourcePoint
) const

 Get the source point at the given index ParticleEmitterInstances.h  

virtual bool GetBeamSourceStrength ( int32 SourceIndex,
float& OutSourceStrength
) const

 Get the source strength at the given index ParticleEmitterInstances.h  

virtual bool GetBeamSourceTangent ( int32 SourceIndex,
FVector& OutTangentPoint
) const

 Get the source tangent at the given index ParticleEmitterInstances.h  

virtual bool GetBeamTargetPoint ( int32 TargetIndex,
FVector& OutTargetPoint
) const

 Get the target point at the given index ParticleEmitterInstances.h  

virtual bool GetBeamTargetStrength ( int32 TargetIndex,
float& OutTargetStrength
) const

 Get the target strength at the given index ParticleEmitterInstances.h  

virtual bool GetBeamTargetTangent ( int32 TargetIndex,
FVector& OutTangentPoint
) const

 Get the target tangent at the given index ParticleEmitterInstances.h  

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

 Retrieves the dynamic data for the emitterRetrieves the dynamic data for the emitter ParticleEmitterInstances.h  

virtual FDynamicEmitterReplayDataBase * GetReplayData()

 Retrieves replay data for the emitter ParticleEmitterInstances.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

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

virtual void Init()

 Initialize the instance ParticleEmitterInstances.h  

virtual void InitParameters ( UParticleEmitter* InTemplate
)

   ParticleEmitterInstances.h  

virtual void KillParticles()

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

virtual void OnEmitterInstanceKilled ( FParticleEmitterInstance* Instance
)

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

virtual void PostSpawn ( FBaseParticle* Particle,
float InterpolationPercentage,
float SpawnTime
)

 Handle any post-spawning actions required by the instance ParticleEmitterInstances.h  

virtual uint32 RequiredBytes()

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

virtual void SetBeamEndPoint ( FVector NewEndPoint
)

 Set the end point position ParticleEmitterInstances.h  

virtual void SetBeamSourcePoint ( FVector NewSourcePoint,
int32 SourceIndex
)

 Set the source point ParticleEmitterInstances.h  

virtual void SetBeamSourceStrength ( float NewSourceStrength,
int32 SourceIndex
)

 Set the source strength ParticleEmitterInstances.h  

virtual void SetBeamSourceTangent ( FVector NewTangentPoint,
int32 SourceIndex
)

 Set the source tangent ParticleEmitterInstances.h  

virtual void SetBeamTargetPoint ( FVector NewTargetPoint,
int32 TargetIndex
)

 Set the target point ParticleEmitterInstances.h  

virtual void SetBeamTargetStrength ( float NewTargetStrength,
int32 TargetIndex
)

 Set the target strength ParticleEmitterInstances.h  

virtual void SetBeamTargetTangent ( FVector NewTangentPoint,
int32 TargetIndex
)

 Set the target tangent ParticleEmitterInstances.h  

virtual void SetCurrentLODIndex ( int32 InLODIndex,
bool bInFullyProcess
)

 Set the LOD to the given index ParticleEmitterInstances.h  

virtual void Tick ( float DeltaTime,
bool bSuppressSpawning
)

 Tick the instance. ParticleEmitterInstances.h  

virtual void Tick_ModulePostUpdate ( float DeltaTime,
UParticleLODLevel* CurrentLODLevel
)

 Tick sub-function that handles module post updates ParticleEmitterInstances.h  

virtual void UpdateBoundingBox ( float DeltaTime
)

 Update the bounding box for the emitter ParticleEmitterInstances.h  

Protected

Name Remarks Include Path Unreal Specifiers

UMaterialInterface * GetCurrentMaterial()

 Get the current material to render with. ParticleEmitterInstances.h  

Overridden from FParticleEmitterInstance

Name Remarks Include Path Unreal Specifiers

virtual bool FillReplayData ( FDynamicEmitterReplayDataBase& OutData
)

 Captures dynamic replay data for this particle system. ParticleEmitterInstances.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page