Navigation
API > API/Plugins > API/Plugins/Niagara
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&40;Transient, MinimalAPI&41;
class UNiagaraComponentPool : public UObject
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TArray< TWeakObjectPtr< UNiagaraComponent > > | InUseComponents_Auto | Array of currently in flight components that will auto release. |
 |
TArray< TWeakObjectPtr< UNiagaraComponent > > | InUseComponents_Manual | Array of currently in flight components that need manual release. |
 |
int32 | MaxUsed | Keeping track of max in flight systems to help inform any future pre-population we do. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UNiagaraComponentPool
(
const FObjectInitializer& ObjectInitializer |
Destructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | ||
 |
void | ClearPool
(
UNiagaraSystem* System |
Clear all free entires of the specified system. |
 |
UNiagaraComponent * | CreateWorldParticleSystem
(
UNiagaraSystem* Template, |
|
 |
void | Dump () |
Dumps the current state of the pool to the log. |
  |
bool | Enabled () |
|
 |
void | PooledComponentDestroyed
(
UNiagaraComponent* Component |
Notification that the component is being destroyed but has relevance to the component pool. |
 |
void | PrimePool
(
UNiagaraSystem* Template, |
|
 |
void | ReclaimWorldParticleSystem
(
UNiagaraComponent* Component |
Called when an in-use particle component is finished and wishes to be returned to the pool. |
 |
void | RemoveComponentsBySystem
(
UNiagaraSystem* System |
Remove any components that are using this system. |