1. Epic GamesDeveloper
  3. UNiagaraEffectType

UNiagaraEffectType

Contains settings and working data shared among many Niagara systems that share some commonality of type, for example ImpactFX vs EnvironmentalFX.

API > API/Plugins > API/Plugins/Niagara

Contains settings and working data shared among many Niagara systems that share some commonality of type, for example ImpactFX vs EnvironmentalFX. Main usage of effect types is to control scalability settings for a group of effects, setting visibility and cull reactions on a per-platform basis.

Effect types can also be used for validation, checking that the content passes all the configured validation rule sets.

The effect type is set in Niagara systems in the system properties.

   
Name UNiagaraEffectType
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraEffectType.h
Include Path #include "NiagaraEffectType.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraEffectType ( const FObjectInitializer& ObjectInitializer
)

   NiagaraEffectType.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowCullingForLocalPlayers bool Controls whether or not culling is allowed for FX that are owned by, attached to or instigated by a locally controlled pawn. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(DisplayInSystemScalability, ScalabilityBarDisplayName="Local Player Culling")
bNewSystemsSinceLastScalabilityUpdate uint32 Marks that there have been new systems added for this effect type since it's last scalability manager update. NiagaraEffectType.h  
CullReaction ENiagaraCullReaction How effects of this type react when they fail the cull checks. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(DisplayInSystemScalability, ScalabilityBarDisplayName="Reaction")
EmitterScalabilitySettings FNiagaraEmitterScalabilitySettingsArray   NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
NumInstances int32 Total number of instances across all systems for this effect type. NiagaraEffectType.h  
SignificanceHandler TObjectPtr< UNiagaraSignificanceHandler > Used to determine the relative significance of FX in the scene which is used in other scalability systems such as instance count culling. NiagaraEffectType.h
  • EditAnywhere
  • Instanced
  • Category="Scalability"
  • Meta=(DisplayInSystemScalability, DisplayClassDisplayName, ScalabilityBarDisplayName="Significance")
SystemScalabilitySettings FNiagaraSystemScalabilitySettingsArray   NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
UpdateFrequency ENiagaraScalabilityUpdateFrequency How regularly effects of this type are checked for scalability. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(DisplayInSystemScalability, ScalabilityBarDisplayName="Frequency")
ValidationRules TArray< TObjectPtr< UNiagaraValidationRule > > A set of rules to apply when checking content. NiagaraEffectType.h
  • EditAnywhere
  • Category="Validation"
  • Instanced
ValidationRuleSets TArray< TObjectPtr< UNiagaraValidationRuleSet > > Array of reusable rule sets to apply when checking content. NiagaraEffectType.h
  • EditAnywhere
  • Category="Validation"

Protected

Name Type Remarks Include Path Unreal Specifiers
PerfBaselineStats FNiagaraPerfBaselineStats Performance data gathered from the Baseline System. NiagaraEffectType.h
  • Config
PerfBaselineVersion FGuid Version guid at the time these baseline stats were generated. NiagaraEffectType.h
  • Config
PerformanceBaselineController TObjectPtr< UNiagaraBaselineController > Controls generation of performance baseline data for this effect type. NiagaraEffectType.h
  • EditAnywhere
  • Category="Performance"
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ForEachPlatformSet ( TAction Func
)

 Performs the passed action for all FNiagaraPlatformSets in this system. NiagaraEffectType.h  

const FNiagaraEmitterScalabilitySettings & GetActiveEmitterScalabilitySettings()

   NiagaraEffectType.h  

const FNiagaraSystemScalabilitySettings & GetActiveSystemScalabilitySettings()

   NiagaraEffectType.h  

const FNiagaraEmitterScalabilitySettingsArray & GetEmitterScalabilitySettings()

   NiagaraEffectType.h  

UNiagaraSignificanceHandler * GetSignificanceHandler()

   NiagaraEffectType.h  

const FNiagaraSystemScalabilitySettingsArray & GetSystemScalabilitySettings()

   NiagaraEffectType.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   NiagaraEffectType.h  

virtual bool IsReadyForFinishDestroy()

   NiagaraEffectType.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraEffectType.h  

virtual void PostLoad()

   NiagaraEffectType.h  

virtual void Serialize ( FArchive& Ar
)

   NiagaraEffectType.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

   NiagaraEffectType.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DetailLevelScalabilitySettings_DEPRECATED TArray< FNiagaraSystemScalabilitySettings > Cull settings to use at each detail level. NiagaraEffectType.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page