1. Epic GamesDeveloper
  3. FNiagaraEditorModule

FNiagaraEditorModule

Niagara Editor module

API > API/Plugins > API/Plugins/NiagaraEditor

Niagara Editor module

   
Name FNiagaraEditorModule
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraEditorModule.h
Include Path #include "NiagaraEditorModule.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraEditorModule()

   NiagaraEditorModule.h  

Classes

Name Remarks
FDeferredDestructionContainerBase  
TAssetPreloadCache  
TDeferredDestructionContainer  

Structs

Name Remarks
FActiveCompilation  
FMoviePreviewObjects  

Typedefs

Name Type Remarks Include Path
FOnCheckScriptToolkitsShouldFocusGraphElement TMulticastDelegate_OneParam< void, const FNiagaraScriptIDAndGraphFocusInfo * >   NiagaraEditorModule.h
FOnCreateMovieSceneTrackForParameter TBaseDelegate_OneParam< UMovieSceneNiagaraParameterTrack *, FNiagaraVariable >   NiagaraEditorModule.h
FOnScriptApplied TMulticastDelegate_TwoParams< void, UNiagaraScript *, FGuid >   NiagaraEditorModule.h

Constants

Name Type Remarks Include Path
NiagaraEditorAppIdentifier const FName Niagara Editor app identifier string NiagaraEditorModule.h
WorldCentricTabColorScale const FLinearColor The tab color scale for niagara editors. NiagaraEditorModule.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AbortSystemCompileHandle FDelegateHandle   NiagaraEditorModule.h  
ActiveCompilations TMap< int32, FActiveCompilation >   NiagaraEditorModule.h  
AssetRegistryOnLoadCompleteHandle FDelegateHandle   NiagaraEditorModule.h  
bThumbnailRenderersRegistered bool   NiagaraEditorModule.h  
CachedScriptAssetHighlights TOptional< TArray< FNiagaraScriptHighlight > >   NiagaraEditorModule.h  
Clipboard TSharedRef< FNiagaraClipboard >   NiagaraEditorModule.h  
CompileResultHandle FDelegateHandle   NiagaraEditorModule.h  
CreateBoolParameterTrackEditorHandle FDelegateHandle   NiagaraEditorModule.h  
CreateColorParameterTrackEditorHandle FDelegateHandle   NiagaraEditorModule.h  
CreatedAssetTypeActions TArray< TSharedPtr< IAssetTypeActions > > All created asset type actions. Cached here so that we can unregister it during shutdown. NiagaraEditorModule.h  
CreateEmitterTrackEditorHandle FDelegateHandle   NiagaraEditorModule.h  
CreateFloatParameterTrackEditorHandle FDelegateHandle   NiagaraEditorModule.h  
CreateIntegerParameterTrackEditorHandle FDelegateHandle   NiagaraEditorModule.h  
CreateSystemTrackEditorHandle FDelegateHandle   NiagaraEditorModule.h  
CreateVectorParameterTrackEditorHandle FDelegateHandle   NiagaraEditorModule.h  
DataInterfaceVisualizers TMap< TObjectKey< UClass >, TArray< TSharedRef< INiagaraDataInterfaceSimCacheVisualizer > > >   NiagaraEditorModule.h  
DefaultTrackHandle FDelegateHandle   NiagaraEditorModule.h  
DeviceProfileManagerUpdatedHandle FDelegateHandle   NiagaraEditorModule.h  
DumpCompileIdDataForAssetCommand IConsoleCommand *   NiagaraEditorModule.h  
DumpEmitterDependenciesCommand IConsoleCommand *   NiagaraEditorModule.h  
DumpRapidIterationParametersForAsset IConsoleCommand *   NiagaraEditorModule.h  
EditorOnlyDataUtilities TSharedPtr< INiagaraEditorOnlyDataUtilities >   NiagaraEditorModule.h  
EnqueuedForDeferredDestruction TArray< TSharedRef< const FDeferredDestructionContainerBase > >   NiagaraEditorModule.h  
EnumTypeUtilities TSharedPtr< INiagaraEditorTypeUtilities, ESPMode::ThreadSafe >   NiagaraEditorModule.h  
GraphCacheTraversalHandle FDelegateHandle   NiagaraEditorModule.h  
GraphDataCache TUniquePtr< FNiagaraGraphDataCache >   NiagaraEditorModule.h  
LoadAllSystemsInFolderCommand IConsoleCommand *   NiagaraEditorModule.h  
MenuExtensibilityManager TSharedPtr< FExtensibilityManager >   NiagaraEditorModule.h  
ModuleWizards TArray< TSharedRef< UE::Niagara::Wizard::FModuleWizardGenerator > >   NiagaraEditorModule.h  
MoviePreviewObjects TMap< FAssetData, FMoviePreviewObjects >   NiagaraEditorModule.h  
NiagaraComponentBroker TSharedPtr< FNiagaraComponentBroker >   NiagaraEditorModule.h  
ObjectPool TMap< UClass *, TArray< UObject * > >   NiagaraEditorModule.h  
OnAssetsPreDeleteHandle FDelegateHandle   NiagaraEditorModule.h  
OnCheckScriptToolkitsShouldFocusGraphElement FOnCheckScriptToolkitsShouldFocusGraphElement   NiagaraEditorModule.h  
OnModulesChangedHandle FDelegateHandle   NiagaraEditorModule.h  
OnScriptAppliedDelegate FOnScriptApplied   NiagaraEditorModule.h  
ParameterCollectionAssetCache TAssetPreloadCache< UNiagaraParameterCollection >   NiagaraEditorModule.h  
ParameterDefinitionsAssetCache TAssetPreloadCache< UNiagaraParameterDefinitions >   NiagaraEditorModule.h  
PluginAssetClassesPreloaded TArray< UClass * >   NiagaraEditorModule.h  
PollSystemCompileHandle FDelegateHandle   NiagaraEditorModule.h  
PrecompileDuplicatorHandle FDelegateHandle   NiagaraEditorModule.h  
PrecompilerHandle FDelegateHandle   NiagaraEditorModule.h  
PreventAllSystemRecompilesCommand IConsoleCommand *   NiagaraEditorModule.h  
PreventSystemRecompileCommand IConsoleCommand *   NiagaraEditorModule.h  
PreviewFeatureLevelChangedHandle FDelegateHandle   NiagaraEditorModule.h  
PreviewPlatformChangedHandle FDelegateHandle   NiagaraEditorModule.h  
RecentAndFavoritesManager TSharedPtr< FNiagaraRecentAndFavoritesManager >   NiagaraEditorModule.h  
RegisteredDynamicStructs TSet< FName > Set of dynamic structs we have done registrations for. NiagaraEditorModule.h  
ReinitializeStyleCommand IConsoleCommand *   NiagaraEditorModule.h  
RendererCreationInfo TArray< FNiagaraRendererCreationInfo >   NiagaraEditorModule.h  
RequestCompileSystemHandle FDelegateHandle   NiagaraEditorModule.h  
ReservedDefinitionIds TSet< FGuid > Set of Parameter Definitions Ids. NiagaraEditorModule.h  
ReservedParametersManagerSingleton UNiagaraReservedParametersManager *   NiagaraEditorModule.h  
ScriptCompilerHandle FDelegateHandle   NiagaraEditorModule.h  
ScriptMergeManager TSharedPtr< FNiagaraScriptMergeManager >   NiagaraEditorModule.h  
SequencerSettings TObjectPtr< USequencerSettings >   NiagaraEditorModule.h  
StackIssueGenerators TMap< FName, INiagaraStackObjectIssueGenerator * >   NiagaraEditorModule.h  
StackObjectCustomizationRegistry FNiagaraStackObjectCustomizationRegistry   NiagaraEditorModule.h  
StructToPropertyUtilitiesMap TMap< const UScriptStruct *, TSharedRef< INiagaraEditorPropertyUtilities, ESPMode::ThreadSafe > >   NiagaraEditorModule.h  
TempPackage UPackage *   NiagaraEditorModule.h  
TestCompileScriptCommand IConsoleCommand *   NiagaraEditorModule.h  
ToolBarExtensibilityManager TSharedPtr< FExtensibilityManager >   NiagaraEditorModule.h  
TraversalCache TSharedPtr< UE::Niagara::TraversalCache::FTraversalCache >   NiagaraEditorModule.h  
TypeConversionScriptCache TOptional< TArray< UNiagaraScript * > >   NiagaraEditorModule.h  
TypeEditorsCS FCriticalSection   NiagaraEditorModule.h  
TypeToEditorUtilitiesMap TMap< FNiagaraTypeDefinition, TSharedRef< INiagaraEditorTypeUtilities, ESPMode::ThreadSafe > >   NiagaraEditorModule.h  
TypeToParameterTrackCreatorMap TMap< const UScriptStruct *, FOnCreateMovieSceneTrackForParameter >   NiagaraEditorModule.h  
UpgradeAllNiagaraAssetsCommand IConsoleCommand *   NiagaraEditorModule.h  
ValidateAndFixScriptVariableGuidsCommand IConsoleCommand *   NiagaraEditorModule.h  
ValidateScriptVariableGuidsCommand IConsoleCommand *   NiagaraEditorModule.h  
WidgetProvider TSharedPtr< INiagaraEditorWidgetProvider >   NiagaraEditorModule.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AbortSystemCompile ( FNiagaraCompilationTaskHandle
)

   NiagaraEditorModule.h  

