UNiagaraExternalEditUtilities

A C++ and Blueprint accessible library of functions allowing for the inspection and modification of Niagara Systems.

API > API/Plugins > API/Plugins/NiagaraEditor

A C++ and Blueprint accessible library of functions allowing for the inspection and modification of Niagara Systems.

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

Syntax

UCLASS (MinimalAPI)  
class UNiagaraExternalEditUtilities : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void AddEmitter ( UNiagaraEmitter* TemplateEmitter,
FName EmitterName,
FNiagaraExt_EmitterTopology& OutTopology,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void AddModule ( const FNiagaraExt_StackItemReference& NewModuleLocationRef,
const UNiagaraScript* ModuleAsset,
FNiagaraExt_ModuleTopology& OutTopology,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void AddRenderer ( const FNiagaraExt_StackItemReference& NewRendererLocation,
const TSubclassOf< UNiagaraRendererProperties > RendererClass,
FNiagaraExt_RendererRef& OutRef,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void AddSetParameterEntry ( const FNiagaraExt_StackItemReference& ModuleRef,
const FNiagaraExt_SetParameterEntry& Entry,
FNiagaraExt_ModuleTopology& OutTopology,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void AddSetParametersModule ( const FNiagaraExt_StackItemReference& NewModuleLocationRef,
const TArray< FNiagaraExt_SetParameterEntry >& Parameters,
FNiagaraExt_ModuleTopology& OutTopology,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void AddUserVariable ( UNiagaraSystem* System,
const FNiagaraExt_UserVariable& Variable,
FNiagaraExternalEditContext& Context
)

 Edit Operations. NiagaraExternalSystemEditorUtilities.h  

static void ApplyStackIssueFix ( UNiagaraSystem* System,
const FString& IssueId,
const FString& FixId,
FNiagaraExt_ApplyStackIssueFixResult& OutResult,
FNiagaraExternalEditContext& Context
)

 Re-locates a live stack issue/fix pair by IssueId+FixId and executes the Fix-style delegate inside a scoped transaction. NiagaraExternalSystemEditorUtilities.h  

static bool BuildParameterMapHistoriesFromScript ( const UNiagaraScript* Script,
TArray< FNiagaraParameterMapHistory >& OutHistories,
FNiagaraExternalEditContext& Context
)

 Builds parameter map histories for a script allowing some inspection of script schemas without needing an owning system. NiagaraExternalSystemEditorUtilities.h  

static void CollectStackIssues ( FNiagaraSystemViewModel& SystemVM,
UNiagaraSystem* System,
FNiagaraExt_StackIssues& OutIssues
)

 Walks all stack view models and collects issues into OutIssues, including dismissed ones. NiagaraExternalSystemEditorUtilities.h  

static UNiagaraSystem * CreateNiagaraSystem ( const FString& AssetName,
const FString& AssetPath,
UNiagaraSystem* TemplateSystem,
FNiagaraExternalEditContext& Context
)

 Creates a new Niagara System asset. NiagaraExternalSystemEditorUtilities.h  

static void EnumerateSystemScripts ( UNiagaraSystem* System,
TArray< FNiagaraExt_ScriptCompileInfo >& OutScripts
)

 Enumerates all compilable scripts in the system in canonical order and populates OutScripts. NiagaraExternalSystemEditorUtilities.h  

static void GetAvailableDynamicInputs ( const FNiagaraTypeDefinition& Type,
TArray< UNiagaraScript* >& OutDynamicInputScripts,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetDataInterfaceSchema ( TSubclassOf< UNiagaraDataInterface > DataInterfaceClass,
FNiagaraExt_DataInterfaceSchema& OutSchema
)

   NiagaraExternalSystemEditorUtilities.h  
Returns the full recursive chain for a dynamic input: topology metadata and resolved values at every level. NiagaraExternalSystemEditorUtilities.h  

static void GetDynamicInputSchema ( const UNiagaraScript* ModuleAsset,
FNiagaraExt_DynamicInputSchema& OutSchema,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetDynamicInputSchema ( const FNiagaraExt_StackItemReference& DynamicInputReference,
FNiagaraExt_DynamicInputSchema& OutSchema,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetEmitterData ( const FNiagaraExt_StackItemReference& EmitterRef,
FNiagaraExt_EmitterData& OutData,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetEmitterDataInternal ( UNiagaraSystem* System,
FNiagaraEmitterHandle& Emitter,
FNiagaraExt_EmitterData& OutData,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  
Data tier (scope-level) ------------------------------------------ Resolved input values across all modules in the given scope. NiagaraExternalSystemEditorUtilities.h  

static void GetEmitterSchema ( FNiagaraExt_EmitterSchema& OutSchema
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetEmitterSummary ( const FNiagaraExt_StackItemReference& EmitterRef,
FNiagaraExt_EmitterSummary& OutSummary,
FNiagaraExternalEditContext& Context
)

 Returns emitter metadata: name, enabled, sim target, de-duplicated renderer classes. NiagaraExternalSystemEditorUtilities.h  
Topology tier ---------------------------------------------------- Full structural walk. NiagaraExternalSystemEditorUtilities.h  

static void GetModuleInputValues ( const FNiagaraExt_StackItemReference& ModuleRef,
FNiagaraExt_ModuleInputValues& OutValues,
FNiagaraExternalEditContext& Context
)

 Returns resolved input values for a single module. NiagaraExternalSystemEditorUtilities.h  

static void GetModuleSchema ( const FNiagaraExt_StackItemReference& ModuleReference,
FNiagaraExt_ModuleSchema& OutSchema,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetModuleSchema ( const UNiagaraScript* ModuleAsset,
FNiagaraExt_ModuleSchema& OutSchema,
FNiagaraExternalEditContext& Context
)

 Static void GetStackInputSchema(const TObjectPtr ModuleAsset, FNiagaraExt_Variable& Input, FNiagaraExt_StackInputSchema& OutSchema); NiagaraExternalSystemEditorUtilities.h  

static void GetModuleTopology ( const FNiagaraExt_StackItemReference& ModuleRef,
FNiagaraExt_ModuleTopology& OutTopology,
FNiagaraExternalEditContext& Context
)

 Returns module topology: metadata and all inputs (name/type/visibility only, no values). NiagaraExternalSystemEditorUtilities.h  

static void GetRendererData ( const FNiagaraExt_StackItemReference& RendererRef,
FNiagaraExt_RendererData& OutData,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetRendererDataInternal ( FNiagaraEmitterHandle& Emitter,
UNiagaraRendererProperties* Renderer,
FNiagaraExt_RendererData& OutData,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetRendererSchema ( TSubclassOf< UNiagaraRendererProperties > RendererClass,
FNiagaraExt_RendererSchema& OutSchema
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetScriptStackInputValues ( const FNiagaraExt_StackItemReference& ScriptRef,
TArray< FNiagaraExt_ModuleInputValues >& OutValues,
FNiagaraExternalEditContext& Context
)

 Returns all resolved input values for every module in the given script stack. NiagaraExternalSystemEditorUtilities.h  

static void GetScriptStackTopology ( const FNiagaraExt_StackItemReference& ScriptRef,
FNiagaraExt_ScriptStackTopology& OutTopology,
FNiagaraExternalEditContext& Context
)

 Returns script stack topology: all modules and their inputs in execution order. NiagaraExternalSystemEditorUtilities.h  

static void GetStackInputData ( const FNiagaraExt_StackItemReference& StackInputRef,
FNiagaraExt_StackInputValue& OutData,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetStackInputSchema ( const FNiagaraExt_StackItemReference& InputReference,
FNiagaraExt_StackInputSchema& OutSchema,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetStackInputTopology ( const FNiagaraExt_StackItemReference& StackInputRef,
FNiagaraExt_StackInputTopology& OutTopology,
FNiagaraExternalEditContext& Context
)

 Returns stack input topology: name, type, visibility, editability. No value payload. NiagaraExternalSystemEditorUtilities.h  
Collects all stack issues (errors, warnings, info) from the system and emitter stacks. NiagaraExternalSystemEditorUtilities.h  
Reads the aggregate and per-script compile state of a Niagara System without triggering a recompile. NiagaraExternalSystemEditorUtilities.h  

static void GetSystemData ( UNiagaraSystem* System,
FNiagaraExt_SystemData& OutData,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void GetSystemDependencies ( UNiagaraSystem* System,
FNiagaraExt_SystemDependencies& OutDependencies,
FNiagaraExternalEditContext& Context
)

 Returns the four Used* sets (renderers, data interfaces, modules, dynamic inputs) gathered across all emitters. NiagaraExternalSystemEditorUtilities.h  

static void GetSystemSchema ( FNiagaraExt_SystemSchema& OutSchema
)

 Schemas Layer - Defines constant data about editable properties and inputs based on specific classes or assets rather than a specific System being edited. NiagaraExternalSystemEditorUtilities.h  
Summary tier ----------------------------------------------------- Cheap metadata-only calls. NiagaraExternalSystemEditorUtilities.h  

static void GetUserVariables ( UNiagaraSystem* System,
FNiagaraExt_UserVariables& OutVariables,
FNiagaraExternalEditContext& Context
)

 Data - Access actual data values of Systems, Emitters and module inputs. NiagaraExternalSystemEditorUtilities.h  

static void RemoveEmitter ( const FNiagaraExt_StackItemReference& EmitterToRemoveRef,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void RemoveModule ( const FNiagaraExt_StackItemReference& ModuleToRemove,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void RemoveRenderer ( const FNiagaraExt_StackItemReference& RendererToRemove,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void RemoveSetParameterEntry ( const FNiagaraExt_StackItemReference& ModuleRef,
FName ParameterName,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void RemoveUserVariable ( UNiagaraSystem* System,
const FNiagaraExt_Variable& Variable,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void SetEmitterData ( const FNiagaraExt_StackItemReference& EmitterItemRef,
const FNiagaraExt_EmitterData& InData,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void SetModuleEnabled ( const FNiagaraExt_StackItemReference& ModuleRef,
bool bEnabled,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void SetRendererData ( const FNiagaraExt_StackItemReference& RendererItemRef,
const FNiagaraExt_RendererData& InData,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void SetStackInputData ( const FNiagaraExt_StackItemReference& StackItemRef,
const FNiagaraExt_StackInputValue& InData,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void SetSystemData ( UNiagaraSystem* System,
const FNiagaraExt_SystemData& InData,
FNiagaraExternalEditContext& Context
)

   NiagaraExternalSystemEditorUtilities.h  

static void WalkDynamicInputChain ( UNiagaraStackFunctionInput* Input,
const FNiagaraExt_StackItemReference& InputRef,
FNiagaraExt_DynamicInputChainRef& OutChain,
FNiagaraExternalEditContext& Context
)

 Internal helper for dynamic-input chain walk. NiagaraExternalSystemEditorUtilities.h  

static void WalkScriptStackForInputValues ( const FNiagaraExt_StackItemReference& ScriptRef,
TArray< FNiagaraExt_ModuleInputValues >& OutValues,
FNiagaraExternalEditContext& Context
)

 Internal helpers for walk recursion. NiagaraExternalSystemEditorUtilities.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page