Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NiagaraEditor > UNiagaraScriptSource

Light Theme

Dark Theme

UNiagaraScriptSource

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraScriptSourceBase

UNiagaraScriptSource

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

	Name	Description
bool	bIsCompilationCopy
bool	bIsReleased
TObjectPtr< cla...	NodeGraph	Graph for particle update expression

Constructors

	Name	Description
	UNiagaraScriptSource ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	UNiagaraScri...	CreateCompilationCopy ( const TArray< ENiagaraScriptUsage >... )
	void	FixupRenamedParameters ( UNiagaraNode* Node, FNiagaraParameterStore& RapidItera..., const TArray< FNiagaraVariable >& ..., const UNiagaraEmitter* Emitter, ENiagaraScriptUsage ScriptUsage )
	void	ReleaseCompilationCopy()

Overridden from UNiagaraScriptSourceBase

	Name	Description
bool	AddModuleIfMissing ( FString ModulePath, ENiagaraScriptUsage Usage, bool& bOutFoundModule )	Adds a module if it isn't already in the graph.
void	CleanUpOldAndInitializeNewRapidIterationParameters ( const UNiagaraEmitter* Emitter, ENiagaraScriptUsage ScriptUsage, FGuid ScriptUsageId, FNiagaraParameterStore& RapidItera... )
void	CollectDataInterfaces ( TArray< const UNiagaraDataInterface... )
TMap< FName,...	ComputeObjectNameMap ( UNiagaraSystem& System, ENiagaraScriptUsage Usage, FGuid UsageId, FString EmitterUniqueName )
void	ComputeVMCompilationId ( FNiagaraVMExecutableDataId& Id, ENiagaraScriptUsage InUsage, const FGuid& InUsageId, bool bForceRebuild )
void	ForceGraphToRecompileOnNextCheck()
FGuid	GetChangeID()
FGuid	GetCompileBaseId ( ENiagaraScriptUsage InUsage, const FGuid& InUsageId )
FNiagaraComp...	GetCompileHash ( ENiagaraScriptUsage InUsage, const FGuid& InUsageId )
void	GetLinkedPositionTypeInputs ( const TArray< FNiagaraVariable >& ..., TSet< FNiagaraVariable >& OutLinke... )	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 ( UNiagaraEmitter& OwningEmitter )	Allows the derived editor only script source to handle a post load requested by an owning emitter.
void	RefreshFromExternalChanges()
void	RenameGraphAssignmentAndSetNodePins ( const FName OldName, const FName NewName )	Rename all graph assignment and map set node pins.
void	SynchronizeGraphParametersWithParameterDefinitions ( const TArray< UNiagaraParameterDefi..., const TArray< UNiagaraParameterDefi..., const TSet< FGuid >& AllDefinition..., INiagaraParameterDefinitionsSubscri..., FSynchronizeWithParameterDefinition... )	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.

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.