FParticleStats

Encapsulates gathered stats for a particular [UParticleSystem](API\Runtime\Engine\Particles\UParticleSystem) object

Windows
MacOS
Linux

Inheritance Hierarchy

FAnalyzeReferencedContentStat::FAssetStatsBase

FAnalyzeReferencedContentStat::FParticleStats

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/Commandlets/AnalyzeReferencedContentStat.h

Include

#include "Commandlets/AnalyzeReferencedContentStat.h"

Syntax

struct FParticleStats : public FAnalyzeReferencedContentStat::FAssetStatsBase

Remarks

Encapsulates gathered stats for a particular UParticleSystem object

Variables

Name Description

Public variable

bool

 

bIsReferencedByScript

Whether resource is referenced by script.

Public variable

bool

 

bMeshEmitterHasCastShadows

If any modules have mesh emitters that have DoCollision == true wich is more than likely bad and perf costing

Public variable

bool

 

bMeshEmitterHasDoCollisions

If any modules have mesh emitters that have DoCollision == true wich is more than likely bad and perf costing

Public variable

int32

 

MaxNumDrawnPerFrame

Maximum number of particles drawn per frame

Public variable

int32

 

NumBytesUsed

This is the size in bytes that this Particle System will use

Public variable

int32

 

NumEmitters

Number of emitters in this system.

Public variable

int32

 

NumEmittersUsingCollision

Combined number of collision modules across emitters

Public variable

int32

 

NumEmittersUsingPhysics

Combined number of emitters that have active physics

Public variable

int32

 

NumModules

Combined number of modules in all emitters used.

Public variable

int32

 

NumPeakActiveParticles

Combined number of peak particles in system.

Public variable

float

 

PeakActiveToMaxDrawnRatio

Ratio of particles simulated to particles drawn

Public variable

FString

 

ResourceName

Resource name.

Public variable

FString

 

ResourceType

Resource type.

Public variable

float

 

WarmUpTime

If the particle system has warm up time greater than N seconds

Constructors

Name Description

Public function

FParticleStats

(
    UParticleSystem* ParticleSyste...
)

Constructor, initializing all members

Functions

Name Description

Public function Static

FString

 

GetCSVHeaderRow()

Returns a header row for CSV

Public function Static

FString

 

GetSummaryCSVHeaderRow()

This is for summary

Public function Const

bool

 

ShouldLogStat()

Public function Const

FString

 

ToCSV()

Stringifies gathered stats in CSV format.

Public function Static

FString

 

ToSummaryCSV

(
    const FString& LevelName,
    const TMap< FString, FParticleStats...
)

This is for summary
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss