NiagaraEditor

Filters

Classes

Name

Description

Public struct UStruct

FAddedPinData

Public struct

FChangeNamespaceMenuData

Public class

FCompileConstantResolver

Public struct

FCreateNiagaraWidgetForActionData

Public struct UStruct

FFunctionInputSummaryViewKey

Public struct UStruct

FFunctionInputSummaryViewMetadata

Public struct

FGenerateNiagaraMessageInfo

Public struct

FGetFilteredScriptAssetsOptions

Options for the GetScriptsByFilter function.

Public struct

FGetParameterVariablesFromSystemOptions

Options for the GetParameterVariablesFromSystem function.

Public struct

FGraphTraversalHandle

Public struct

FInputPinsAndOutputPins

Public struct

FLinkNameAndDelegate

Struct for passing around named simple delegates.

Public struct

FModuleScopedPin

Public struct UStruct

FNiagaraAction_NewNode

Public struct UStruct

FNiagaraActionColors

Public struct UStruct

FNiagaraActionSourceData

Public class

FNiagaraClipboard

Public struct UStruct

FNiagaraClipboardScriptVariable

Public class

FNiagaraCompileEventToken

Extension of message token to allow opening the asset editor when clicking on the linked asset name.

Public struct

FNiagaraCompileResults

Defines information about the results of a Niagara script compile.

Public class

FNiagaraConnectionDrawingPolicy

Public struct UStruct

FNiagaraCurveTemplate

Public class

FNiagaraDataInterfaceNodeActionProvider_DataChannelRead

Public class

FNiagaraDataInterfaceNodeActionProvider_DataChannelWrite

Actions for engine data interfaces.

Public class

FNiagaraEditorCommands

Defines commands for the niagara editor.

Public class

FNiagaraEditorModule

Niagara Editor module

Public class

FNiagaraEditorStyle

Manages the style which provides resources for niagara editor widgets.

Public class

FNiagaraEditorTypeUtilities

Public class

FNiagaraEnumIndexVisibilityCache

Public struct

FNiagaraGraphCachedBuiltHistory

Public class

FNiagaraGraphDataCache

Public struct

FNiagaraGraphFunctionAliasContext

Public struct UStruct

FNiagaraGraphParameterReference

Public struct UStruct

FNiagaraGraphParameterReferenceCollection

Public struct UStruct

FNiagaraGraphScriptUsageInfo

Container for UNiagaraGraph cached data for managing CompileIds and Traversals.

Public struct UStruct

FNiagaraInputExposureOptions

Public struct UStruct

FNiagaraMenuAction

Public struct UStruct

FNiagaraMenuAction_Base

New action hierarchy for the new menus.

Public struct UStruct

FNiagaraMenuAction_Generic

Public class

FNiagaraMenuActionCollector

Public class

FNiagaraMessageCompileEvent

Public class

FNiagaraMessageJobCompileEvent

Public class

FNiagaraMessageManager

Public class

FNiagaraMessageObjectRegistrationHandle

Public class

FNiagaraMessageText

Public class

FNiagaraMessageTextWithLinks

Public class

FNiagaraMessageTopicRegistrationHandle

Public struct

FNiagaraMessageTopics

Public struct UStruct

FNiagaraNamespaceMetadata

Public struct UStruct

FNiagaraNewAssetDialogConfig

Public class

FNiagaraObjectSelection

Public class

FNiagaraOpInfo

Information about a Niagara operation.

Public struct

FNiagaraParameterAction

Public struct

FNiagaraParameterDefinitionsPanelCategory

Public struct

FNiagaraParameterDefinitionsPanelItem

Public class

FNiagaraParameterDragOperation

Public class

FNiagaraParameterGraphDragOperation

Public struct

FNiagaraParameterMapHistory

Traverses a Niagara node graph to identify the variables that have been written and read from a parameter map.

Public class

FNiagaraParameterMapHistoryBuilder

Public class

FNiagaraParameterMapHistoryWithMetaDataBuilder

Public struct

FNiagaraParameterPanelCategory

Public struct

FNiagaraParameterPanelItem

Public struct

FNiagaraParameterPanelItemBase

Public struct UStruct

FNiagaraParameterPanelSectionStorage

Public struct UStruct

FNiagaraPropagatedVariable

Public struct UStruct

FNiagaraRendererCreationInfo

Public struct UStruct

FNiagaraSchemaAction_NewComment

Public struct UStruct

FNiagaraSchemaAction_NewNode

Action to add a node to the graph

Public class

FNiagaraScriptDragOperation

Public struct

FNiagaraScriptGraphNodeToFocusInfo

Public struct

FNiagaraScriptGraphPinToFocusInfo

Public struct

FNiagaraScriptIDAndGraphFocusInfo

Public struct

FNiagaraScriptNameAndAssetPath

Struct for passing around script asset info from compile event message job to message types.

Public struct

FNiagaraScriptParameterAction

Public struct UStruct

FNiagaraScriptVariableData

Public struct

FNiagaraScriptVersionUpgradeContext

Public class

FNiagaraShaderQueueTickable

Public struct UStruct

FNiagaraSpawnShortcut

Public class

FNiagaraStackFunctionInputBinder

Public struct UStruct

FNiagaraStackMessage

Public struct

FNiagaraStaticVariableSearchContext

Public struct UStruct

