UNiagaraEffectType

Contains settings and working data shared among many NiagaraSystems that share some commonality of type.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraEffectType.h

Include

#include "NiagaraEffectType.h"

Syntax

UCLASS(Config=Niagara, PerObjectConfig)
class UNiagaraEffectType : public UObject

Remarks

Contains settings and working data shared among many NiagaraSystems that share some commonality of type. For example ImpactFX vs EnvironmentalFX.

Variables

Name Description

Public variable UProperty Category, EditAnywhere

bool

 

bAllowCullingForLocalPlayers

Controls whether or not culling is allowed for FX that are owned by, attached to or instigated by a locally controlled pawn.

Public variable

uint32: 1

 

bNewSystemsSinceLastScalabilityUpdate

Marks that there have been new systems added for this effect type since it's last scalability manager update.

Public variable UProperty Category, EditAnywhere

ENiagaraCullRea...

 

CullReaction

How effects of this type react when they fail the cull checks.

Public variable UProperty Category, EditAnywhere

FNiagaraEmitter...

 

EmitterScalabilitySettings

Public variable

int32

 

NumInstances

Total number of instances across all systems for this effect type.

Public variable UProperty Category, EditAnywhere instanced

TObjectPtr< UNi...

 

SignificanceHandler

Used to determine the relative significance of FX in the scene which is used in other scalability systems such as instance count culling.

Public variable UProperty Category, EditAnywhere

FNiagaraSystemS...

 

SystemScalabilitySettings

Public variable UProperty Category, EditAnywhere

ENiagaraScalabi...

 

UpdateFrequency

How regularly effects of this type are checked for scalability.

Constructors

Name Description

Public function

UNiagaraEffectType

(
    const FObjectInitializer& ObjectIn...
)

Functions

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

bool

 

IsReadyForFinishDestroy()

Called to check if the object is ready for FinishDestroy.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name

Description

FGeneratePerfBaselines

Constants

Name

Description

CurrentPerfBaselineVersion

The current version for perf baselines.

GeneratePerfBaselinesDelegate

Delegate allowing us to call into editor code to generate performance baselines.

Deprecated Variables

Name Description

Public variable UProperty

TArray< FNiagar...

 

DetailLevelScalabilitySettings_DEPRECATED

Cull settings to use at each detail level.