UNiagaraComponentPool

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraComponentPool

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraComponentPool.h

Include

#include "NiagaraComponentPool.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient)
class UNiagaraComponentPool : public UObject

Constructors

Name Description

Public function

UNiagaraComponentPool

(
    const FObjectInitializer& ObjectIn...
)

Destructors

Name Description

Public function

~UNiagaraComponentPool()

Functions

Name Description

Public function

void

 

Cleanup

(
    UWorld* World
)

Public function

void

 

ClearPool

(
    UNiagaraSystem* System
)

Clear all free entires of the specified system.

Public function

UNiagaraComp...

 

CreateWorldParticleSystem

(
    UNiagaraSystem* Template,
    UWorld* World,
    ENCPoolMethod PoolingMethod
)

Public function

void

 

Dump()

Dumps the current state of the pool to the log.

Public function Static

bool

 

Enabled()

Public function

void

 

PooledComponentDestroyed

(
    UNiagaraComponent* Component
)

Notification that the component is being destroyed but has relevance to the component pool.

Public function

void

 

PrimePool

(
    UNiagaraSystem* Template,
    UWorld* World
)

Public function

void

 

ReclaimWorldParticleSystem

(
    UNiagaraComponent* Component
)

Called when an in-use particle component is finished and wishes to be returned to the pool.

Public function

void

 

RemoveComponentsBySystem

(
    UNiagaraSystem* System
)

Remove any components that are using this system.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss