Navigation
API > API/Runtime > API/Runtime/Engine
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
| Type | Name | Description | |
|---|---|---|---|
| int32 | BeamCount | The number of live beams | |
| int32 | BeamMethod | The method to utilize when forming the beam. | |
| UParticleModuleBeamNoise * | BeamModule_Noise | ||
| UParticleModuleBeamSource * | BeamModule_Source | ||
| UParticleModuleBeamModifier * | BeamModule_SourceModifier | ||
| int32 | BeamModule_SourceModifier_Offset | ||
| UParticleModuleBeamTarget * | BeamModule_Target | ||
| UParticleModuleBeamModifier * | BeamModule_TargetModifier | ||
| int32 | BeamModule_TargetModifier_Offset | ||
| TArray< int32 > | BeamTrianglesPerSheet | ||
| UParticleModuleTypeDataBeam2 * | 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. | |
| FParticleEmitterInstance * | SourceEmitter | The emitter to get the source point from. | |
| AActor * | TargetActor | The actor to get the target point from. | |
| FParticleEmitterInstance * | 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
| Type | Name | Description | |
|---|---|---|---|
| ConstructorBeam particle stat objects Structure for beam emitter instancesConstructor |
Destructors
| Type | Name | Description | |
|---|---|---|---|
| Destructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Determine the vertex and triangle counts for the emitter | ||
| UMaterialInterface * | Get the current material to render with. | ||
| void | Resolve the source for the beam | ||
| void | Resolve the target for the beam | ||
| void | Setup the offsets to the BeamModifier modules... | ||
| float | SpawnBeamParticles
(
float OldLeftover, |
Spawn particles for this instance |
Overridden from FParticleEmitterInstance
| Type | Name | Description | |
|---|---|---|---|
| void | ApplyWorldOffset
(
FVector InOffset, |
Called on world origin changes. | |
| bool | FillReplayData
(
FDynamicEmitterReplayDataBase& OutData |
Captures dynamic replay data for this particle system. | |
| void | Force the bounding box to be updated. | ||
| void | GetAllocatedSize
(
int32& OutNum, |
Retrieve the allocated size of this instance. | |
| bool | GetBeamEndPoint
(
FVector& OutEndPoint |
Get the end point position | |
| bool | GetBeamSourcePoint
(
int32 SourceIndex, |
Get the source point at the given index | |
| bool | GetBeamSourceStrength
(
int32 SourceIndex, |
Get the source strength at the given index | |
| bool | GetBeamSourceTangent
(
int32 SourceIndex, |
Get the source tangent at the given index | |
| bool | GetBeamTargetPoint
(
int32 TargetIndex, |
Get the target point at the given index | |
| bool | GetBeamTargetStrength
(
int32 TargetIndex, |
Get the target strength at the given index | |
| bool | GetBeamTargetTangent
(
int32 TargetIndex, |
Get the target tangent at the given index | |
| FDynamicEmitterDataBase * | GetDynamicData
(
bool bSelected, |
Retrieves the dynamic data for the emitterRetrieves the dynamic data for the emitter | |
| FDynamicEmitterReplayDataBase * | Retrieves replay data for the emitter | ||
| void | GetResourceSizeEx
(
FResourceSizeEx& CumulativeResourceSize |
Returns the size of the object/ resource for display to artists/ LDs in the Editor. | |
| void | Init () |
Initialize the instance | |
| void | InitParameters
(
UParticleEmitter* InTemplate, |
||
| void | Kill off any dead particles. (Remove them from the active array) | ||
| void | OnEmitterInstanceKilled
(
FParticleEmitterInstance* Instance |
When an emitter is killed, this will check other emitters and clean up anything pointing to this one | |
| void | PostSpawn
(
FBaseParticle* Particle, |
Handle any post-spawning actions required by the instance | |
| uint32 | Retrieved the per-particle bytes that this emitter type requires. | ||
| void | SetBeamEndPoint
(
FVector NewEndPoint |
Set the end point position | |
| void | SetBeamSourcePoint
(
FVector NewSourcePoint, |
Set the source point | |
| void | SetBeamSourceStrength
(
float NewSourceStrength, |
Set the source strength | |
| void | SetBeamSourceTangent
(
FVector NewTangentPoint, |
Set the source tangent | |
| void | SetBeamTargetPoint
(
FVector NewTargetPoint, |
Set the target point | |
| void | SetBeamTargetStrength
(
float NewTargetStrength, |
Set the target strength | |
| void | SetBeamTargetTangent
(
FVector NewTangentPoint, |
Set the target tangent | |
| void | SetCurrentLODIndex
(
int32 InLODIndex, |
Set the LOD to the given index | |
| void | Tick
(
float DeltaTime, |
Tick the instance. | |
| void | Tick_ModulePostUpdate
(
float DeltaTime, |
Tick sub-function that handles module post updates | |
| void | UpdateBoundingBox
(
float DeltaTime |
Update the bounding box for the emitter |