FParameterDefinitionsBindingNameSubscription

Public struct

FRefreshAllScriptsFromExternalChangesArgs

Public struct UStruct

FReservedParameter

Wrapper struct for tracking parameters that are reserved by parameter definitions assets.

Public struct UStruct

FScriptVarBindingNameSubscription

Helper structs to map between external parameter libraries and a set of their script variables to local script variables.

Public class

INiagaraCompiler

Interface for Niagara compilers.

Public class

INiagaraDataInterfaceNodeActionProvider

Public class

INiagaraEditorTypeUtilities

Public class

INiagaraEditorWidgetProvider

Defines methods for allowing external modules to supply widgets to the core editor module.

Public class

INiagaraMessage

Interface for view-agnostic message that holds limited lifetime information on a message (e.g. a weak pointer to an asset.)

Public class

INiagaraMessageJob

Interface for "slow task" message generation jobs that should be time sliced to avoid stalling the UI.

Public class

INiagaraMessageRegistrationHandle

Public struct

INiagaraScriptGraphFocusInfo

Interface for struct representing information about where to focus in a Niagara Script Graph after opening the editor for it.

Public class

SNiagaraActionWidget

Custom widget for GraphActionMenu

Public class

SNiagaraGraphActionWidget

Custom widget for GraphActionMenu

Public class

SNiagaraParameterEditor

Base class for inline parameter editors.

Public class

TNiagaraSelection

A set of selected objects which calls a delegate any time it is changed.

Public class UClass MinimalAPI HideCategories Config collapsecategories

UActorFactoryNiagara

Public class UClass

UEdGraphSchema_Niagara

Public class UClass

UEdGraphSchema_NiagaraSystemOverview

Public class UClass

UNiagaraClipboardContent

Public class UClass

UNiagaraClipboardEditorScriptingUtilities

Public class UClass

UNiagaraClipboardFunction

Public class UClass

UNiagaraClipboardFunctionInput

Public class UClass HideCategories

UNiagaraDataChannelDefinitionsFactoryNew

Public class UClass

UNiagaraDynamicInputScriptFactory

Niagara dynamic input script factory.

Public class UClass

UNiagaraEditorParametersAdapter

An interface for editor only data which owns UNiagaraScriptVariables and supports synchronizing them with definitions.

Public class UClass Meta Config defaultconfig

UNiagaraEditorSettings

Public class UClass HideCategories

UNiagaraEffectTypeFactoryNew

Public class UClass MinimalAPI

UNiagaraEmitterEditorData

Editor only UI data for emitters.

Public class UClass MinimalAPI HideCategories

UNiagaraEmitterFactoryNew

A factory for niagara emitter assets.

Public class UClass

UNiagaraFunctionScriptFactory

Niagara function factory.

Public class UClass MinimalAPI

UNiagaraGraph

Public class UClass Abstract

UNiagaraMessageData

Public class UClass

UNiagaraMessageDataText

Public class UClass

UNiagaraModuleScriptFactory

Niagara module script factory.

Public class UClass

UNiagaraNode

Public class UClass

UNiagaraNodeAssignment

Public class UClass MinimalAPI

UNiagaraNodeCustomHlsl

Public class UClass MinimalAPI

UNiagaraNodeDataSetBase

Public class UClass MinimalAPI

UNiagaraNodeFunctionCall

Public class UClass MinimalAPI

UNiagaraNodeInput

Public class UClass MinimalAPI

UNiagaraNodeOp

Public class UClass MinimalAPI

UNiagaraNodeOutput

Public class UClass MinimalAPI

UNiagaraNodeReadDataSet

Public class UClass Abstract

UNiagaraNodeWithDynamicPins

A base node for niagara nodes with pins which can be dynamically added and removed by the user.

Public class UClass MinimalAPI

UNiagaraNodeWriteDataSet

Public class UClass

UNiagaraOverviewNode

Public class UClass HideCategories

UNiagaraParameterCollectionFactoryNew

Public class UClass HideCategories

UNiagaraParameterCollectionInstanceFactoryNew

Public class UClass MinimalAPI

UNiagaraParameterDefinitions

Collection of UNiagaraScriptVariables to synchronize between UNiagaraScripts.

Public class UClass HideCategories

UNiagaraParameterDefinitionsFactory

Public class UClass blueprintinternaluseonly

UNiagaraPythonEmitter

Wrapper for an emitter stack.

Public class UClass blueprintinternaluseonly

UNiagaraPythonModule

Wrapper for a module from the emitter stack.

Public class UClass blueprintinternaluseonly

UNiagaraPythonScriptModuleInput

Wrapper for setting the value on a parameter of a UNiagaraScript, applied through a UUpgradeNiagaraScriptResults.

Public class UClass Abstract HideCategories

UNiagaraScriptFactoryNew

Public class UClass MinimalAPI

UNiagaraScriptSource

Public class UClass

UNiagaraScriptVariable

Used to store variable data and metadata per graph.

Public class UClass

UNiagaraStackEditorData

Editor only UI data for emitters.

Public class UClass

UNiagaraSystemEditorData

Editor only data for systems.

Public class UClass

UNiagaraSystemEditorFolder

Editor only folder data for emitters in a system.

Public class UClass HideCategories

UNiagaraSystemFactoryNew

Public class UClass category, displayname

UNiagaraValidationRule_BannedDataInterfaces

