1. Epic GamesDeveloper
  3. UNiagaraEmitterConversionContext

UNiagaraEmitterConversionContext

Wrapper for modifying a [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) by adding Scripts and Renderers through UNiagaraScriptConversionContexts and [UNiagaraRendererProperties](API\Plugins\Niagara\UNiagaraRendererProperties), respectively.

API > API/Plugins > API/Plugins/CascadeToNiagaraConverter

Wrapper for modifying a UNiagaraEmitter by adding Scripts and Renderers through UNiagaraScriptConversionContexts and UNiagaraRendererProperties, respectively.

   
Name UNiagaraEmitterConversionContext
Type class
Header File /Engine/Plugins/FX/CascadeToNiagaraConverter/Source/CascadeToNiagaraConverter/Public/NiagaraStackGraphUtilitiesAdapterLibrary.h
Include Path #include "NiagaraStackGraphUtilitiesAdapterLibrary.h"

Syntax

UCLASS (BlueprintInternalUseOnly)  
class UNiagaraEmitterConversionContext : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraEmitterConversionContext()

   NiagaraStackGraphUtilitiesAdapterLibrary.h  

Classes

Name Remarks
FOnPasteScript  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnabled bool   NiagaraStackGraphUtilitiesAdapterLibrary.h  
Emitter FVersionedNiagaraEmitter   NiagaraStackGraphUtilitiesAdapterLibrary.h  
EmitterHandleViewModel TSharedPtr< FNiagaraEmitterHandleViewModel >   NiagaraStackGraphUtilitiesAdapterLibrary.h  
EmitterMessages TArray< FGenericConverterMessage >   NiagaraStackGraphUtilitiesAdapterLibrary.h  
EventHandlerAddActions TArray< FNiagaraEventHandlerAddAction >   NiagaraStackGraphUtilitiesAdapterLibrary.h  
PastedFunctionCallNode TObjectPtr< UNiagaraNodeFunctionCall >   NiagaraStackGraphUtilitiesAdapterLibrary.h  
RendererNameToStagedRendererPropertiesMap TMap< FString, TObjectPtr< UNiagaraRendererProperties > >   NiagaraStackGraphUtilitiesAdapterLibrary.h  
StackEntryAddActions TArray< FStackEntryAddAction >   NiagaraStackGraphUtilitiesAdapterLibrary.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddEventHandler ( FNiagaraEventHandlerAddAction EventScriptPropertiesBP
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void AddModuleEventScript ( FString ScriptNameString,
UNiagaraScriptConversionContext* ScriptConversionContext,
FNiagaraEventHandlerAddAction EventScriptProps
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void AddModuleScript ( FString ScriptNameString,
UNiagaraScriptConversionContext* ScriptConversionContext,
EScriptExecutionCategory ModuleScriptExecutionCategory
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void AddRenderer ( FString RendererNameString,
UNiagaraRendererProperties* NewRendererProperties
)

 Add a renderer to this emitter conversion context through renderer properties. NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void Cleanup()

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void Finalize()

 Apply all pending UNiagaraScriptConversionContexts and UNiagaraRendererProperties to this UNiagaraEmitterContext by creating clipboard inputs and pasting them onto the emitter conversion context's Emitter. NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

UNiagaraScriptConversionContext * FindModuleScript ( FString ScriptNameString
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"
Find a module script conversion context or add a module script conversion context to this emitter conversion context for an event category. NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

UNiagaraScriptConversionContext * FindOrAddModuleScript ( FString ScriptNameString,
FCreateScriptContextArgs CreateScriptContextArgs,
EScriptExecutionCategory ModuleScriptExecutionCategory
)

 Find or add a script conversion context to this emitter conversion context. NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

UNiagaraRendererProperties * FindRenderer ( FString RendererNameString
)

 Find an added renderer properties by name string. NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

TArray< UNiagaraRendererProperties * > GetAllRenderers()

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

UNiagaraEmitter * GetEmitter()

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

FGuid GetEmitterHandleId()

   NiagaraStackGraphUtilitiesAdapterLibrary.h  

bool GetEnabled()

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void Init ( FVersionedNiagaraEmitter InEmitter,
const TSharedPtr< FNiagaraEmitterHandleViewModel >& InEmitterHandleViewModel
)

 Init the Emitter Conversion Context. NiagaraStackGraphUtilitiesAdapterLibrary.h  

void InternalFinalizeEvents ( UNiagaraSystemConversionContext* OwningSystemConversionContext
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h  

void InternalFinalizeStackEntryAddActions()

   NiagaraStackGraphUtilitiesAdapterLibrary.h  

void Log ( FString Message,
ENiagaraMessageSeverity Severity,
bool bIsVerbose
)

 Log a message to the niagara message log for the emitter. NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void RemoveModuleScriptsForAssets ( TArray< FAssetData > ScriptsToRemove
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void SetDetailBitMask ( int32 BitMask
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void SetEnabled ( bool bInEnabled
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void SetLocalSpace ( bool bLocalSpace
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void SetParameterDirectly ( FString ParameterNameString,
UNiagaraScriptConversionContextInput* ParameterInput,
EScriptExecutionCategory SetParameterExecutionCategory
)

 Add a set parameter module to the emitter handled by this emitter conversion context. NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void SetRendererBinding ( UNiagaraRendererProperties* InRendererProperties,
FName BindingName,
FName VariableToBindName,
ENiagaraRendererSourceDataMode SourceDataMode
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

void SetSimTarget ( ENiagaraSimTarget InTarget
)

   NiagaraStackGraphUtilitiesAdapterLibrary.h
  • BlueprintCallable
  • Category="FXConverterUtilities"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page