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 > NiagaraEditor > FNiagaraEditorModule

Light Theme

Dark Theme

FNiagaraEditorModule

Niagara Editor module

Inheritance Hierarchy

IModuleInterface

IHasMenuExtensibility

IHasToolBarExtensibility

FGCObject

FNiagaraEditorModule

References

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

Syntax

class FNiagaraEditorModule :
    public IModuleInterface,
    public IHasMenuExtensibility,
    public IHasToolBarExtensibility,
    public FGCObject

Remarks

Niagara Editor module

Constructors

	Name	Description
	FNiagaraEditorModule()

Functions

	Name	Description
TSharedPtr< ...	CacheGraphTraversal ( const UObject* Obj, FGuid Version )
bool	CanCreateParameterTrackForType ( const UScriptStruct& StructType )
void	ClearObjectPool()
const FNiaga...	Commands()	Get the niagara UI commands.
int32	CompileScript ( const FNiagaraCompileRequestDataBas..., const FNiagaraCompileRequestDuplica..., const FNiagaraCompileOptions& InCo... )	Start the compilation of the specified script.
UMovieSceneN...	CreateParameterTrackForType ( const UScriptStruct& StructType, FNiagaraVariable Parameter )
void	EnqueueObjectForDeferredDestruction ( TSharedRef< T > InObjectToDestruct )
void	EnsureReservedDefinitionUnique ( FGuid& UniqueId )
UNiagaraPara...	FindCollectionForVariable ( const FString& VariableName )
INiagaraStac...	FindStackObjectIssueGenerator ( FName StructName )
FNiagaraEdit...	Get()	Get the instance of this module.
const TArray...	GetCachedParameterDefinitionsAssets()
const TArray...	GetCachedTypeConversionScripts()
FNiagaraClip...	GetClipboard()
const FNiaga...	GetCommands()
TSharedPtr< ...	GetCompilationResult ( int32 JobID, bool bWait )
void	GetDataInterfaceFeedbackSafe ( UNiagaraDataInterface* InDataI..., TArray< FNiagaraDataInterfaceError ..., TArray< FNiagaraDataInterfaceFeedba..., TArray< FNiagaraDataInterfaceFeedba... )
TSharedPtr< ...	GetDebugger()
TSharedPtr< ...	GetExistingViewModelForSystem ( UNiagaraSystem* InSystem )
FNiagaraGrap...	GetGraphDataCache()
FOnCheckScri...	GetOnScriptToolkitsShouldFocusGraphElement()
UObject *...	GetPooledDuplicateObject ( UObject* Source, EFieldIteratorFlags::SuperClassFlag... )	Object pooling methods used to prevent unnecessary object allocation during compiles.
const TArray...	GetRendererCreationInfos()
TSharedRef< ...	GetScriptMergeManager()
void	GetTargetSystemAndEmitterForDataInterface ( UNiagaraDataInterface* InDataI..., UNiagaraSystem*& OutOwningSyst..., FVersionedNiagaraEmitter& OutOwnin... )
TSharedPtr< ...	GetTypeUtilities ( const FNiagaraTypeDefinition& Type )	Gets Niagara editor type utilities for a specific type if there are any registered.
TSharedRef< ...	GetWidgetProvider()
void	InvalidateCachedScriptAssetData()
FOnScriptApp...	OnScriptApplied()	Callback whenever a script is applied/updated in the editor.
TSharedPtr< ...	Precompile ( UObject* InObj, FGuid Version )
TSharedPtr< ...	PrecompileDuplicate ( const FNiagaraCompileRequestDataBas..., UNiagaraSystem* OwningSystem, UNiagaraEmitter* OwningEmitter, UNiagaraScript* TargetScript, FGuid TargetVersion )
void	PreloadSelectablePluginAssetsByClass ( UClass* InClass )
void	RegisterParameterTrackCreatorForType ( const UScriptStruct& StructType, FOnCreateMovieSceneTrackForParamete... )
void	RegisterRendererCreationInfo ( FNiagaraRendererCreationInfo Render... )	Registers a new renderer creation delegate with the display name it's going to use for the UI.
void	RegisterSettings()	Register/unregister niagara editor settings.
void	RegisterTypeUtilities ( FNiagaraTypeDefinition Type, TSharedRef< INiagaraEditorTypeUtili... )	Registers niagara editor type utilities for a specific type.
void	RegisterWidgetProvider ( TSharedRef< INiagaraEditorWidgetPro... )
void	ReleaseObjectToPool ( UObject* Obj )
void	ScriptApplied ( UNiagaraScript* Script, FGuid VersionGuid )
void	UnregisterParameterTrackCreatorForType ( const UScriptStruct& StructType )
void	UnregisterSettings()
void	UnregisterWidgetProvider ( TSharedRef< INiagaraEditorWidgetPro... )

Overridden from IModuleInterface

		Name	Description
	void	ShutdownModule()	Called before the module is unloaded, right before the module object is destroyed.
	void	StartupModule()	Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule.

Overridden from IHasMenuExtensibility

		Name	Description
	TSharedPtr< ...	GetMenuExtensibilityManager()	Gets the extensibility managers for outside entities to extend static mesh editor's menus and toolbars

Overridden from IHasToolBarExtensibility

		Name	Description
	TSharedPtr< ...	GetToolBarExtensibilityManager()

Typedefs

Name	Description
FOnCheckScriptToolkitsShouldFocusGraphElement
FOnCreateMovieSceneTrackForParameter
FOnScriptApplied

Constants

Name	Description
NiagaraEditorAppIdentifier	Niagara Editor app identifier string
WorldCentricTabColorScale	The tab color scale for niagara editors.

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

Take our survey

Cancel