Navigation
API > API/Plugins > API/Plugins/Niagara
Manager class for any data relating to a particular world.
| Name | FNiagaraWorldManager |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraWorldManager.h |
| Include Path | #include "NiagaraWorldManager.h" |
Syntax
class FNiagaraWorldManager : public FGCObject
Inheritance Hierarchy
- FGCObject → FNiagaraWorldManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNiagaraWorldManager() |
NiagaraWorldManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FNiagaraWorldManager() |
NiagaraWorldManager.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FSystemDelegateMap | TMap< TWeakObjectPtr< UNiagaraSystem >, FDelegateHandle > | NiagaraWorldManager.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| bInvalidateCachedSystemScalabilityData | std::atomic< bool > | NiagaraWorldManager.h | |
| OnPostWorldCleanupHandle | FDelegateHandle | NiagaraWorldManager.h | |
| OnPostWorldInitHandle | FDelegateHandle | NiagaraWorldManager.h | |
| OnPreWorldFinishDestroyHandle | FDelegateHandle | NiagaraWorldManager.h | |
| OnWorldBeginTearDownHandle | FDelegateHandle | NiagaraWorldManager.h | |
| OnWorldCleanupHandle | FDelegateHandle | NiagaraWorldManager.h | |
| OnWorldInitHandle | FDelegateHandle | NiagaraWorldManager.h | |
| OnWorldPreActorTickHandle | FDelegateHandle | NiagaraWorldManager.h | |
| OnWorldPreSendAllEndOfFrameUpdatesHandle | FDelegateHandle | NiagaraWorldManager.h | |
| PostGCHandle | FDelegateHandle | NiagaraWorldManager.h | |
| PostReachabilityAnalysisHandle | FDelegateHandle | NiagaraWorldManager.h | |
| PreGCBeginDestroyHandle | FDelegateHandle | NiagaraWorldManager.h | |
| PreGCHandle | FDelegateHandle | NiagaraWorldManager.h | |
| ScalabilityCullingMode | ENiagaraScalabilityCullingMode | A global flag for all scalability culling | NiagaraWorldManager.h |
| TickWorldEndHandle | FDelegateHandle | NiagaraWorldManager.h | |
| TickWorldHandle | FDelegateHandle | NiagaraWorldManager.h | |
| TickWorldStartHandle | FDelegateHandle | NiagaraWorldManager.h | |
| ViewTargetChangedHandle | FDelegateHandle | NiagaraWorldManager.h | |
| WorldManagers | TMap< class UWorld *, class FNiagaraWorldManager * > | NiagaraWorldManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveNiagaraTickGroup | int | NiagaraWorldManager.h | ||
| bAppHasFocus | bool | True if the app has focus. | NiagaraWorldManager.h | |
| bIsCleaningUp | bool | True if OnWorldCleanup has been called, will get reset with Init() | NiagaraWorldManager.h | |
| bIsTearingDown | bool | NiagaraWorldManager.h | ||
| bPoolIsPrimed | bool | NiagaraWorldManager.h | ||
| bScalabilityManagersLocked | bool | NiagaraWorldManager.h | ||
| bUseTickPasses | bool | NiagaraWorldManager.h | ||
| CachedViewInfo | TArray< FNiagaraCachedViewInfo, TInlineAllocator< 8 > > | NiagaraWorldManager.h | ||
| ComponentLeakDetector | TUniquePtr< class FNiagaraComponentLeakDetector > | NiagaraWorldManager.h | ||
| ComponentPool | TObjectPtr< UNiagaraComponentPool > | NiagaraWorldManager.h | ||
| CullProxyMap | TMap< TObjectPtr< UNiagaraSystem >, TObjectPtr< UNiagaraCullProxyComponent > > | NiagaraWorldManager.h | ||
| DataChannelManager | TUniquePtr< FNiagaraDataChannelManager > | NiagaraWorldManager.h | ||
| DebugPlaybackMode | ENiagaraDebugPlaybackMode | NiagaraWorldManager.h | ||
| DebugPlaybackRate | float | NiagaraWorldManager.h | ||
| DeferredDeletionQueue | TArray< FNiagaraSystemInstancePtr > | Instances that have been queued for deletion this frame, serviced in PostActorTick | NiagaraWorldManager.h | |
| DeferredMethods | FNiagaraDeferredMethodQueue | NiagaraWorldManager.h | ||
| DIGeneratedData | TMap< FNDI_GeneratedData::TypeHash, TUniquePtr< FNDI_GeneratedData > > | NiagaraWorldManager.h | ||
| LastRenderThreadUpdateTime | TSharedPtr< std::atomic< float > > | NiagaraWorldManager.h | ||
| ObjectPool | TUniquePtr< FNiagaraSimpleObjectPool > | NiagaraWorldManager.h | ||
| ParameterCollections | TMap< TObjectPtr< UNiagaraParameterCollection >, TObjectPtr< UNiagaraParameterCollectionInstance > > | NiagaraWorldManager.h | ||
| ReferencedObjects | TArray< TObjectPtr< UObject > > | NiagaraWorldManager.h | ||
| RenderThreadWorldTimeLag | float | NiagaraWorldManager.h | ||
| RequestedDebugPlaybackMode | ENiagaraDebugPlaybackMode | NiagaraWorldManager.h | ||
| ScalabilityManagers | TMap< TObjectPtr< UNiagaraEffectType >, FNiagaraScalabilityManager > | NiagaraWorldManager.h | ||
| SimulationsWithEndOfFrameWait | TArray< FNiagaraSystemSimulationRef > | NiagaraWorldManager.h | ||
| SimulationsWithPostActorWork | TArray< FNiagaraSystemSimulationRef > | NiagaraWorldManager.h | ||
| SystemPostChangeDelegateHandles | FSystemDelegateMap | NiagaraWorldManager.h | ||
| SystemSimulations | TMap< UNiagaraSystem *, FNiagaraSystemSimulationRef > | NiagaraWorldManager.h | ||
| TickFunctions | FNiagaraWorldManagerTickFunction | NiagaraWorldManager.h | ||
| World | UWorld * | NiagaraWorldManager.h | ||
| WorldLoopTime | float | NiagaraWorldManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddReferencedObject
(
UObject* InObject |
Objects added here will have a strong reference held. | NiagaraWorldManager.h | |
void CalculateScalabilityState
(
UNiagaraSystem* System, |
NiagaraWorldManager.h | ||
void CalculateScalabilityState
(
UNiagaraSystem* System, |
NiagaraWorldManager.h | ||
void CleanupParameterCollections() |
NiagaraWorldManager.h | ||
void DestroyCullProxy
(
UNiagaraSystem* System |
NiagaraWorldManager.h | ||
void DestroySystemInstance
(
FNiagaraSystemInstancePtr& InPtr |
NiagaraWorldManager.h | ||
void DestroySystemSimulation
(
UNiagaraSystem* System |
NiagaraWorldManager.h | ||
void DumpDetails
(
FOutputDevice& Ar, |
Dump details about what's inside the world manager. | NiagaraWorldManager.h | |
void DumpScalabilityState() |
NiagaraWorldManager.h | ||
T & EditGeneratedData() |
NiagaraWorldManager.h | ||
UNiagaraDataChannelHandler * FindDataChannelHandler
(
const UNiagaraDataChannel* Channel |
NiagaraWorldManager.h | ||
void FlushComputeAndDeferredQueues
(
bool bWaitForGPU |
Flush the compute simulation queue and any deferred actions. | NiagaraWorldManager.h | |
void ForAllSystemSimulations
(
TAction Func |
NiagaraWorldManager.h | ||
TArrayView< const FNiagaraCachedViewInfo > GetCachedViewInfo() |
NiagaraWorldManager.h | ||
UNiagaraComponentPool * GetComponentPool() |
NiagaraWorldManager.h | ||
UNiagaraCullProxyComponent * GetCullProxy
(
UNiagaraComponent* Component |
NiagaraWorldManager.h | ||
FNiagaraDataChannelManager & GetDataChannelManager() |
NiagaraWorldManager.h | ||
ENiagaraDebugPlaybackMode GetDebugPlaybackMode() |
NiagaraWorldManager.h | ||
float GetDebugPlaybackRate() |
NiagaraWorldManager.h | ||
FNiagaraDeferredMethodQueue & GetDeferredMethodQueue() |
NiagaraWorldManager.h | ||
FVector::FReal GetLODDistance
(
FVector Location |
Returns the distance to the nearest viewpoint to the give location. Used for a distance on which to base LODs. | NiagaraWorldManager.h | |
FVector::FReal GetLODDistance
(
FVector Location, |
NiagaraWorldManager.h | ||
UNiagaraParameterCollectionInstance * GetParameterCollection
(
UNiagaraParameterCollection* Collection |
NiagaraWorldManager.h | ||
FNiagaraSystemSimulationRef GetSystemSimulation
(
ETickingGroup TickGroup, |
NiagaraWorldManager.h | ||
| NiagaraWorldManager.h | |||
| NiagaraWorldManager.h | |||
void Init
(
UWorld* InWorld |
NiagaraWorldManager.h | ||
void InitDataChannel
(
const UNiagaraDataChannel* Channel, |
NiagaraWorldManager.h | ||
void LegacyOnPostWorldCleanup
(
bool bSessionEnded, |
NiagaraWorldManager.h | ||
void LegacyOnWorldBeginTearDown() |
TODO: Remove - UE-347574. | NiagaraWorldManager.h | |
void LegacyOnWorldCleanup
(
bool bSessionEnded, |
NiagaraWorldManager.h | ||
void MarkSimulationForPostActorWork
(
FNiagaraSystemSimulation* SystemSimulation |
NiagaraWorldManager.h | ||
void MarkSimulationsForEndOfFrameWait
(
FNiagaraSystemSimulation* SystemSimulation |
NiagaraWorldManager.h | ||
T * ObjectPoolGetOrCreate
(
bool& bIsExistingObject |
NiagaraWorldManager.h | ||
UObject * ObjectPoolGetOrCreate
(
UClass* Class, |
Will create a new object or return one from the pool. | NiagaraWorldManager.h | |
UObject * ObjectPoolGetOrCreate
(
UClass* Class |
NiagaraWorldManager.h | ||
T * ObjectPoolGetOrCreate () |
NiagaraWorldManager.h | ||
void ObjectPoolReturn
(
UObject* Obj |
Returns an object to the pool You are expected to do any unregistering of the component and ensuring no references are held. | NiagaraWorldManager.h | |
void OnPostWorldCleanup
(
bool bSessionEnded, |
NiagaraWorldManager.h | ||
void OnPostWorldInit () |
NiagaraWorldManager.h | ||
void OnSystemPostChange
(
UNiagaraSystem* System |
NiagaraWorldManager.h | ||
void OnWorldBeginTearDown () |
NiagaraWorldManager.h | ||
void OnWorldCleanup
(
bool bSessionEnded, |
NiagaraWorldManager.h | ||
void PostActorTick
(
float DeltaSeconds |
Called after all actor tick groups are complete. | NiagaraWorldManager.h | |
void PostGarbageCollect() |
NiagaraWorldManager.h | ||
void PostReachabilityAnalysis() |
NiagaraWorldManager.h | ||
void PreActorTick
(
ELevelTick InLevelTick, |
NiagaraWorldManager.h | ||
void PreGarbageCollect() |
NiagaraWorldManager.h | ||
void PreGarbageCollectBeginDestroy() |
NiagaraWorldManager.h | ||
void PreSendAllEndOfFrameUpdates() |
Called before we run end of frame updates, allows us to wait on async work. | NiagaraWorldManager.h | |
void PrimePool
(
UNiagaraSystem* System |
NiagaraWorldManager.h | ||
void PrimePoolForAllSystems() |
NiagaraWorldManager.h | ||
const T & ReadGeneratedData() |
NiagaraWorldManager.h | ||
void RefreshOwnerAllowsScalability() |
NiagaraWorldManager.h | ||
void RegisterWithScalabilityManager
(
UNiagaraComponent* Component, |
NiagaraWorldManager.h | ||
void RemoveDataChannel
(
const UNiagaraDataChannel* Channel |
NiagaraWorldManager.h | ||
void RemoveReferencedObject
(
UObject* InObject |
Removes an object from the WM references. | NiagaraWorldManager.h | |
void SetDebugPlaybackMode
(
ENiagaraDebugPlaybackMode Mode |
NiagaraWorldManager.h | ||
void SetDebugPlaybackRate
(
float Rate |
NiagaraWorldManager.h | ||
void SetTickGroupPriority
(
const int32 NiagaraTickGroupIndex, |
NiagaraWorldManager.h | ||
bool ShouldPreCull
(
UNiagaraSystem* System, |
NiagaraWorldManager.h | ||
bool ShouldPreCull
(
UNiagaraSystem* System, |
Should we cull an instance of this system at the passed location before it's even been spawned? | NiagaraWorldManager.h | |
void SortedSignificanceCull
(
UNiagaraEffectType* EffectType, |
NiagaraWorldManager.h | ||
void Tick
(
ENiagaraWorldManagerTickPass TickPass, |
NiagaraWorldManager.h | ||
void TickEnd
(
float DeltaSeconds |
Called at the very end of world ticking, even when paused. | NiagaraWorldManager.h | |
void TickStart
(
float DeltaSeconds |
Called at the very beginning of world ticking, even when paused. | NiagaraWorldManager.h | |
void UnregisterWithScalabilityManager
(
UNiagaraComponent* Component, |
NiagaraWorldManager.h | ||
void UpdateScalabilityManagers
(
float DeltaSeconds, |
NiagaraWorldManager.h | ||
bool UseTickPasses() |
NiagaraWorldManager.h | ||
void WaitForAsyncWork() |
Waits for all currently in flight async work to be completed. | NiagaraWorldManager.h |
Overridden from FGCObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
NiagaraWorldManager.h | ||
virtual FString GetReferencerName() |
NiagaraWorldManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void DestroyAllSystemSimulations
(
UNiagaraSystem* System |
NiagaraWorldManager.h | ||
static void EnqueueGlobalDeferredCallback
(
TFunction< void()>&& Callback |
This is a threadsafe queue which will execute on the game thread. | NiagaraWorldManager.h | |
static void ForAllWorldManagers
(
TAction Func |
NiagaraWorldManager.h | ||
static FNiagaraWorldManager * Get
(
const UWorld* World |
NiagaraWorldManager.h | ||
static ENiagaraScalabilityCullingMode GetScalabilityCullingMode() |
NiagaraWorldManager.h | ||
static void InvalidateCachedSystemScalabilityDataForAllWorlds() |
NiagaraWorldManager.h | ||
static bool IsComponentLocalPlayerLinked
(
const USceneComponent* Component |
Is this component in anyway linked to the local player. | NiagaraWorldManager.h | |
static void OnComputeDispatchInterfaceDestroyed
(
FNiagaraGpuComputeDispatchInterface* InComputeDispatchInterface |
Gamethread callback to cleanup references to the given ComputeDispatchInterface before it gets deleted on the renderthread. | NiagaraWorldManager.h | |
static void OnPostGarbageCollect() |
Callback to handle any post GC processing needed. | NiagaraWorldManager.h | |
static void OnPostReachabilityAnalysis() |
Callback post reachability. | NiagaraWorldManager.h | |
static void OnPostWorldCleanup
(
UWorld* World, |
Callback function registered with global world delegates to cleanup world manager contentx. | NiagaraWorldManager.h | |
static void OnPostWorldInit
(
UWorld* World, |
Callback function registered with global world delegates to instantiate world manager after a game world is initialized. | NiagaraWorldManager.h | |
static void OnPreGarbageCollect() |
Callback to handle any pre GC processing needed. | NiagaraWorldManager.h | |
static void OnPreGarbageCollectBeginDestroy() |
Callback to handle any pre GC processing needed. | NiagaraWorldManager.h | |
static void OnPreWorldFinishDestroy
(
UWorld* World |
Callback function registered with global world delegates to cleanup world manager when a game world is destroyed. | NiagaraWorldManager.h | |
static void OnRefreshOwnerAllowsScalability() |
NiagaraWorldManager.h | ||
static void OnShutdown() |
NiagaraWorldManager.h | ||
static void OnStartup() |
NiagaraWorldManager.h | ||
static void OnWorldBeginTearDown
(
UWorld* World |
Called when the world begins to be torn down for example by level streaming. | NiagaraWorldManager.h | |
static void OnWorldCleanup
(
UWorld* World, |
Callback function registered with global world delegates to cleanup world manager contents. | NiagaraWorldManager.h | |
static void OnWorldInit
(
UWorld* World, |
Callback function registered with global world delegates to instantiate world manager when a game world is created. | NiagaraWorldManager.h | |
static void OnWorldPreActorTick
(
UWorld* InWorld, |
NiagaraWorldManager.h | ||
static bool PrepareCachedViewInfo
(
const APlayerController* PlayerController, |
Calculates ViewInfo data for player. | NiagaraWorldManager.h | |
static void PrimePoolForAllWorlds
(
UNiagaraSystem* System |
NiagaraWorldManager.h | ||
static void RequestInvalidateCachedSystemScalabilityDataForAllWorlds() |
NiagaraWorldManager.h | ||
static void SetScalabilityCullingMode
(
ENiagaraScalabilityCullingMode NewMode |
NiagaraWorldManager.h | ||
static void TickWorld
(
UWorld* World, |
Callback for when a world is ticked. | NiagaraWorldManager.h | |
static void TickWorldEnd
(
UWorld* World, |
Callback for when a world tick is ended. | NiagaraWorldManager.h | |
static void TickWorldStart
(
UWorld* World, |
Callback for when a world tick is begun. | NiagaraWorldManager.h |