FNiagaraWorldManager

Manager class for any data relating to a particular world.

Windows
MacOS
Linux

Inheritance Hierarchy

FGCObject

FNiagaraWorldManager

References

Module

Niagara

Header

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

Include

#include "NiagaraWorldManager.h"

Syntax

class FNiagaraWorldManager : public FGCObject

Remarks

Manager class for any data relating to a particular world.

Constructors

Name Description

Public function

FNiagaraWorldManager()

Destructors

Name Description

Public function

~FNiagaraWorldManager()

Functions

Name Description

Public function Const

bool

 

CachedPlayerViewLocationsValid()

Public function

void

 

CalculateScalabilityState

(
    UNiagaraSystem* System,
    const FNiagaraSystemScalabilitySett...,
    UNiagaraEffectType* EffectType,
    FVector Location,
    bool bIsPreCull,
    float WorstGlobalBudgetUse,
    FNiagaraScalabilityState& OutState
)

Public function

void

 

CalculateScalabilityState

(
    UNiagaraSystem* System,
    const FNiagaraSystemScalabilitySett...,
    UNiagaraEffectType* EffectType,
    UNiagaraComponent* Component,
    bool bIsPreCull,
    float WorstGlobalBudgetUse,
    FNiagaraScalabilityState& OutState
)

Public function

void

 

CleanupParameterCollections()

Public function Static

void

 

DestroyAllSystemSimulations

(
    UNiagaraSystem* System
)

Public function

void

 

DestroySystemInstance

(
    TUniquePtr< FNiagaraSystemInstance ...
)

Public function

void

 

DestroySystemSimulation

(
    UNiagaraSystem* System
)

Public function

void

 

DumpDetails

(
    FOutputDevice& Ar
)

Dump details about what's inside the world manager.

Public function

void

 

DumpScalabilityState()

Public function

T &

 

EditGeneratedData()

Public function

void

 

ForAllSystemSimulations

(
    TAction Func
)

Public function Static

void

 

ForAllWorldManagers

(
    TAction Func
)

Public function Static

FNiagaraWorl...

 

Get

(
    const UWorld* World
)

Public function Const

TArrayView< ...

 

GetCachedPlayerViewLocations()

Public function

UNiagaraComp...

 

GetComponentPool()

Public function Const

ENiagaraDebu...

 

GetDebugPlaybackMode()

Public function Const

float

 

GetDebugPlaybackRate()

Public function

FNiagaraDebu...

 

GetNiagaraDebugHud()

Public function

UNiagaraPara...

 

GetParameterCollection

(
    UNiagaraParameterCollection* C...
)

Public function

TSharedRef< ...

 

GetSystemSimulation

(
    ETickingGroup TickGroup,
    UNiagaraSystem* System
)

Public function Const

UWorld *

 

GetWorld()

Public function

UWorld *

 

GetWorld()

Public function

void

 

Init

(
    UWorld* InWorld
)

Public function

void

 

MarkSimulationForPostActorWork

(
    FNiagaraSystemSimulation* Syst...
)

Public function Static

void

 

OnBatcherDestroyed

(
    NiagaraEmitterInstanceBatcher*...
)

Gamethread callback to cleanup references to the given batcher before it gets deleted on the renderthread.

Public function

void

 

OnPostWorldCleanup

(
    bool bSessionEnded,
    bool bCleanupResources
)

Public function Static

void

 

OnShutdown()

Public function Static

void

 

OnStartup()

Public function

void

 

OnWorldCleanup

(
    bool bSessionEnded,
    bool bCleanupResources
)

Public function

void

 

PostActorTick

(
    float DeltaSeconds
)

Called after all actor tick groups are complete.

Public function

void

 

PostGarbageCollect()

Public function

void

 

PostReachabilityAnalysis()

Public function

void

 

PreGarbageCollect()

Public function

void

 

PreGarbageCollectBeginDestroy()

Public function

void

 

PreSendAllEndOfFrameUpdates()

Called before we run end of frame updates, allows us to wait on async work.

Public function

void

 

PrimePool

(
    UNiagaraSystem* System
)

Public function

void

 

PrimePoolForAllSystems()

Public function Static

void

 

PrimePoolForAllWorlds

(
    UNiagaraSystem* System
)

Public function

const T &

 

ReadGeneratedData()

Public function

void

 

RegisterWithScalabilityManager

(
    UNiagaraComponent* Component
)

Public function

void

 

SetDebugPlaybackMode

(
    ENiagaraDebugPlaybackMode Mode
)

Public function

void

 

SetDebugPlaybackRate

(
    float Rate
)

Public function

bool

 

ShouldPreCull

(
    UNiagaraSystem* System,
    UNiagaraComponent* Component
)

Should we cull an instance of this system at the passed location before it's even been spawned?

Public function

bool

 

ShouldPreCull

(
    UNiagaraSystem* System,
    FVector Location
)

Should we cull an instance of this system at the passed location before it's even been spawned?

Public function

void

 

SortedSignificanceCull

(
    UNiagaraEffectType* EffectType,
    const FNiagaraSystemScalabilitySett...,
    float Significance,
    int32& EffectTypeInstCount,
    int32& SystemInstCount,
    FNiagaraScalabilityState& OutState
)

Public function

void

 

Tick

(
    ETickingGroup TickGroup,
    float DeltaSeconds,
    ELevelTick TickType,
    ENamedThreads::Type CurrentThread,
    const FGraphEventRef& MyCompletion...
)

Public function

void

 

UnregisterWithScalabilityManager

(
    UNiagaraComponent* Component
)

Public function

void

 

UpdateScalabilityManagers

(
    float DeltaSeconds,
    bool bNewSpawnsOnly
)

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Pure virtual that must be overloaded by the inheriting class.

Public function Virtual Const

FString

 

GetReferencerName()

Use this method to report a name for your referencer.

Constants

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss