UNiagaraEffectType

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

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS (Config=Niagara, PerObjectConfig, MinimalAPI)  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta 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, Meta ENiagaraCullReaction CullReaction How effects of this type react when they fail the cull checks.
Public variable UProperty Category, EditAnywhere FNiagaraEmitterScalabilitySettingsArray EmitterScalabilitySettings  
Public variable int32 NumInstances Total number of instances across all systems for this effect type.
Public variable UProperty Category, EditAnywhere, Meta instanced TObjectPtr< UNiagaraSignificanceHandler > 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 FNiagaraSystemScalabilitySettingsArray SystemScalabilitySettings  
Public variable UProperty Category, EditAnywhere, Meta ENiagaraScalabilityUpdateFrequency UpdateFrequency How regularly effects of this type are checked for scalability.
Public variable UProperty Category, EditAnywhere instanced TArray< TObjectPtr< UNiagaraValidationRule > > ValidationRules A set of rules to apply when checking content.
Public variable UProperty Category, EditAnywhere TArray< TObjectPtr< UNiagaraValidationRuleSet > > ValidationRuleSets Array of reusable rule sets to apply when checking content.

Constructors

  Type Name Description
Public function  

UNiagaraEffectType ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void

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

  
Public function void

ForEachPlatformSet ( TAction Func
)

 Performs the passed action for all FNiagaraPlatformSets in this system.
Public function Const const FNiagaraEmitterScalabilitySettings &  
Public function Const const FNiagaraSystemScalabilitySettings &  
Public function Const const FNiagaraEmitterScalabilitySettingsArray &  
Public function Const UNiagaraSignificanceHandler *  
Public function Const const FNiagaraSystemScalabilitySettingsArray &  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual bool Called to check if the object is ready for FinishDestroy.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable UProperty TArray< FNiagaraSystemScalabilitySettings > DetailLevelScalabilitySettings_DEPRECATED Cull settings to use at each detail level.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page