This validation rule can ban the use of certain datainterfaces on all or a subset of platforms.

Public class UClass category, displayname

UNiagaraValidationRule_BannedModules

This validation rule can ban the use of certain modules on all or a subset of platforms.

Public class UClass category, displayname

UNiagaraValidationRule_BannedRenderers

This validation rule can ban the use of certain renderers on all or a subset of platforms.

Public class UClass category, displayname

UNiagaraValidationRule_FixedGPUBoundsSet

This validation rule ensures that GPU emitters have fixed bounds set.

Public class UClass category, displayname

UNiagaraValidationRule_InvalidEffectType

This validation rule can marks this effect type as invalid and so must be changed.

Public class UClass category, displayname

UNiagaraValidationRule_LWC

This validation rule checks for various issue with Large World Coordinates.

Public class UClass category, displayname

UNiagaraValidationRule_NoFixedDeltaTime

This validation rule is used by modules or effect types to warn that they don't support systems with fixed delta time ticks.

Public class UClass category, displayname

UNiagaraValidationRule_NoOpaqueRenderMaterial

This validation rule is used by the collision module to check that renderers don't use any opaque or masked materials when depth buffer collisions are used.

Public class UClass category, displayname

UNiagaraValidationRule_NoWarmupTime

This validation rule ensures that no Systems have a warm up time set.

Public class UClass category, displayname

UNiagaraValidationRule_SimulationStageBudget

This validation rule can be used to enforce a budget on the number of simulation stages and the iterations that may execute.

Public class UClass category, displayname

UNiagaraValidationRule_TickDependencyCheck

Validation rule to check that we don't have a tick dependency we don't want.

Public class UClass BlueprintType

UUpgradeNiagaraEmitterContext

Wrapper class for passing results back from the version upgrade python script.

Public class UClass BlueprintType

UUpgradeNiagaraScriptResults

Wrapper class for passing results back from the version upgrade python script.

Public class UClass MinimalAPI HideCategories

UVolumeCacheFactory

Factory for creating volume texture

Typedefs

Enums

Name

Description

Public enum UEnum

ENiagaraClipboardFunctionInputValueMode

Public enum UEnum

ENiagaraClipboardFunctionScriptMode

Public enum

ENiagaraDataObjectChange

Defines different types of changes to data objects within a niagara system.

Public enum

ENiagaraGraphActionType

This is the type of action that occurred on a given Niagara graph.

Public enum UEnum

ENiagaraMenuSections

Public enum UEnum

ENiagaraMessageSeverity

Public enum UEnum

ENiagaraNamespaceMetadataOptions

Public enum UEnum

ENiagaraPythonScriptInputSource

Public enum

ENiagaraStructureChangedFlags

Defines different flags to use in conjunction with OnStructureChanged delegates for stack entries and related classes.

Public enum

EParameterDefinitionMatchState

Defines a relationship of an FNiagaraVariable to a set of FNiagaraVariable parameter definitions.

Public enum UEnum

EScriptSource

Public enum

FNiagaraEditorUtilities::ETrackAssetResult

Public enum

FNiagaraParameterUtilities::EParameterContext

Functions

Name Description

Public function

bool

 

FNiagaraEditorUtilities::AddEmitterContextMenuActions

(
    FMenuBuilder& MenuBuilder,
    const TSharedPtr< FNiagaraEmitterHa...
)

Public function

const FGuid

 

FNiagaraEditorUtilities::AddEmitterToSystem

(
    UNiagaraSystem& InSystem,
    UNiagaraEmitter& InEmitterToAdd,
    FGuid EmitterVersion,
    bool bCreateCopy
)

Public function

bool

 

FNiagaraEditorUtilities::AddParameter

(
    FNiagaraVariable& NewParameterVari...,
    FNiagaraParameterStore& TargetPara...,
    UObject& ParameterStoreOwner,
    UNiagaraStackEditorData* Stack...
)

Adds a new Parameter to a target ParameterStore with an undo/redo transaction and name collision handling.

Public function

bool

 

FNiagaraEditorUtilities::AreTypesAssignable

(
    const FNiagaraTypeDefinition& Type...,
    const FNiagaraTypeDefinition& Type...
)

Public function

bool

 

FNiagaraEditorUtilities::ArrayMatchesSet

(
    const TArray< ElementType >& Array,
    const TSet< ElementType >& Set
)

TODO: Move this to TSet.

Public function

void

 

FNiagaraEditorUtilities::CompileExistingEmitters

(
    const TArray< FVersionedNiagaraEmit...
)

Public function

void

 

FNiagaraEditorUtilities::CopyDataTo

(
    FStructOnScope& DestinationStructO...,
    const FStructOnScope& SourceStruct...,
    bool bCheckTypes
)

Public function

void

 

FNiagaraEditorUtilities::CreateAssetFromEmitter

(
    TSharedRef< FNiagaraEmitterHandleVi...
)

Public function

TSharedPtr< ...

 

FNiagaraEditorUtilities::CreateInlineErrorText

(
    TAttribute< FText > ErrorMessage,
    TAttribute< FText > ErrorTooltip
)

Public function

bool

 

FNiagaraEditorUtilities::DataMatches

(
    const FStructOnScope& StructOnScop...,
    const FStructOnScope& StructOnScop...
)

