UNiagaraScriptSource | Unreal Engine 5.5 Documentation

API > API/Plugins > API/Plugins/NiagaraEditor

Inheritance Hierarchy

References


Module	NiagaraEditor
Header	/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraScriptSource.h
Include	#include "NiagaraScriptSource.h"

Syntax

UCLASS (MinimalAPI)  
class UNiagaraScriptSource : public UNiagaraScriptSourceBase

Variables

Type	Name	Description
bool	bIsCompilationCopy
bool	bIsReleased
TObjectPtr< class UNiagaraGraph >	NodeGraph	Graph for particle update expression

Functions

	Type	Name	Description
	UNiagaraScriptSource *	CreateCompilationCopy ( const TArray< ENiagaraScriptUsage >& CompileUsages )
	void	FixupRenamedParameters ( UNiagaraNodeFunctionCall* FunctionCallNode, TConstArrayView< FNiagaraVariable > ModuleInputVariables, FNiagaraParameterStore& RapidIterationParameters, const TArray< FNiagaraVariable >& OldRapidIterationVariables, const FVersionedNiagaraEmitter& Emitter, ENiagaraScriptUsage ScriptUsage )
	FVersionedNiagaraEmitter	GetOuterEmitter ()
	void	InitializeNewParameters ( UNiagaraNodeFunctionCall* FunctionCallNode, TConstArrayView< FNiagaraVariable > ModuleInputVariables, FNiagaraParameterStore& RapidIterationParameters, const FVersionedNiagaraEmitter& VersionedEmitter, ENiagaraScriptUsage ScriptUsage, TSet< FNiagaraVariableBase >& ValidRapidIterationParameters )
	void	ReleaseCompilationCopy ()

Overridden from UNiagaraScriptSourceBase

Type	Name	Description
bool	AddModuleIfMissing ( FString ModulePath, ENiagaraScriptUsage Usage, bool& bOutFoundModule )	Adds a module if it isn't already in the graph.
void	ChangedLinkedInputTypes ( const FNiagaraVariable& ParametersToChange, const FNiagaraTypeDefinition& NewType )
void	CleanUpOldAndInitializeNewRapidIterationParameters ( const FVersionedNiagaraEmitter& Emitter, ENiagaraScriptUsage ScriptUsage, FGuid ScriptUsageId, FNiagaraParameterStore& RapidIterationParameters )
void	CollectDataInterfaces ( TArray< const UNiagaraDataInterfaceBase* >& DataInterfaces )
TMap< FName, UNiagaraDataInterface * >	ComputeObjectNameMap ( UNiagaraSystem& System, ENiagaraScriptUsage Usage, FGuid UsageId, FString EmitterUniqueName )
void	ComputeVMCompilationId ( FNiagaraVMExecutableDataId& Id, FNiagaraScriptHashCollector& HashCollector, ENiagaraScriptUsage InUsage, const FGuid& InUsageId )
void	ForceGraphToRecompileOnNextCheck ()
FGuid	GetChangeID ()
FGuid	GetCompileBaseId ( ENiagaraScriptUsage InUsage, const FGuid& InUsageId )
FNiagaraCompileHash	GetCompileHash ( ENiagaraScriptUsage InUsage, const FGuid& InUsageId )
void	GetLinkedPositionTypeInputs ( const TArray< FNiagaraVariable >& ParametersToCheck, TSet< FNiagaraVariable >& OutLinkedParameters )	Checks if any of the provided variables are linked to function inputs of position type data
bool	IsSynchronized ( const FGuid& InChangeId )	Virtual ENiagaraScriptCompileStatus Compile(UNiagaraScript* ScriptOwner, FString& OutGraphLevelErrorMessages) override;
void	MarkNotSynchronized ( FString Reason )	Enforce that the source graph is now out of sync with the script.
void	PostLoadFromEmitter ( FVersionedNiagaraEmitter OwningEmitter )	Allows the derived editor only script source to handle a post load requested by an owning emitter.
void	PostLoadFromOwner ( FVersionedNiagaraScriptData& OwnerData )
void	RefreshFromExternalChanges ()
void	RefreshGraphCompileId ()	Will conditionally refresh the graph's CompileId.
void	RegisterVMCompilationIdDependencies ( FNiagaraScriptHashCollector& Collector, ENiagaraScriptUsage InUsage, const FGuid& InUsageId )
void	RenameGraphAssignmentAndSetNodePins ( const FName OldName, const FName NewName )	Rename all graph assignment and map set node pins.
void	ReplaceScriptReferences ( UNiagaraScript* OldScript, UNiagaraScript* NewScript )
void	ReportAnalyticsData ( FNiagaraScriptSourceAnalytics& InData )
void	SynchronizeGraphParametersWithParameterDefinitions ( const TArray< UNiagaraParameterDefinitionsBase* > TargetDefinitions, const TArray< UNiagaraParameterDefinitionsBase* > AllDefinitions, const TSet< FGuid >& AllDefinitionsParameterIds, INiagaraParameterDefinitionsSubscriber* Subscriber, FSynchronizeWithParameterDefinitionsArgs Args )	Synchronize all source script variables that have been changed or removed from the parameter definitions to all eligible destination script variables owned by the graph.