1. Epic GamesDeveloper
  3. FNiagaraEmitterHandle

FNiagaraEmitterHandle

Stores emitter information within the context of a System.

API > API/Plugins > API/Plugins/Niagara

Stores emitter information within the context of a System.

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

Syntax

USTRUCT ()  
struct FNiagaraEmitterHandle

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraEmitterHandle ( UNiagaraStatelessEmitter& InEmitter
)

   NiagaraEmitterHandle.h  

FNiagaraEmitterHandle ( UNiagaraEmitter& InEmitter,
const FGuid& Version
)

 Creates a new emitter handle from an emitter. NiagaraEmitterHandle.h  
Creates a new emitter handle from an emitter. NiagaraEmitterHandle.h  
Creates a new invalid emitter handle. NiagaraEmitterHandle.h  

Constants

Name Type Remarks Include Path
InvalidHandle const FNiagaraEmitterHandle A static const invalid handle. NiagaraEmitterHandle.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bDebugShowBounds bool   NiagaraEmitterHandle.h  
bIsEnabled bool Whether or not this emitter is enabled within the System. Disabled emitters aren't simulated. NiagaraEmitterHandle.h  
bIsolated bool   NiagaraEmitterHandle.h
  • Transient
EmitterMode ENiagaraEmitterMode   NiagaraEmitterHandle.h  
Id FGuid The id of this emitter handle. NiagaraEmitterHandle.h
  • VisibleAnywhere
  • Category="Emitter ID"
IdName FName HACK! Data sets used to use the emitter name, but this isn't guaranteed to be unique. NiagaraEmitterHandle.h
  • VisibleAnywhere
  • Category="Emitter ID"
Name FName The display name for this emitter in the System. NiagaraEmitterHandle.h  
OnEmitterModeChangedDelegate FSimpleMulticastDelegate   NiagaraEmitterHandle.h  
StatelessEmitter TObjectPtr< UNiagaraStatelessEmitter >   NiagaraEmitterHandle.h  
VersionedInstance FVersionedNiagaraEmitter The copied instance of the emitter this handle references. NiagaraEmitterHandle.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearEmitter()

   NiagaraEmitterHandle.h  

void ConditionalPostLoad ( int32 NiagaraCustomVersion
)

 Calls conditional post load on all sub-objects this handle references. NiagaraEmitterHandle.h  

void ForEachEnabledRendererWithIndex ( TFunction< void(const class UNiagaraRendererProperties*, int32)> Delegate
) const

 Iterate over all the enabled renderers on the emitter NiagaraEmitterHandle.h  

bool GetDebugShowBounds()

   NiagaraEmitterHandle.h  

UNiagaraEmitterBase * GetEmitterBase()

   NiagaraEmitterHandle.h  

FVersionedNiagaraEmitterData * GetEmitterData()

   NiagaraEmitterHandle.h  

ENiagaraEmitterMode GetEmitterMode()

   NiagaraEmitterHandle.h  

FGuid GetId()

 Gets the unique id for this handle. NiagaraEmitterHandle.h  
HACK! Data sets used to use the emitter name, but this isn't guaranteed to be unique. NiagaraEmitterHandle.h  

const FVersionedNiagaraEmitter GetInstance()

 Gets the copied instance of the emitter this handle references. NiagaraEmitterHandle.h  

bool GetIsEnabled()

 Gets whether or not this emitter is enabled within the System. Disabled emitters aren't simulated. NiagaraEmitterHandle.h  

FName GetName()

 Gets the display name for this emitter in the System. NiagaraEmitterHandle.h  

const FNiagaraPlatformSet * GetPlatformSet()

 Get the PlatformSet for this emitter. NiagaraEmitterHandle.h  

UNiagaraStatelessEmitter * GetStatelessEmitter()

   NiagaraEmitterHandle.h  

FString GetUniqueInstanceName()

 Gets a unique name for this emitter instance for use in scripts and parameter stores etc. NiagaraEmitterHandle.h  

bool IsAllowedByScalability()

 Test to see if the emitter is allowed by scalability or not NiagaraEmitterHandle.h  

bool IsEnabledOnEffectQualityLevel ( int32 QualityLevel
) const

 Test to see if the emitter is enabled on the provided quality level or not. NiagaraEmitterHandle.h  

bool IsIsolated()

   NiagaraEmitterHandle.h  

bool IsValid()

 Whether or not this is a valid emitter handle. NiagaraEmitterHandle.h  

bool NeedsRecompile()

 Determine whether or not the Instance script is in synch with its graph. NiagaraEmitterHandle.h  

FSimpleMulticastDelegate & OnEmitterModeChanged()

   NiagaraEmitterHandle.h  

void SetDebugShowBounds ( bool bShowBounds
)

   NiagaraEmitterHandle.h  

void SetEmitterMode ( UNiagaraSystem& InOwningSystem,
ENiagaraEmitterMode InEmitterMode
)

   NiagaraEmitterHandle.h  

void SetInstance ( const FVersionedNiagaraEmitter& VersionedData
)

   NiagaraEmitterHandle.h  

void SetInstanceVersion ( const FGuid& InVersion
)

   NiagaraEmitterHandle.h  

bool SetIsEnabled ( bool bInIsEnabled,
UNiagaraSystem& InOwnerSystem,
bool bRecompileIfChanged
)

 Sets whether or not this emitter is enabled within the System. NiagaraEmitterHandle.h  

void SetIsolated ( bool bInIsolated
)

   NiagaraEmitterHandle.h  

void SetName ( FName InName,
UNiagaraSystem& InOwnerSystem
)

 Sets the display name for this emitter in the System. NiagaraEmitterHandle.h  

void SetStatelessEmitter ( UNiagaraStatelessEmitter* InEmitter
)

   NiagaraEmitterHandle.h  

bool UsesEmitter ( const FVersionedNiagaraEmitterBase& InEmitter
) const

   NiagaraEmitterHandle.h  

bool UsesEmitter ( const FVersionedNiagaraEmitter& InEmitter
) const

 Whether or not this handle uses the supplied emitter. NiagaraEmitterHandle.h  

bool UsesEmitter ( const UNiagaraEmitterBase& InEmitter
) const

   NiagaraEmitterHandle.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page