Returns whether the data in two structs on scope matches.

Public function

bool

 

FNiagaraEditorUtilities::DataMatches

(
    const FNiagaraVariable& VariableA,
    const FNiagaraVariable& VariableB
)

Returns whether the data in two niagara variables match.

Public function

bool

 

FNiagaraEditorUtilities::DataMatches

(
    const FNiagaraVariable& Variable,
    const FStructOnScope& StructOnScop...
)

Returns whether the data in a niagara variable and a struct on scope match

Public function

TArray< FNam...

 

FNiagaraEditorUtilities::DecomposeVariableNamespace

(
    const FName& InVarNameToken,
    FName& OutName
)

Public function

bool

 

FNiagaraEditorUtilities::DoesItemMatchFilterText

(
    const FText& FilterText,
    const TSharedPtr< FNiagaraMenuActio...
)

Public function

TArray< UNia...

 

FNiagaraEditorUtilities::DowncastParameterDefinitionsBaseArray

(
    const TArray< UNiagaraParameterDefi...
)

Public function

TObjectPtr< ...

 

FNiagaraEditorUtilities::FindScriptVariableForUserParameter

(
    const FGuid& UserParameterGuid,
    UNiagaraSystem& System
)

Public function

void

 

FNiagaraEditorUtilities::FixUpNumericPins

(
    const UEdGraphSchema_Niagara* ...,
    UNiagaraNode* Node
)

Public function

void

 

FNiagaraEditorUtilities::FixUpPastedNodes

(
    UEdGraph* Graph,
    TSet< UEdGraphNode* > PastedNo...
)

Helper to clean up copy & pasted graphs.

Public function

FText

 

FNiagaraEditorUtilities::FormatScriptDescription

(
    FText Description,
    const FSoftObjectPath& Path,
    bool bIsInLibrary
)

Public function

FText

 

FNiagaraEditorUtilities::FormatScriptName

(
    FName Name,
    bool bIsInLibrary
)

Public function

FText

 

FNiagaraEditorUtilities::FormatVariableDescription

(
    FText Description,
    FText Name,
    FText Type
)

Public function

void

 

FNiagaraEditorUtilities::GatherChangeIds

(
    UNiagaraGraph& Graph,
    TMap< FGuid, FGuid >& ChangeIds,
    const FString& InDebugName,
    bool bWriteToLogDir
)

Gathers up the change Id's and optionally writes them to disk.

Public function

void

 

FNiagaraEditorUtilities::GatherChangeIds

(
    UNiagaraEmitter& Emitter,
    TMap< FGuid, FGuid >& ChangeIds,
    const FString& InDebugName,
    bool bWriteToLogDir
)

Gathers up the change Id's and optionally writes them to disk.

Public function

void

 

FNiagaraEditorUtilities::GetAllowedEmitterVariableTypes

(
    TArray< FNiagaraTypeDefinition >& ...
)

Gets a list of the registered emitter variable types which are allowed in the current editor context.

Public function

void

 

FNiagaraEditorUtilities::GetAllowedParameterTypes

(
    TArray< FNiagaraTypeDefinition >& ...
)

Gets a list of the registered parameter types which are allowed in the current editor context.

Public function

void

 

FNiagaraEditorUtilities::GetAllowedParticleVariableTypes

(
    TArray< FNiagaraTypeDefinition >& ...
)

Gets a list of the registered particle variable types which are allowed in the current editor context.

Public function

void

 

FNiagaraEditorUtilities::GetAllowedPayloadTypes

(
    TArray< FNiagaraTypeDefinition >& ...
)

Gets a list of the registered payload types which are allowed in the current editor context.

Public function

void

 

FNiagaraEditorUtilities::GetAllowedSystemVariableTypes

(
    TArray< FNiagaraTypeDefinition >& ...
)

Gets a list of the registered system variable types which are allowed in the current editor context.

Public function

void

 

FNiagaraEditorUtilities::GetAllowedUserVariableTypes

(
    TArray< FNiagaraTypeDefinition >& ...
)

Gets a list of the registered user variable types which are allowed in the current editor context.

Public function

TArray< UNia...

 

FNiagaraEditorUtilities::GetAllParameterDefinitions()

Convenience wrapper to get all discovered parameter definitions assets from asset registry.

Public function

bool

 

FNiagaraEditorUtilities::GetAvailableParameterDefinitions

(
    const TArray< FString >& ExternalP...,
    TArray< FAssetData >& OutParameter...
)

Public function

TArray< UNia...

 

FNiagaraEditorUtilities::GetComponentsThatReferenceSystem

(
    const UNiagaraSystem& ReferencedSy...
)

Public function

TArray< UNia...

 

FNiagaraEditorUtilities::GetComponentsThatReferenceSystemViewModel

(
    const FNiagaraSystemViewModel& Ref...
)

Public function

const FNiaga...

 

FNiagaraEditorUtilities::GetEmitterHandleForEmitter

(
    UNiagaraSystem& System,
    const FVersionedNiagaraEmitter& Em...
)

Gets an emitter handle from a system and an owned emitter.

Public function

void

 

FNiagaraEditorUtilities::GetFilteredScriptAssets

(
    FGetFilteredScriptAssetsOptions InF...,
    TArray< FAssetData >& OutFilteredS...
)

Public function

const FGuid ...

 

