FNiagaraEditorModule | Unreal Engine 4.27 Documentation

Unreal Engine C++ API Reference > Plugins > NiagaraEditor

Inheritance Hierarchy

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

	Type	Name	Description
		FNiagaraEditorModule ()

Functions

Type	Name	Description
void	AbortSystemCompile ( FNiagaraCompilationTaskHandle )
TSharedPtr< FNiagaraGraphCachedDataBase, ESPMode::ThreadSafe >	CacheGraphTraversal ( const UObject* Obj, FGuid Version )
bool	CanCreateParameterTrackForType ( const UScriptStruct& StructType )
void	ClearObjectPool ()
const FNiagaraEditorCommands &	Commands ()	Get the niagara UI commands.
int32	CompileScript ( const FNiagaraCompileRequestDataBase* InCompileRequest, const FNiagaraCompileRequestDuplicateDataBase* InCompileRequestDuplicate, const FNiagaraCompileOptions& InCompileOptions )	Start the compilation of the specified script.
UMovieSceneNiagaraParameterTrack *	CreateParameterTrackForType ( const UScriptStruct& StructType, FNiagaraVariable Parameter )
void	EnqueueObjectForDeferredDestruction ( TSharedRef< T > InObjectToDestruct )
void	EnsureReservedDefinitionUnique ( FGuid& UniqueId )
UNiagaraParameterCollection *	FindCollectionForVariable ( const FString& VariableName )
INiagaraStackObjectIssueGenerator *	FindStackObjectIssueGenerator ( FName StructName )
FNiagaraEditorModule &	Get ()	Get the instance of this module.
const TArray< TWeakObjectPtr< UNiagaraParameterDefinitions > > &	GetCachedParameterDefinitionsAssets ()
const TArray< UNiagaraScript * > &	GetCachedTypeConversionScripts ()
FNiagaraClipboard &	GetClipboard ()
const FNiagaraEditorCommands &	GetCommands ()
TSharedPtr< FNiagaraVMExecutableData >	GetCompilationResult ( int32 JobID, bool bWait, FNiagaraScriptCompileMetrics& ScriptMetrics )
void	GetDataInterfaceFeedbackSafe ( UNiagaraDataInterface* InDataInterface, TArray< FNiagaraDataInterfaceError >& OutErrors, TArray< FNiagaraDataInterfaceFeedback >& Warnings, TArray< FNiagaraDataInterfaceFeedback >& Info )
TSharedPtr< FNiagaraDebugger >	GetDebugger ()
TSharedPtr< FNiagaraSystemViewModel >	GetExistingViewModelForSystem ( UNiagaraSystem* InSystem )
FNiagaraGraphDataCache &	GetGraphDataCache ()
FOnCheckScriptToolkitsShouldFocusGraphElement &	GetOnScriptToolkitsShouldFocusGraphElement ()
UObject *	GetPooledDuplicateObject ( UObject* Source, EFieldIteratorFlags::SuperClassFlags CopySuperProperties )	Object pooling methods used to prevent unnecessary object allocation during compiles.
const TArray< FNiagaraRendererCreationInfo > &	GetRendererCreationInfos ()
TSharedRef< FNiagaraScriptMergeManager >	GetScriptMergeManager ()
void	GetTargetSystemAndEmitterForDataInterface ( UNiagaraDataInterface* InDataInterface, UNiagaraSystem*& OutOwningSystem, FVersionedNiagaraEmitter& OutOwningEmitter )
TSharedPtr< INiagaraEditorTypeUtilities, ESPMode::ThreadSafe >	GetTypeUtilities ( const FNiagaraTypeDefinition& Type )	Gets Niagara editor type utilities for a specific type if there are any registered.
TSharedRef< INiagaraEditorWidgetProvider >	GetWidgetProvider ()
void	InvalidateCachedScriptAssetData ()
FOnScriptApplied &	OnScriptApplied ()	Callback whenever a script is applied/updated in the editor.
bool	PollSystemCompile ( FNiagaraCompilationTaskHandle, FNiagaraSystemAsyncCompileResults&, bool, bool )
TSharedPtr< FNiagaraCompileRequestDataBase, ESPMode::ThreadSafe >	Precompile ( UObject* InObj, FGuid Version )
TSharedPtr< FNiagaraCompileRequestDuplicateDataBase, ESPMode::ThreadSafe >	PrecompileDuplicate ( const FNiagaraCompileRequestDataBase* OwningSystemRequestData, UNiagaraSystem* OwningSystem, UNiagaraEmitter* OwningEmitter, UNiagaraScript* TargetScript, FGuid TargetVersion )
void	PreloadSelectablePluginAssetsByClass ( UClass* InClass )
void	RegisterParameterTrackCreatorForType ( const UScriptStruct& StructType, FOnCreateMovieSceneTrackForParameter CreateTrack )
void	RegisterRendererCreationInfo ( FNiagaraRendererCreationInfo RendererCreationInfo )	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< INiagaraEditorTypeUtilities, ESPMode::ThreadSafe > EditorUtilities )	Registers niagara editor type utilities for a specific type.
void	RegisterWidgetProvider ( TSharedRef< INiagaraEditorWidgetProvider > InWidgetProvider )
void	ReleaseObjectToPool ( UObject* Obj )
FNiagaraCompilationTaskHandle	RequestCompileSystem ( UNiagaraSystem* System, bool bForce )
void	ScriptApplied ( UNiagaraScript* Script, FGuid VersionGuid )
void	UnregisterParameterTrackCreatorForType ( const UScriptStruct& StructType )
void	UnregisterSettings ()
void	UnregisterWidgetProvider ( TSharedRef< INiagaraEditorWidgetProvider > InWidgetProvider )

Overridden from IModuleInterface

	Type	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

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