TSharedPtr< FNiagaraGraphCachedDataBase, ESPMode::ThreadSafe > CacheGraphTraversal ( const UObject* Obj,
FGuid Version
)

   NiagaraEditorModule.h  

bool CanCreateParameterTrackForType ( const UScriptStruct& StructType
)

   NiagaraEditorModule.h  

void ClearObjectPool()

   NiagaraEditorModule.h  

const FNiagaraEditorCommands & Commands()

 Get the niagara UI commands. NiagaraEditorModule.h  

virtual int32 CompileScript ( const FNiagaraCompileRequestDataBase* InCompileRequest,
const FNiagaraCompileRequestDuplicateDataBase* InCompileRequestDuplicate,
const FNiagaraCompileOptions& InCompileOptions
)

 Start the compilation of the specified script. NiagaraEditorModule.h  

UMovieSceneNiagaraParameterTrack * CreateParameterTrackForType ( const UScriptStruct& StructType,
FNiagaraVariable Parameter
)

   NiagaraEditorModule.h  

void EnqueueObjectForDeferredDestruction ( TSharedRef< T > InObjectToDestruct
)

   NiagaraEditorModule.h  

void EnsureReservedDefinitionUnique ( FGuid& UniqueId
)

   NiagaraEditorModule.h  

UNiagaraParameterCollection * FindCollectionForVariable ( const FString& VariableName
)

   NiagaraEditorModule.h  