FNiagaraEditorUtilities::GetNamespaceIdForUsage

(
    ENiagaraScriptUsage Usage
)

Public function

FString

 

FNiagaraEditorUtilities::GetNamespacelessVariableNameString

(
    const FName& InVarName
)

Public function

const FNiaga...

 

FNiagaraEditorUtilities::GetNamespaceMetaDataForId

(
    const FGuid& NamespaceId
)

Public function

const FNiaga...

 

FNiagaraEditorUtilities::GetNamespaceMetaDataForVariableName

(
    const FName& VarName
)

Public function

int32

 

FNiagaraEditorUtilities::GetNamespaceMetaDataSortPriority

(
    const FNiagaraNamespaceMetadata& A,
    const FNiagaraNamespaceMetadata& B
)

Compare two FNiagaraNamespaceMetadata for the sort priority relative to the first argument A, where a lower number represents a higher priority.

Public function

int32

 

FNiagaraEditorUtilities::GetNamespaceSortPriority

(
    const FName& Namespace
)

Get the sort priority of a registered namespace FName, where a lower number represents a higher priority.

Public function

TSharedPtr< ...

 

FNiagaraEditorUtilities::GetOwningLibrarySubscriberViewModelForGraph

(
    const UNiagaraGraph* Graph
)

Public function

TArray< UNia...

 

FNiagaraEditorUtilities::GetParameterMapGetNodesWithUserParameter

(
    TSharedRef< FNiagaraEmitterViewMode...,
    FNiagaraVariable UserParameter
)

Public function

void

 

FNiagaraEditorUtilities::GetParameterVariablesFromSystem

(
    UNiagaraSystem& System,
    TArray< FNiagaraVariable >& Parame...,
    FGetParameterVariablesFromSystemOpt...
)

Gets the niagara variables for the input parameters on a niagara System.

Public function

int

 

FNiagaraEditorUtilities::GetReferencedAssetCount

