Navigation
API > API/Plugins > API/Plugins/Niagara
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&40;Config&61;Niagara, PerObjectConfig, MinimalAPI&41;
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 | |
|---|---|---|---|
   |
bool | bAllowCullingForLocalPlayers | Controls whether or not culling is allowed for FX that are owned by, attached to or instigated by a locally controlled pawn. |
 |
uint32: 1 | bNewSystemsSinceLastScalabilityUpdate | Marks that there have been new systems added for this effect type since it's last scalability manager update. |
   |
ENiagaraCullReaction | CullReaction | How effects of this type react when they fail the cull checks. |
   |
FNiagaraEmitterScalabilitySettingsArray | EmitterScalabilitySettings | |
 |
int32 | NumInstances | Total number of instances across all systems for this effect type. |
    |
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. |
   |
FNiagaraSystemScalabilitySettingsArray | SystemScalabilitySettings | |
   |
ENiagaraScalabilityUpdateFrequency | UpdateFrequency | How regularly effects of this type are checked for scalability. |
    |
TArray< TObjectPtr< UNiagaraValidationRule > > | ValidationRules | A set of rules to apply when checking content. |
   |
TArray< TObjectPtr< UNiagaraValidationRuleSet > > | ValidationRuleSets | Array of reusable rule sets to apply when checking content. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UNiagaraEffectType
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | DeclareConstructClasses
(
TArray< FTopLevelAssetPath >& OutConstructClasses, |
|
 |
void | ForEachPlatformSet
(
TAction Func |
Performs the passed action for all FNiagaraPlatformSets in this system. |
  |
void | ||
  |
const FNiagaraEmitterScalabilitySettings & | ||
  |
const FNiagaraSystemScalabilitySettings & | ||
  |
const FNiagaraEmitterScalabilitySettingsArray & | ||
 |
UNiagaraBaselineController * | ||
  |
FNiagaraPerfBaselineStats & | ||
  |
UNiagaraSignificanceHandler * | ||
  |
const FNiagaraSystemScalabilitySettingsArray & | ||
 |
void | ||
  |
bool | ||
  |
FGeneratePerfBaselines & | ||
 |
void | SpawnBaselineActor
(
UWorld* World |
|
 |
void | UpdatePerfBaselineStats
(
FNiagaraPerfBaselineStats& NewBaselineStats |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
Called before destroying the object. |
  |
bool | Called to check if the object is ready for FinishDestroy. | |
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
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 | 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
| Type | Name | Description | |
|---|---|---|---|
  |
TArray< FNiagaraSystemScalabilitySettings > | DetailLevelScalabilitySettings_DEPRECATED | Cull settings to use at each detail level. |