1. Epic GamesDeveloper
  3. FNiagaraSystemScalabilitySettings

FNiagaraSystemScalabilitySettings

Scalability settings for Niagara Systems for a particular platform set (unless overridden).

API > API/Plugins > API/Plugins/Niagara

Scalability settings for Niagara Systems for a particular platform set (unless overridden).

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

Syntax

USTRUCT ()  
struct FNiagaraSystemScalabilitySettings

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraSystemScalabilitySettings()

   NiagaraEffectType.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCullByDistance uint32 Controls whether distance culling is enabled. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(InlineEditConditionToggle)
bCullMaxInstanceCount uint32 Controls whether we should cull systems based on how many instances with the same Effect Type are active. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • DisplayName="Cull By Effect Type Instance Count"
  • Meta=(InlineEditConditionToggle)
bCullPerSystemMaxInstanceCount uint32 Controls whether we should cull systems based on how many instances of the system are active. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • DisplayName="Cull By System Instance Count"
  • Meta=(InlineEditConditionToggle)
BudgetScaling FNiagaraGlobalBudgetScaling Settings related to scaling down FX based on the current budget usage. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(DisplayInScalabilityValuesBar)
CullProxyMode ENiagaraCullProxyMode Controls what, if any, proxy will be used in place of culled systems. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(DisplayInScalabilityValuesBar)
MaxDistance float Effects of this type are culled beyond this distance. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(EditCondition="bCullByDistance", DisplayInScalabilityValuesBar)
MaxInstances int32 Effects of this type will be culled when total active instances using this same EffectType exceeds this number. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • DisplayName="Max Effect Type Instances"
  • Meta=(EditCondition="bCullMaxInstanceCount", DisplayInScalabilityValuesBar)
MaxSystemInstances int32 Effects of this type will be culled when total active instances of the same NiagaraSystem exceeds this number. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(EditCondition="bCullPerSystemMaxInstanceCount", DisplayInScalabilityValuesBar)
MaxSystemProxies int32 Limit on the number of proxies that can be used at once per system. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(EditCondition="CullProxyMode != ENiagaraCullProxyMode::None", DisplayInScalabilityValuesBar)
Platforms FNiagaraPlatformSet The platforms on which these settings are active (unless overridden). NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
VisibilityCulling FNiagaraSystemVisibilityCullingSettings Settings controlling how systems are culled by visibility. NiagaraEffectType.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(DisplayInScalabilityValuesBar)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Clear()

   NiagaraEffectType.h  

void PostLoad ( int32 Version
)

   NiagaraEffectType.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bCullByMaxTimeWithoutRender_DEPRECATED uint32 Deprecated visibility culling property. NiagaraEffectType.h  
MaxTimeWithoutRender_DEPRECATED float Depreceated visibiltiy culling property. NiagaraEffectType.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page