FNCPool

Windows
MacOS
Linux

References

Module

Niagara

Header

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

Include

#include "NiagaraComponentPool.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FNCPool

Variables

Name Description

Public variable UProperty Transient

TArray< FNCPool...

 

FreeElements

Collection of all currently allocated, free items ready to be grabbed for use.

Public variable

TArray< TWeakOb...

 

InUseComponents_Auto

Array of currently in flight components that will auto release.

Public variable

TArray< TWeakOb...

 

InUseComponents_Manual

Array of currently in flight components that need manual release.

Public variable

int32

 

MaxUsed

Keeping track of max in flight systems to help inform any future pre-population we do.

Functions

Name Description

Public function

UNiagaraComp...

 

Acquire

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

Gets a component from the pool ready for use.

Public function

void

 

Cleanup()

Public function

void

 

KillUnusedComponents

(
    float KillTime,
    UNiagaraSystem* Template
)

Kills any components that have not been used since the passed KillTime.

Public function

int32

 

NumComponents()

Public function

void

 

Reclaim

(
    UNiagaraComponent* NC,
    const float CurrentTimeSeconds
)

Returns a component to the pool.

Public function

bool

 

RemoveComponent

(
    UNiagaraComponent* Component
)

Forces us to remove a component, returns true if the component exists inside the pool.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss