FNiagaraEditorModule

Niagara Editor module

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public function

FNiagaraEditorModule()

Functions

Name Description

Public function

TSharedPtr< ...

 

CacheGraphTraversal

(
    const UObject* Obj,
    FGuid Version
)

Public function

bool

 

CanCreateParameterTrackForType

(
    const UScriptStruct& StructType
)

Public function

void

 

ClearObjectPool()

Public function

const FNiaga...

 

Commands()

Get the niagara UI commands.

Public function Virtual

int32

 

CompileScript

(
    const FNiagaraCompileRequestDataBas...,
    const FNiagaraCompileRequestDuplica...,
    const FNiagaraCompileOptions& InCo...
)

Start the compilation of the specified script.

Public function

UMovieSceneN...

 

CreateParameterTrackForType

(
    const UScriptStruct& StructType,
    FNiagaraVariable Parameter
)

Public function

void

 

EnqueueObjectForDeferredDestruction

(
    TSharedRef< T > InObjectToDestruct
)

Public function

void

 

EnsureReservedDefinitionUnique

(
    FGuid& UniqueId
)

Public function

UNiagaraPara...

 

FindCollectionForVariable

(
    const FString& VariableName
)

Public function

INiagaraStac...

 

FindStackObjectIssueGenerator

(
    FName StructName
)

Public function Static

FNiagaraEdit...

 

Get()

Get the instance of this module.

Public function Static

EAssetTypeCa...

 

GetAssetCategory()

Public function

const TArray...

 

GetCachedParameterDefinitionsAssets()

Public function Const

const TArray...

 

GetCachedTypeConversionScripts()

Public function Const

FNiagaraClip...

 

GetClipboard()

Public function Const

const FNiaga...

 

GetCommands()

Public function Virtual

TSharedPtr< ...

 

GetCompilationResult

(
    int32 JobID,
    bool bWait
)

Public function

void

 

GetDataInterfaceFeedbackSafe

Public function

TSharedPtr< ...

 

GetDebugger()

Public function

TSharedPtr< ...

 

GetExistingViewModelForSystem

(
    UNiagaraSystem* InSystem
)

Public function Const

FNiagaraGrap...

 

GetGraphDataCache()

Public function

FOnCheckScri...

 

GetOnScriptToolkitsShouldFocusGraphElement()

Public function

UObject *...

 

GetPooledDuplicateObject

(
    UObject* Source,
    EFieldIteratorFlags::SuperClassFlag...
)

Object pooling methods used to prevent unnecessary object allocation during compiles.

Public function Const

TSharedRef< ...

 

GetScriptMergeManager()

Public function

void

 

GetTargetSystemAndEmitterForDataInterface

(
    UNiagaraDataInterface* InDataI...,
    UNiagaraSystem*& OutOwningSyst...,
    UNiagaraEmitter*& OutOwningEmi...
)

Public function

TSharedPtr< ...

 

GetTypeUtilities

(
    const FNiagaraTypeDefinition& Type
)

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

Public function Const

TSharedRef< ...

 

GetWidgetProvider()

Public function

void

 

InvalidateCachedScriptAssetData()

Public function

TSharedPtr< ...

 

Precompile

(
    UObject* InObj,
    FGuid Version
)

Public function

TSharedPtr< ...

 

PrecompileDuplicate

(
    const FNiagaraCompileRequestDataBas...,
    UNiagaraSystem* OwningSystem,
    UNiagaraEmitter* OwningEmitter,
    UNiagaraScript* TargetScript,
    FGuid TargetVersion
)

Public function

void

 

RegisterParameterTrackCreatorForType

(
    const UScriptStruct& StructType,
    FOnCreateMovieSceneTrackForParamete...
)

Public function

void

 

RegisterSettings()

Register/unregister niagara editor settings.

Public function

void

 

RegisterTypeUtilities

Registers niagara editor type utilities for a specific type.

Public function

void

 

RegisterWidgetProvider

Public function

void

 

ReleaseObjectToPool

(
    UObject* Obj
)

Public function

void

 

UnregisterParameterTrackCreatorForType

(
    const UScriptStruct& StructType
)

Public function

void

 

UnregisterSettings()

Public function

void

 

UnregisterWidgetProvider

Overridden from IModuleInterface

Name Description

Public function Virtual

void

 

ShutdownModule()

Called before the module is unloaded, right before the module object is destroyed.

Public function Virtual

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

Public function Virtual

TSharedPtr< ...

 

GetMenuExtensibilityManager()

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

Overridden from IHasToolBarExtensibility

Typedefs

Constants

Name

Description

NiagaraAssetCategory

NiagaraEditorAppIdentifier

Niagara Editor app identifier string

WorldCentricTabColorScale

The tab color scale for niagara editors.