FNiagaraEmitterHandle

Stores emitter information within the context of a System.

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public function

FNiagaraEmitterHandle()

Creates a new invalid emitter handle.

Public function

FNiagaraEmitterHandle

(
    UNiagaraEmitter& InEmitter
)

Creates a new emitter handle from an emitter.

Functions

Name Description

Public function

void

 

ClearEmitter()

Public function

void

 

ConditionalPostLoad

(
    int32 NiagaraCustomVersion
)

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

Public function Const

FGuid

 

GetId()

Gets the unique id for this handle.

Public function Const

FName

 

GetIdName()

HACK! Data sets used to use the emitter name, but this isn't guaranteed to be unique.

Public function Const

UNiagaraEmit...

 

GetInstance()

Gets the copied instance of the emitter this handle references.

Public function Const

bool

 

GetIsEnabled()

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

FString

 

GetUniqueInstanceName()

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

Public function Const

bool

 

IsIsolated()

Public function Const

bool

 

IsValid()

Whether or not this is a valid emitter handle.

Public function Const

bool

 

NeedsRecompile()

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

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 Const

bool

 

UsesEmitter

(
    const UNiagaraEmitter& InEmitter
)

Whether or not this handle uses the supplied emitter.

Constants

Name

Description

InvalidHandle

A static const invalid handle.