TArrayView< TSharedRef< INiagaraDataInterfaceSimCacheVisualizer > > FindDataInterfaceCacheVisualizer ( UClass* DataInterfaceClass
)

   NiagaraEditorModule.h  

const FMoviePreviewObjects & FindOrAddMoviePreviewObjects ( const FAssetData& AssetData
)

   NiagaraEditorModule.h  

INiagaraStackObjectIssueGenerator * FindStackObjectIssueGenerator ( FName StructName
)

   NiagaraEditorModule.h  

const TArray< TWeakObjectPtr< UNiagaraParameterCollection > > & GetCachedParameterCollectionAssets()

   NiagaraEditorModule.h  

const TArray< TWeakObjectPtr< UNiagaraParameterDefinitions > > & GetCachedParameterDefinitionsAssets()

   NiagaraEditorModule.h  

const TArray< UNiagaraScript * > & GetCachedTypeConversionScripts()

   NiagaraEditorModule.h  

FNiagaraClipboard & GetClipboard()

   NiagaraEditorModule.h  

const FNiagaraEditorCommands & GetCommands()

   NiagaraEditorModule.h  

virtual TSharedPtr< FNiagaraVMExecutableData > GetCompilationResult ( int32 JobID,
bool bWait,
FNiagaraScriptCompileMetrics& ScriptMetrics
)

   NiagaraEditorModule.h  