(
    const FAssetData& SourceAsset,
    TFunction< ETrackAssetResult(const ...
)

Public function

TArray< FNia...

 

FNiagaraEditorUtilities::GetReferencedUserParametersFromEmitter

(
    TSharedRef< FNiagaraEmitterViewMode...
)

Public function

void

 

FNiagaraEditorUtilities::GetReferencingFunctionCallNodes

(
    UNiagaraScript* Script,
    TArray< UNiagaraNodeFunctionCall&#...
)

Public function

float

 

FNiagaraEditorUtilities::GetScalabilityTintAlpha

(
    FNiagaraEmitterHandle* Emitter...
)

Public function

ENiagaraScri...

 

FNiagaraEditorUtilities::GetScriptAssetVisibility

(
    const FAssetData& ScriptAssetData
)

Public function

UNiagaraScri...

 

FNiagaraEditorUtilities::GetScriptFromSystem

(
    UNiagaraSystem& System,
    FGuid EmitterHandleId,
    ENiagaraScriptUsage Usage,
    FGuid UsageId
)

Public function

UNiagaraNode...

 

FNiagaraEditorUtilities::GetScriptOutputNode

(
    UNiagaraScript& Script
)

Public function

TTuple< EScr...

 

FNiagaraEditorUtilities::GetScriptSource

(
    const FAssetData& ScriptAssetData
)

Public function

FLinearColor

 

FNiagaraEditorUtilities::GetScriptSourceColor

(
    EScriptSource ScriptSourceData
)

Public function

TObjectPtr< ...

 

FNiagaraEditorUtilities::GetScriptVariableForUserParameter

(
    const FNiagaraVariable& UserParame...,
    UNiagaraSystem& System
)

Public function

TObjectPtr< ...

 

FNiagaraEditorUtilities::GetScriptVariableForUserParameter

(
    const FNiagaraVariable& UserParame...,
    TSharedPtr< FNiagaraSystemViewModel...
)

Public function

ECheckBoxSta...

 

FNiagaraEditorUtilities::GetSelectedEmittersEnabledCheckState

(
    TSharedRef< FNiagaraSystemViewModel...
)

Public function

ECheckBoxSta...

 

FNiagaraEditorUtilities::GetSelectedEmittersIsolatedCheckState

(
    TSharedRef< FNiagaraSystemViewModel...
)

Public function

TSet< FName ...

 

FNiagaraEditorUtilities::GetSystemConstantNames()

Gets a set of the system constant names.

Public function

bool

 

FNiagaraEditorUtilities::GetTemplateSpecificationFromTag

(
    const FAssetData& Data,
    ENiagaraScriptTemplateSpecification...
)

Used instead of reading the template tag directly for backwards compatibility reasons when changing from a bool template specifier to an enum

Public function

void

 

FNiagaraEditorUtilities::GetTypeDefaultValue

(
    const FNiagaraTypeDefinition& Type,
    TArray< uint8 >& DefaultData
)

Fills DefaultData with the types default, either based on the struct, or if available through registered type utilities.

Public function

FText

 

FNiagaraEditorUtilities::GetTypeDefinitionCategory

(
    const FNiagaraTypeDefinition& Type...
)

Public function

FName

 

FNiagaraEditorUtilities::GetUniqueObjectName

(
    UObject* Outer,
    UClass* ObjectClass,
    const FString& CandidateName
)

Public function

FName

 

FNiagaraEditorUtilities::GetUniqueObjectName

(
    UObject* Outer,
    const FString& CandidateName
)

Public function

TArray< FNia...

 

FNiagaraEditorUtilities::GetUserParameterBindingsForUserParameter

(
    TSharedRef< FNiagaraEmitterViewMode...,
    FNiagaraVariable UserParameter
)

Public function

bool

 

FNiagaraEditorUtilities::GetVariableSortPriority

(
    const FName& VarNameA,
    const FName& VarNameB
)

Compare two FNiagaraVariable names for the sort priority relative to the first argument VarNameA. Sorting is ordered by namespace and then alphabetized.

Public function

FText

 

FNiagaraEditorUtilities::GetVariableTypeCategory

(
    const FNiagaraVariable& Variable
)

Public function

int32

 

FNiagaraEditorUtilities::GetWeightForItem

(
    const TSharedPtr< FNiagaraMenuActio...,
    const TArray< FString >& FilterTer...
)

Public function

void

 

FNiagaraEditorUtilities::InfoWithToastAndLog

(
    FText WarningMessage,
    float ToastDuration
)

Public function

void

 

FNiagaraEditorUtilities::InitializeParameterInputNode

(
    UNiagaraNodeInput& InputNode,
    const FNiagaraTypeDefinition& Type,
    const UNiagaraGraph* Graph,
    FName InputName
)

Sets up a niagara input node for parameter usage.

Public function

bool

 

FNiagaraEditorUtilities::IsCompilableAssetClass

(
    UClass* AssetClass
)

Public function

bool

 

FNiagaraEditorUtilities::IsEnginePluginAsset

(
    const FAssetData& InAssetData
)

Public function

bool

 

FNiagaraEditorUtilities::IsEnumIndexVisible

(
    const UEnum* Enum,
    int32 Index
)

Public function

bool

 

FNiagaraEditorUtilities::IsScriptAssetInLibrary

(
    const FAssetData& ScriptAssetData
)

Public function

void

 

FNiagaraEditorUtilities::KillSystemInstances

(
    const UNiagaraSystem& System
)

Kills all system instances using the referenced system.

Public function

void

 

FNiagaraEditorUtilities::MarkDependentCompilableAssetsDirty

(
    const TArray< FAssetData >& InAsse...
)

Public function

void

 

FNiagaraEditorUtilities::MarkDependentCompilableAssetsDirty

(
    TArray< UObject* > InObjects
)

Public function

bool

 

FNiagaraEditorUtilities::NestedPropertiesAppendCompileHash

(
    const void* Container,
    const UStruct* Struct,
    EFieldIteratorFlags::SuperClassFlag...,
    FStringView BaseName,
    FNiagaraCompileHashVisitor* In...
)

Public function

void

 

FNiagaraEditorUtilities::OpenParentEmitterForEdit

(
    TSharedRef< FNiagaraEmitterViewMode...
)

Public function

bool

 

FNiagaraEditorUtilities::PODPropertyAppendCompileHash

(
    const void* Container,
    FProperty* Property,
    FStringView PropertyName,
    FNiagaraCompileHashVisitor* In...
)

Public function

void

 

FNiagaraEditorUtilities::PreprocessFunctionGraph

(
    const UEdGraphSchema_Niagara* ...,
    UNiagaraGraph* Graph,
    TArrayView< UEdGraphPin*const ...,
    TArrayView< UEdGraphPin*const ...,
    ENiagaraScriptUsage ScriptUsage,
    const FCompileConstantResolver& Co...
)

Public function

void

 

FNiagaraEditorUtilities::RecomposeVariableNamespace

(
    const FName& InVarNameToken,
    const TArray< FName >& InParentNam...,
    FName& OutName
)

Public function

void

 

FNiagaraEditorUtilities::RefreshAllScriptsFromExternalChanges

(
    FRefreshAllScriptsFromExternalChang...
)

Public function

void

 

FNiagaraEditorUtilities::RemoveEmittersFromSystemByEmitterHandleId

(
    UNiagaraSystem& InSystem,
    TSet< FGuid > EmitterHandleIdsToDel...
)

Public function

void

 

FNiagaraEditorUtilities::ReplaceUserParameterReferences

(
    TSharedRef< FNiagaraEmitterViewMode...,
    FNiagaraVariable OldUserParameter,
    FNiagaraVariable NewUserParameter
)

Public function

void

 

FNiagaraEditorUtilities::ResetSystemsThatReferenceSystemViewModel

(
    const FNiagaraSystemViewModel& Ref...
)

Public function

void

 

FNiagaraEditorUtilities::ResetVariableToDefaultValue

(
    FNiagaraVariable& Variable
)

Resets the variables value to default, either based on the struct, or if available through registered type utilities.

Public function

bool

 

FNiagaraEditorUtilities::ResolveConstantValue

(
    UEdGraphPin* Pin,
    int32& Value
)

Public function

void

 

FNiagaraEditorUtilities::ResolveNumerics

(
    UNiagaraGraph* SourceGraph,
    bool bForceParametersToResolveNumer...,
    TArray< FNiagaraVariable >& Change...
)

Public function

void

 

FNiagaraEditorUtilities::RunPythonUpgradeScripts

(
    UUpgradeNiagaraEmitterContext*...
)

Executes python upgrade scripts on the given source node for all the given in-between versions.

Public function

void

 

FNiagaraEditorUtilities::RunPythonUpgradeScripts

(
    UNiagaraNodeFunctionCall* Sour...,
    const TArray< FVersionedNiagaraScri...,
    const FNiagaraScriptVersionUpgradeC...,
    FString& OutWarnings
)

Executes python upgrade scripts on the given source node for all the given in-between versions.

Public function

bool

 

FNiagaraEditorUtilities::SetsMatch

(
    const TSet< ElementType >& SetA,
    const TSet< ElementType >& SetB
)

TODO: Move this to TSet.

Public function

void

 

FNiagaraEditorUtilities::SetStaticSwitchConstants

(
    UNiagaraGraph* Graph,
    TArrayView< UEdGraphPin*const ...,
    const FCompileConstantResolver& Co...
)

Public function

void

 

FNiagaraEditorUtilities::ShowParentEmitterInContentBrowser

(
    TSharedRef< FNiagaraEmitterViewMode...
)

Public function

TSharedPtr< ...

 

FNiagaraEditorUtilities::StaticSwitchDefaultIntToStructOnScope

(
    int32 InStaticSwitchDefaultValue,
    FNiagaraTypeDefinition InSwitchType
)

Public function

FText

 

FNiagaraEditorUtilities::StatusToText

(
    ENiagaraScriptCompileStatus Status
)

Helper to convert compile status to text.

Public function

void

 

FNiagaraEditorUtilities::SwitchParentEmitterVersion

(
    TSharedRef< FNiagaraEmitterViewMode...,
    TSharedRef< FNiagaraSystemViewModel...,
    const FGuid& NewVersionGuid
)

Changes the referenced parent version and optionally runs the python upgrade scripts.

Public function

void

 

FNiagaraEditorUtilities::ToggleSelectedEmittersEnabled

(
    TSharedRef< FNiagaraSystemViewModel...
)

Public function

void

 

FNiagaraEditorUtilities::ToggleSelectedEmittersIsolated

(
    TSharedRef< FNiagaraSystemViewModel...
)

Public function

bool

 

FNiagaraEditorUtilities::TryGetEventDisplayName

(
    UNiagaraEmitter* Emitter,
    FGuid EventUsageId,
    FText& OutEventDisplayName
)

Public function

ENiagaraScri...

 

FNiagaraEditorUtilities::UnionCompileStatus

(
    const ENiagaraScriptCompileStatus&...,
    const ENiagaraScriptCompileStatus&...
)

Helper method to union two distinct compiler statuses.

Public function

bool

 

FNiagaraEditorUtilities::VerifyNameChangeForInputOrOutputNode

(
    const UNiagaraNode& NodeBeingChang...,
    FName OldName,
    FString NewName,
    FText& OutErrorMessage
)

Public function

void

 

FNiagaraEditorUtilities::VisitAllNodesConnectedToInputs

(
    UEdGraphNode* StartNode,
    FNodeVisitor Visitor
)

Public function

void

 

FNiagaraEditorUtilities::WarnWithToastAndLog

(
    FText WarningMessage
)

Public function

void

 

FNiagaraEditorUtilities::WriteTextFileToDisk

(
    FString SaveDirectory,
    FString FileName,
    FString TextToSave,
    bool bAllowOverwriting
)

Writes text to a specified location on disk.

Public function

FText

 

FNiagaraMessageUtilities::GetShortDescriptionFromSeverity

(
    EStackIssueSeverity Severity
)

Public function

FText

 

FNiagaraMessageUtilities::MakePostCompileSummaryText

(
    const FText& CompileObjectNameText,
    ENiagaraScriptCompileStatus LatestC...,
    const int32& WarningCount,
    const int32& ErrorCount
)

Public function

UNiagaraStac...

 

FNiagaraMessageUtilities::MessageToStackIssue

(
    TSharedRef< const INiagaraMessage >...,
    FString InStackEditorDataKey
)

Public function

UNiagaraStac...

 

FNiagaraMessageUtilities::StackMessageToStackIssue

(
    const FNiagaraStackMessage& InMess...,
    FString InStackEditorDataKey,
    const TArray< FLinkNameAndDelegate ...
)

Public function

TArray< cons...

 

FNiagaraParameterDefinitionsUtilities::FindReservedParametersByName

(
    const FName ParameterName
)

Public function

EParameterDe...

 

FNiagaraParameterDefinitionsUtilities::GetDefinitionMatchStateForParameter

(
    const FNiagaraVariableBase& Parame...
)

Public function

int32

 

FNiagaraParameterDefinitionsUtilities::GetNumParametersReservedForName

(
    const FName ParameterName
)

Public function

void

 

FNiagaraParameterDefinitionsUtilities::TrySubscribeScriptVarToDefinitionByName

(
    UNiagaraScriptVariable* Script...,
    INiagaraParameterDefinitionsSubscri...
)

Public function

FName

 

FNiagaraParameterUtilities::ChangeNamespace

(
    FName ParameterName,
    const FNiagaraNamespaceMetadata& N...
)

Public function

TSharedRef< ...

 

FNiagaraParameterUtilities::CreateNamespaceMenuItemWidget

(
    FName Namespace,
    FText ToolTip
)

Public function

bool

 

FNiagaraParameterUtilities::DoesParameterNameMatchSearchText

(
    FName ParameterName,
    const FString& SearchTextString
)

Public function

void

 

FNiagaraParameterUtilities::FilterToRelevantStaticVariables

(
    const TArray< FNiagaraVariable >& ...,
    TArray< FNiagaraVariable >& OutVar...,
    FName InOldEmitterAlias,
    FName InNewEmitterAlias,
    bool bFilterByEmitterAliasAndConver...
)

Public function

FText

 

FNiagaraParameterUtilities::FormatParameterNameForTextDisplay

(
    FName ParameterName
)

Public function

void

 

FNiagaraParameterUtilities::GetChangeNamespaceMenuData

(
    FName InParameterName,
    EParameterContext InParameterContex...,
    TArray< FChangeNamespaceMenuData > ...
)

Public function

FName

 

FNiagaraParameterUtilities::GetEditableNamespaceModifierForParameter

(
    FName ParameterName
)

Public function

bool

 

FNiagaraParameterUtilities::GetNamespaceEditData

(
    FName InParameterName,
    FNiagaraParameterHandle& OutParame...,
    FNiagaraNamespaceMetadata& OutName...,
    FText& OutErrorMessage
)

Public function

bool

 

FNiagaraParameterUtilities::GetNamespaceModifierEditData

(
    FName InParameterName,
    FNiagaraParameterHandle& OutParame...,
    FNiagaraNamespaceMetadata& OutName...,
    FText& OutErrorMessage
)

Public function

int32

 

FNiagaraParameterUtilities::GetNumberOfNamePartsBeforeEditableModifier

(
    const FNiagaraNamespaceMetadata& N...
)

Public function

void

 

FNiagaraParameterUtilities::GetOptionalNamespaceModifiers

(
    FName ParameterName,
    EParameterContext InParameterContex...,
    TArray< FName >& OutOptionalNamesp...
)

Public function

TSharedRef< ...

 

FNiagaraParameterUtilities::GetParameterWidget

(
    FNiagaraVariable Variable,
    bool bAddTypeIcon,
    bool bShowValue
)

Public function

TSharedRef< ...

 

FNiagaraParameterUtilities::GetTooltipWidget

(
    FNiagaraVariable Variable,
    bool bShowValue,
    TSharedPtr< SWidget > AdditionalVer...,
    TSharedPtr< SWidget > AdditionalHor...
)

Creates a tooltip based on a parameter. Also shows the value, if allocated and enabled.

Public function

FName

 

FNiagaraParameterUtilities::SetCustomNamespaceModifier

(
    FName InParameterName
)

Public function

FName

 

FNiagaraParameterUtilities::SetCustomNamespaceModifier

(
    FName InParameterName,
    TSet< FName >& CurrentParameterNam...
)

Public function

FName

 

FNiagaraParameterUtilities::SetSpecificNamespaceModifier

(
    FName InParameterName,
    FName InNamespaceModifier
)

Public function

bool

 

FNiagaraParameterUtilities::TestCanChangeNamespaceWithMessage

(
    FName ParameterName,
    const FNiagaraNamespaceMetadata& N...,
    FText& OutMessage
)

Public function

bool

 

FNiagaraParameterUtilities::TestCanRenameWithMessage

(
    FName ParameterName,
    FText& OutMessage
)

Public function

bool

 

FNiagaraParameterUtilities::TestCanSetCustomNamespaceModifierWithMessage

(
    FName InParameterName,
    FText& OutMessage
)

Public function

bool

 

FNiagaraParameterUtilities::TestCanSetSpecificNamespaceModifierWithMessage

(
    FName InParameterName,
    FName InNamespaceModifier,
    FText& OutMessage
)

Public function

uint32

 

GetTypeHash

(
    const FReservedParameter& Reserved...
)

Public function

uint32

 

GetTypeHash

(
    const FNiagaraNamespaceMetadata& N...
)

Public function

bool

 

NiagaraValidation::HasValidationRules

(
    UNiagaraSystem* NiagaraSystem
)

Public function

void

 

NiagaraValidation::ValidateAllRulesInSystem

(
    TSharedPtr< FNiagaraSystemViewModel...,
    TFunction< void(const FNiagaraValid...
)

Variables

Name Description

Public variable

const FGuid

 

DataInstanceNamespaceMetaDataGuid

Public variable

const FGuid

 

EmitterNamespaceMetaDataGuid

Public variable

const FGuid

 

EngineNamespaceMetaDataGuid

Public variable

int32

 

GbPreloadSelectablePluginAssetsOnDemand

Public variable

int32

 

GbShowNiagaraDeveloperWindows

Public variable

const FGuid

 

ModuleLocalNamespaceMetaDataGuid

Public variable

const FGuid

 

ModuleNamespaceMetaDataGuid

Public variable

const FGuid

 

ModuleOutputNamespaceMetaDataGuid

Public variable

const FGuid

 

ParameterCollectionNamespaceMetaDataGuid

Public variable

const FGuid

 

ParticleAttributeNamespaceMetaDataGuid

Public variable

const FGuid

 

StackContextNamespaceMetaDataGuid

Public variable

 

STATCAT_Advanced

Public variable

const FGuid

 

StaticSwitchNamespaceMetaDataGuid

Public variable

const FGuid

 

SystemNamespaceMetaDataGuid

Public variable

const FGuid

 

TransientNamespaceMetaDataGuid

Public variable

const FGuid

 

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