FParticleTrailsEmitterInstance_Base

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/ParticleEmitterInstances.h

Include

#include "ParticleEmitterInstances.h"

Syntax

struct FParticleTrailsEmitterInstance_Base : public FParticleEmitterInstance

Variables

Name Description

Public variable

uint32: 1

 

bDeadTrailsOnDeactivate

If true, mark trails dead on deactivate

Public variable

uint32: 1

 

bEnableInactiveTimeTracking

If true, when the system checks for particles to kill, it will use elapsed gametime to make the determination.

Public variable

uint32: 1

 

bFirstUpdate

If true, this emitter has not been updated yet...

Public variable

TArray< float >

 

LastSpawnTime

The last time a spawn happened for each trail in this emitter

Public variable

float

 

LastTickTime

The last time the emitter instance was ticked

Public variable

int32

 

MaxTrailCount

The max number of trails this emitter is allowed to have

Public variable

float

 

RunningTime

The running time for this instance w/ ActiveParticles > 0

Public variable

TArray< float >

 

SourceDistanceTraveled

The distance traveled by each source of each trail in this emitter

Public variable

TArray< float >

 

TiledUDistanceTraveled

The distance traveled by each source of each trail in this emitter

Public variable

int32

 

TrailCount

The number of active trails in this emitter

Public variable

TArray< float >

 

TrailSpawnTimes

The Spawn times for each trail in this emitter

Public variable

int32

 

TriangleCount

The triangle count for this emitter

Public variable

int32

 

VertexCount

The vertex count for this emitter

Constructors

Name Description

Public function

FParticleTrailsEmitterInstance_Base()

Constructor

Destructors

Name Description

Public function Virtual

~FParticleTrailsEmitterInstance_Base()

Destructor

Functions

Name Description

Public function

bool

 

AddParticleHelper

(
    int32 InTrailIdx,
    int32 StartParticleIndex,
    FTrailsBaseTypeDataPayload* St...,
    int32 ParticleIndex,
    FTrailsBaseTypeDataPayload* Tr...,
    UParticleSystemComponent* InPs...
)

Public function

void

 

CheckAllIndices()

Public function

void

 

CheckIndices

(
    int32 TrailIdx
)

Public function

void

 

ClearIndices

(
    int32 TrailIndex,
    int32 ParticleIndex
)

Protected function

UMaterialInt...

 

GetCurrentMaterial()

Get the current material to render with.

Protected function

bool

 

GetParticleInTrail

(
    bool bSkipStartingParticle,
    FBaseParticle* InStartingFromP...,
    FTrailsBaseTypeDataPayload* In...,
    EGetTrailDirection InGetDirection,
    EGetTrailParticleOption InGetOption,
    FBaseParticle*& OutParticle,
    FTrailsBaseTypeDataPayload*& O...
)

Retrieve the particle in the trail that meets the given criteria

Public function

void

 

GetTrailEnd

(
    const int32 TrailIdx,
    int32& OutEndIndex,
    TrailDataType*& OutTrailData,
    FBaseParticle*& OutParticle
)

Public function

void

 

GetTrailStart

(
    const int32 TrailIdx,
    int32& OutStartIndex,
    TrailDataType*& OutTrailData,
    FBaseParticle*& OutParticle
)

Public function Virtual

void

 

KillParticles

(
    int32 InTrailIdx,
    int32 InKillCount
)

Kill the given number of particles from the end of the trail.

Protected function Virtual

void

 

PrintAllActiveParticles()

Prints out info for all active particles.

Protected function Virtual

void

 

PrintParticleData

(
    FBaseParticle* Particle,
    FTrailsBaseTypeDataPayload* Tr...,
    int32 CurrentIndex,
    int32 TrailIndex
)

Prints out info for a single particle.

Protected function Virtual

void

 

PrintTrails()

Traverses all trails and prints out debugging info.

Public function

void

 

SetDeadIndex

(
    int32 TrailIndex,
    int32 ParticleIndex
)

Public function

void

 

SetEndIndex

(
    int32 TrailIndex,
    int32 ParticleIndex
)

Public function

void

 

SetStartIndex

(
    int32 TrailIndex,
    int32 ParticleIndex
)

Public function Virtual

void

 

SetupTrailModules()

Public function Virtual

void

 

Tick_RecalculateTangents

(
    float DeltaTime,
    UParticleLODLevel* CurrentLODL...
)

Tick sub-function that handles recalculation of tangents

Public function Virtual

void

 

UpdateSourceData

(
    float DeltaTime,
    bool bFirstTime
)

Overridden from FParticleEmitterInstance

Name Description

Public function Virtual

void

 

ForceUpdateBoundingBox()

Force the bounding box to be updated.

Public function Virtual

void

 

Init()

Initialize the instance

Public function Virtual

void

 

InitParameters

(
    UParticleEmitter* InTemplate,
    UParticleSystemComponent* InCo...
)

Public function Virtual

void

 

KillParticles()

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

Public function Virtual

void

 

OnDeactivateSystem()

Virtual void UpdateStartParticles(float DeltaTime, bool bFirstTime) {}

Public function Virtual

void

 

Tick

(
    float DeltaTime,
    bool bSuppressSpawning
)

Tick the instance.

Public function Virtual

void

 

UpdateBoundingBox

(
    float DeltaTime
)

Update the bounding box for the emitter

Enums

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback