Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > UNiagaraEffectType

Light Theme

Dark Theme

UNiagaraEffectType

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraEffectType

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraEffectType.h
Include	#include "NiagaraEffectType.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(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
uint32: 1	bNewSystemsSinceLastScalabilityUpdate	Marks that there have been new systems added for this effect type since it's last scalability manager update.
ENiagaraCullRea...	CullReaction	How effects of this type react when they fail the cull checks.
FNiagaraEmitter...	EmitterScalabilitySettings
int32	NumInstances	Total number of instances across all systems for this effect type.
UNiagaraSignifi...	SignificanceHandler	Used to determine the relative significance of FX in the scene which is used in other scalability systems such as instance count culling.
FNiagaraSystemS...	SystemScalabilitySettings
ENiagaraScalabi...	UpdateFrequency	How regularly effects of this type are checked for scalability.

Constructors

	Name	Description
	UNiagaraEffectType ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	GeneratePerfBaselines()
const FNiaga...	GetActiveEmitterScalabilitySettings()
const FNiaga...	GetActiveSystemScalabilitySettings()
const FNiaga...	GetEmitterScalabilitySettings()
UNiagaraBase...	GetPerfBaselineController()
FNiagaraPerf...	GetPerfBaselineStats()
UNiagaraSign...	GetSignificanceHandler()
const FNiaga...	GetSystemScalabilitySettings()	TODO: Dynamic budgetting from perf data.
void	InvalidatePerfBaseline()
bool	IsPerfBaselineValid()
FGeneratePer...	OnGeneratePerfBaselines()
void	SpawnBaselineActor ( UWorld* World )
void	UpdatePerfBaselineStats ( FNiagaraPerfBaselineStats& NewBase... )

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
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
	TArray< FNiagar...	DetailLevelScalabilitySettings_DEPRECATED	Cull settings to use at each detail level.

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

Take our survey

Dismiss