Navigation
API > API/Plugins > API/Plugins/Niagara
| Name | UNiagaraComponentPool |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraComponentPool.h |
| Include Path | #include "NiagaraComponentPool.h" |
Syntax
UCLASS (Transient, MinimalAPI)
class UNiagaraComponentPool : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNiagaraComponentPool
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNiagaraComponentPool
(
const FObjectInitializer& ObjectInitializer |
NiagaraComponentPool.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~UNiagaraComponentPool() |
NiagaraComponentPool.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InUseComponents_Auto | TArray< TWeakObjectPtr< UNiagaraComponent > > | Array of currently in flight components that will auto release. | NiagaraComponentPool.h | |
| InUseComponents_Manual | TArray< TWeakObjectPtr< UNiagaraComponent > > | Array of currently in flight components that need manual release. | NiagaraComponentPool.h | |
| MaxUsed | int32 | Keeping track of max in flight systems to help inform any future pre-population we do. | NiagaraComponentPool.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LastParticleSytemPoolCleanTime | double | NiagaraComponentPool.h | ||
| WorldParticleSystemPools | TMap< TObjectPtr< UNiagaraSystem >, FNCPool > | NiagaraComponentPool.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Cleanup
(
UWorld* World |
NiagaraComponentPool.h | ||
void ClearPool
(
UNiagaraSystem* System |
Clear all free entires of the specified system. | NiagaraComponentPool.h | |
UNiagaraComponent * CreateWorldParticleSystem
(
UNiagaraSystem* Template, |
NiagaraComponentPool.h | ||
void Dump() |
Dumps the current state of the pool to the log. | NiagaraComponentPool.h | |
void PooledComponentDestroyed
(
UNiagaraComponent* Component |
Notification that the component is being destroyed but has relevance to the component pool. | NiagaraComponentPool.h | |
void PrimePool
(
UNiagaraSystem* Template, |
NiagaraComponentPool.h | ||
void ReclaimWorldParticleSystem
(
UNiagaraComponent* Component |
Called when an in-use particle component is finished and wishes to be returned to the pool. | NiagaraComponentPool.h | |
void RemoveComponentsBySystem
(
UNiagaraSystem* System |
Remove any components that are using this system. | NiagaraComponentPool.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool Enabled() |
NiagaraComponentPool.h |