void GetDataInterfaceFeedbackSafe ( UNiagaraDataInterface* InDataInterface,
TArray< FNiagaraDataInterfaceError >& OutErrors,
TArray< FNiagaraDataInterfaceFeedback >& Warnings,
TArray< FNiagaraDataInterfaceFeedback >& Info
)

   NiagaraEditorModule.h  

TSharedPtr< FNiagaraSystemViewModel > GetExistingViewModelForSystem ( UNiagaraSystem* InSystem
)

   NiagaraEditorModule.h  

FNiagaraGraphDataCache & GetGraphDataCache()

   NiagaraEditorModule.h  

TConstArrayView< TSharedRef< UE::Niagara::Wizard::FModuleWizardGenerator > > GetModuleWizards()

   NiagaraEditorModule.h  

FOnCheckScriptToolkitsShouldFocusGraphElement & GetOnScriptToolkitsShouldFocusGraphElement()

   NiagaraEditorModule.h  

UE::Niagara::TraversalCache::FTraversalCache & GetParameterTraversalCache()

   NiagaraEditorModule.h  

UObject * GetPooledDuplicateObject ( UObject* Source,
EFieldIteratorFlags::SuperClassFlags CopySuperProperties
)

 Object pooling methods used to prevent unnecessary object allocation during compiles. NiagaraEditorModule.h  
Gets Niagara editor property utilities for a specific struct if there are any registered. NiagaraEditorModule.h  

FNiagaraRecentAndFavoritesManager * GetRecentsManager()

   NiagaraEditorModule.h  

const TArray< FNiagaraRendererCreationInfo > & GetRendererCreationInfos()

   NiagaraEditorModule.h  

TSharedRef< FNiagaraScriptMergeManager > GetScriptMergeManager()

   NiagaraEditorModule.h  

FNiagaraStackObjectCustomizationRegistry & GetStackObjectCustomizationRegistry()

   NiagaraEditorModule.h  

void GetTargetSystemAndEmitterForDataInterface ( UNiagaraDataInterface* InDataInterface,
UNiagaraSystem*& OutOwningSystem,
FVersionedNiagaraEmitter& OutOwningEmitter
)

   NiagaraEditorModule.h  

UPackage * GetTempPackage()

   NiagaraEditorModule.h  
Gets Niagara editor type utilities for a specific type if there are any registered. NiagaraEditorModule.h  

TSharedRef< INiagaraEditorWidgetProvider > GetWidgetProvider()

   NiagaraEditorModule.h  

void InitializeTaggedAssetBrowserDetails()

   NiagaraEditorModule.h  

void InvalidateCachedScriptAssetData()

   NiagaraEditorModule.h  

FOnScriptApplied & OnScriptApplied()

 Callback whenever a script is applied/updated in the editor. NiagaraEditorModule.h  

bool PollSystemCompile ( FNiagaraCompilationTaskHandle,
FNiagaraSystemAsyncCompileResults&,
bool,
bool
)

   NiagaraEditorModule.h  
  NiagaraEditorModule.h  

