Navigation
Unreal Engine C++ API Reference > Plugins > Niagara
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraEmitterHandle.h |
| Include | #include "NiagaraEmitterHandle.h" |
Syntax
USTRUCT&40;&41;
struct FNiagaraEmitterHandle
Remarks
Stores emitter information within the context of a System.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Creates a new invalid emitter handle. | ||
 |
FNiagaraEmitterHandle
(
const FVersionedNiagaraEmitter& InEmitter |
Creates a new emitter handle from an emitter. | |
 |
FNiagaraEmitterHandle
(
UNiagaraEmitter& InEmitter, |
Creates a new emitter handle from an emitter. |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | ClearEmitter () |
|
 |
void | ConditionalPostLoad
(
int32 NiagaraCustomVersion |
Calls conditional post load on all sub-objects this handle references. |
  |
bool | ||
  |
FVersionedNiagaraEmitterData * | ||
  |
FGuid | GetId () |
Gets the unique id for this handle. |
  |
FName | GetIdName () |
HACK! Data sets used to use the emitter name, but this isn't guaranteed to be unique. |
 |
FVersionedNiagaraEmitter & | GetInstance () |
Gets the copied instance of the emitter this handle references. |
  |
FVersionedNiagaraEmitter | GetInstance () |
Gets the copied instance of the emitter this handle references. |
  |
bool | GetIsEnabled () |
Gets whether or not this emitter is enabled within the System. Disabled emitters aren't simulated. |
  |
FName | GetName () |
Gets the display name for this emitter in the System. |
  |
FString | Gets a unique name for this emitter instance for use in scripts and parameter stores etc. | |
  |
bool | IsIsolated () |
|
  |
bool | IsValid () |
Whether or not this is a valid emitter handle. |
  |
bool | Determine whether or not the Instance script is in synch with its graph. | |
 |
void | SetDebugShowBounds
(
bool bShowBounds |
|
 |
bool | SetIsEnabled
(
bool bInIsEnabled, |
Sets whether or not this emitter is enabled within the System. |
 |
void | SetIsolated
(
bool bInIsolated |
|
 |
void | SetName
(
FName InName, |
Sets the display name for this emitter in the System. |
  |
bool | UsesEmitter
(
const FVersionedNiagaraEmitter& InEmitter |
Whether or not this handle uses the supplied emitter. |
  |
bool | UsesEmitter
(
const UNiagaraEmitter& InEmitter |
Whether or not this handle uses the supplied emitter. |
Constants
| Name | Description |
|---|---|
| InvalidHandle | A static const invalid handle. |