Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > FNiagaraSystemUpdateContext

Light Theme

Dark Theme

FNiagaraSystemUpdateContext

Helper for reseting/reinitializing Niagara systems currently active when they are being edited.

Windows

MacOS

Linux

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraCommon.h
Include	#include "NiagaraCommon.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FNiagaraSystemUpdateContext

Remarks

Helper for reseting/reinitializing Niagara systems currently active when they are being edited. Can be used inside a scope with Systems being reinitialized on destruction or you can store the context and use CommitUpdate() to trigger reinitialization. For example, this can be split between PreEditChange and PostEditChange to ensure problematic data is not modified during execution of a system.

Constructors

	Name	Description
	FNiagaraSystemUpdateContext()
	FNiagaraSystemUpdateContext ( FNiagaraSystemUpdateContext& Other )
	FNiagaraSystemUpdateContext ( UNiagaraComponent* Component, bool bReInit, bool bInDestroyOnAdd, bool bInOnlyActive, bool bInDestroySystemSim )
	FNiagaraSystemUpdateContext ( const UNiagaraSystem* System, bool bReInit, bool bInDestroyOnAdd, bool bInOnlyActive, bool bInDestroySystemSim )
	FNiagaraSystemUpdateContext ( const UNiagaraEmitter* Emitter, bool bReInit, bool bInDestroyOnAdd, bool bInOnlyActive, bool bInDestroySystemSim )
	FNiagaraSystemUpdateContext ( const UNiagaraScript* Script, bool bReInit, bool bInDestroyOnAdd, bool bInOnlyActive, bool bInDestroySystemSim )
	FNiagaraSystemUpdateContext ( const UNiagaraParameterCollection&..., bool bReInit, bool bInDestroyOnAdd, bool bInOnlyActive, bool bInDestroySystemSim )

Destructors

	Name	Description
	~FNiagaraSystemUpdateContext()

Functions

	Name	Description
void	Add ( const UNiagaraParameterCollection&..., bool bReInit )
void	Add ( const UNiagaraScript* Script, bool bReInit )
void	Add ( const UNiagaraEmitter* Emitter, bool bReInit )
void	Add ( UNiagaraComponent* Component, bool bReInit )
void	Add ( const UNiagaraSystem* System, bool bReInit )
void	AddAll ( bool bReInit )	Adds all currently active systems.
void	CommitUpdate()	Handles any pending reinits or resets of system instances in this update context.
FCustomWorkD...	GetPostWork()
FCustomWorkD...	GetPreWork()
void	SetDestroyOnAdd ( bool bInDestroyOnAdd )
void	SetDestroySystemSim ( bool bInDestroySystemSim )
void	SetOnlyActive ( bool bInOnlyActive )

Typedefs

Name	Description
FCustomWorkDelegate

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss