Navigation
API > API/Runtime > API/Runtime/Engine
Main manager class for particle systems in the world.
| Name | FParticleSystemWorldManager |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Particles/ParticleSystemManager.h |
| Include Path | #include "Particles/ParticleSystemManager.h" |
Syntax
class FParticleSystemWorldManager : public FGCObject
Inheritance Hierarchy
- FGCObject → FParticleSystemWorldManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FParticleSystemWorldManager
(
UWorld* InWorld |
Particles/ParticleSystemManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FParticleSystemWorldManager() |
Particles/ParticleSystemManager.h |
Structs
| Name | Remarks |
|---|---|
| FTickList |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FPSCTickListFunction | TFunction< void(UParticleSystemComponent *, FPSCTickData &, int32)> | Particles/ParticleSystemManager.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MaxTickGroup | const int32 | Particles/ParticleSystemManager.h | |
| TickGroupEnum | const UEnum * | Particles/ParticleSystemManager.h | |
| WorldManagers | TMap< UWorld *, FParticleSystemWorldManager * > | Particles/ParticleSystemManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AsyncTickBatch | FPSCManagerAsyncTickBatch | Particles/ParticleSystemManager.h | ||
| bCachedParticleWorldManagerEnabled | int32 | Cached value of r.EnablePSCWorldManager. Allows us to reset all systems when this changes. | Particles/ParticleSystemManager.h | |
| ManagedPSCs | TArray< TObjectPtr< UParticleSystemComponent > > | Particles/ParticleSystemManager.h | ||
| PendingRegisterPSCs | TArray< TObjectPtr< UParticleSystemComponent > > | PSCs that have been registered with the manager but have not yet been processed into the appropriate buffers. | Particles/ParticleSystemManager.h | |
| PostGarbageCollectHandle | FDelegateHandle | Callback to remove and PSCs that the GC frees. | Particles/ParticleSystemManager.h | |
| PSCTickData | TArray< FPSCTickData > | Particles/ParticleSystemManager.h | ||
| TickFunctions | TArray< FParticleSystemWorldManagerTickFunction > | Particles/ParticleSystemManager.h | ||
| TickLists_Concurrent | TArray< FTickList > | Array of PSCs to tick per tick group. These can have their concurrent ticks done in parallel | Particles/ParticleSystemManager.h | |
| TickLists_GT | TArray< FTickList > | Array of PSCs to tick per tick group. These must be done entirely on the GT. | Particles/ParticleSystemManager.h | |
| World | UWorld * | Particles/ParticleSystemManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Cleanup() |
Particles/ParticleSystemManager.h | ||
void Dump() |
Particles/ParticleSystemManager.h | ||
UParticleSystemComponent * GetManagedComponent
(
int32 Handle |
Particles/ParticleSystemManager.h | ||
FPSCTickData & GetTickData
(
int32 Handle |
Particles/ParticleSystemManager.h | ||
bool RegisterComponent
(
UParticleSystemComponent* PSC |
Particles/ParticleSystemManager.h | ||
void SetTickGroupPriority
(
const int32 ParticleSystemTickGroupIndex, |
Particles/ParticleSystemManager.h | ||
void Tick
(
ETickingGroup TickGroup, |
Particles/ParticleSystemManager.h | ||
void UnregisterComponent
(
UParticleSystemComponent* PSC |
Particles/ParticleSystemManager.h |
Overridden from FGCObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
Particles/ParticleSystemManager.h | ||
virtual FString GetReferencerName() |
Particles/ParticleSystemManager.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void HandlePostGarbageCollect() |
Clean up dead components post GC | Particles/ParticleSystemManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FParticleSystemWorldManager * Get
(
UWorld* World |
Particles/ParticleSystemManager.h | ||
static void OnPreWorldFinishDestroy
(
UWorld* World |
Particles/ParticleSystemManager.h | ||
static void OnShutdown() |
Particles/ParticleSystemManager.h | ||
static void OnStartup() |
Particles/ParticleSystemManager.h | ||
static void OnWorldBeginTearDown
(
UWorld* World |
Particles/ParticleSystemManager.h | ||
static void OnWorldCleanup
(
UWorld* World, |
Particles/ParticleSystemManager.h | ||
static void OnWorldInit
(
UWorld* World, |
Particles/ParticleSystemManager.h | ||
static void SetFirstHighPriTickGroup
(
int FirstHighPriTickGroupIndex |
Particles/ParticleSystemManager.h |