1. Epic GamesDeveloper
  3. FNiagaraEmitterHandle

FNiagaraEmitterHandle

Stores emitter information within the context of a System.

API > API/Plugins > API/Plugins/Niagara

References

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

Syntax

USTRUCT ()  
struct FNiagaraEmitterHandle

Remarks

Stores emitter information within the context of a System.

Constructors

  Type Name Description
Public function   Creates a new invalid emitter handle.
Public function   Creates a new emitter handle from an emitter.
Public function  

FNiagaraEmitterHandle ( UNiagaraStatelessEmitter& InEmitter
)

  
Public function  

FNiagaraEmitterHandle ( UNiagaraEmitter& InEmitter,
const FGuid& Version
)

 Creates a new emitter handle from an emitter.

Functions

  Type Name Description
Public function void  
Public function void

ConditionalPostLoad ( int32 NiagaraCustomVersion
)

 Calls conditional post load on all sub-objects this handle references.
Public function Const bool  
Public function Const FVersionedNiagaraEmitterData *  
Public function Const ENiagaraEmitterMode  
Public function Const FGuid

GetId ()

 Gets the unique id for this handle.
Public function Const FName HACK! Data sets used to use the emitter name, but this isn't guaranteed to be unique.
Public function FVersionedNiagaraEmitter &  
Public function Const FVersionedNiagaraEmitter Gets the copied instance of the emitter this handle references.
Public function Const bool Gets whether or not this emitter is enabled within the System. Disabled emitters aren't simulated.
Public function Const FName

GetName ()

 Gets the display name for this emitter in the System.
Public function Const UNiagaraStatelessEmitter *  
Public function Const FString Gets a unique name for this emitter instance for use in scripts and parameter stores etc.
Public function Const bool  
Public function Const bool

IsValid ()

 Whether or not this is a valid emitter handle.
Public function Const bool Determine whether or not the Instance script is in synch with its graph.
Public function FSimpleMulticastDelegate &  
Public function void

SetDebugShowBounds ( bool bShowBounds
)

  
Public function void

SetEmitterMode ( UNiagaraSystem& InOwningSystem,
ENiagaraEmitterMode InEmitterMode
)

  
Public function bool

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

 Sets whether or not this emitter is enabled within the System.
Public function void

SetIsolated ( bool bInIsolated
)

  
Public function void

SetName ( FName InName,
UNiagaraSystem& InOwnerSystem
)

 Sets the display name for this emitter in the System.
Public function void

SetStatelessEmitter ( UNiagaraStatelessEmitter* InEmitter
)

  
Public function Const bool

UsesEmitter ( const FVersionedNiagaraEmitter& InEmitter
)

 Whether or not this handle uses the supplied emitter.
Public function Const bool

UsesEmitter ( const UNiagaraEmitter& InEmitter
)

  

Constants

Name Description
InvalidHandle A static const invalid handle.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page