TSharedPtr< FNiagaraCompileRequestDuplicateDataBase, ESPMode::ThreadSafe > PrecompileDuplicate ( const FNiagaraCompileRequestDataBase* OwningSystemRequestData,
UNiagaraSystem* OwningSystem,
UNiagaraEmitter* OwningEmitter,
UNiagaraScript* TargetScript,
FGuid TargetVersion
)

   NiagaraEditorModule.h  

void PreloadSelectablePluginAssetsByClass ( UClass* InClass
)

   NiagaraEditorModule.h  

void RegisterDataInterfaceCacheVisualizer ( UClass* DataInterfaceClass,
TSharedRef< INiagaraDataInterfaceSimCacheVisualizer > InCacheVisualizer
)

   NiagaraEditorModule.h  

void RegisterModuleWizards ( TSharedRef< UE::Niagara::Wizard::FModuleWizardGenerator > WizardGenerator
)

 Registers niagara wizards that can be used to add generated modules to the stack. NiagaraEditorModule.h  

void RegisterParameterTrackCreatorForType ( const UScriptStruct& StructType,
FOnCreateMovieSceneTrackForParameter CreateTrack
)

   NiagaraEditorModule.h  

void RegisterPropertyUtilities ( const UScriptStruct* InStruct,
TSharedRef< INiagaraEditorPropertyUtilities, ESPMode::ThreadSafe > PropertyUtilities
)

 Registers niagara editor property utilities for a specific struct type. NiagaraEditorModule.h  

void RegisterRendererCreationInfo ( FNiagaraRendererCreationInfo RendererCreationInfo
)

 Registers a new renderer creation delegate with the display name it's going to use for the UI. NiagaraEditorModule.h  

void RegisterSettings()

 Register/unregister niagara editor settings. NiagaraEditorModule.h  

void RegisterTypeUtilities ( FNiagaraTypeDefinition Type,
TSharedRef< INiagaraEditorTypeUtilities, ESPMode::ThreadSafe > EditorUtilities
)

 Registers niagara editor type utilities for a specific type. NiagaraEditorModule.h  

void RegisterWidgetProvider ( TSharedRef< INiagaraEditorWidgetProvider > InWidgetProvider
)

   NiagaraEditorModule.h  

void ReleaseObjectToPool ( UObject* Obj
)

   NiagaraEditorModule.h  

FNiagaraCompilationTaskHandle RequestCompileSystem ( UNiagaraSystem* System,
bool bForce,
const ITargetPlatform* TargetPlatform
)

   NiagaraEditorModule.h  

void ScriptApplied ( UNiagaraScript* Script,
FGuid VersionGuid
) const

   NiagaraEditorModule.h  

void UnregisterDataInterfaceCacheVisualizer ( UClass* DataInterfaceClass,
TSharedRef< INiagaraDataInterfaceSimCacheVisualizer > InCacheVisualizer
)

   NiagaraEditorModule.h  

void UnregisterParameterTrackCreatorForType ( const UScriptStruct& StructType
)

   NiagaraEditorModule.h  

void UnregisterSettings()

   NiagaraEditorModule.h  

void UnregisterWidgetProvider ( TSharedRef< INiagaraEditorWidgetProvider > InWidgetProvider
)

   NiagaraEditorModule.h  

Overridden from IModuleInterface

Name Remarks Include Path Unreal Specifiers

virtual void ShutdownModule()

   NiagaraEditorModule.h  

virtual void StartupModule()

   NiagaraEditorModule.h  

Overridden from IHasMenuExtensibility

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< FExtensibilityManager > GetMenuExtensibilityManager()

 Gets the extensibility managers for outside entities to extend static mesh editor's menus and toolbars NiagaraEditorModule.h  

Overridden from IHasToolBarExtensibility

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< FExtensibilityManager > GetToolBarExtensibilityManager()

   NiagaraEditorModule.h  

Static

Name Remarks Include Path Unreal Specifiers

static FNiagaraEditorModule & Get()

 Get the instance of this module. NiagaraEditorModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page