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 > Niagara > UNiagaraScript

Light Theme

Dark Theme

UNiagaraScript

Runtime script for a Niagara system

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraScriptBase

UNiagaraScript

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraScript.h
Include	#include "NiagaraScript.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI)
class UNiagaraScript : public UNiagaraScriptBase

Remarks

Runtime script for a Niagara system

Variables

	Name	Description
FNiagaraParamet...	RapidIterationParameters	Contains all of the top-level values that are iterated on in the UI.
ENiagaraScriptU...	Usage	How this script is to be used. cannot be private due to use of GET_MEMBER_NAME_CHECKED
FGuid	VersionToOpenInEditor	This is used as a transient value to open a specific version in the graph editor

Constructors

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

Destructors

	Name	Description
	~UNiagaraScript()

Functions

	Name	Description
FGuid	AddNewVersion ( int32 MajorVersion, int32 MinorVersion )	Creates a new data entry for the given version number.
FNiagaraShad...	AllocateResource()
bool	AreScriptAndSourceSynchronized ( const FGuid& VersionGuid )	Determine if the Script and its source graph are in sync.
bool	BinaryToExecData ( const UNiagaraScript* Script, const TArray< uint8 >& InBinaryDat..., FNiagaraVMExecutableData& OutExecD... )	Helper to convert the struct from its binary data out of the DDC to it's actual in-memory version.
FString	BuildNiagaraDDCKeyString ( const FNiagaraVMExecutableDataId& ... )	Builds the DDC string for the derived data cache using the supplied CompiledId
void	CacheResourceShadersForCooking ( EShaderPlatform ShaderPlatform, TArray< FNiagaraShaderScript* ..., const ITargetPlatform* TargetP... )	Infrastructure for GPU compute Shaders.
void	CacheResourceShadersForRendering ( bool bRegenerateId, bool bForceRecompile )
void	CacheShadersForResources ( FNiagaraShaderScript* Resource..., bool bApplyCompletedShaderMapForRen..., bool bForceRecompile, bool bCooking, const ITargetPlatform* TargetP... )
bool	CanBeRunOnGpu()
void	CheckVersionDataAvailable()	Makes sure that the default version data is available and fixes old script assets.
void	ComputeVMCompilationId ( FNiagaraVMExecutableDataId& Id, FGuid VersionGuid )
bool	ContainsEquivilentUsage ( const TArray< ENiagaraScriptUsage >..., ENiagaraScriptUsage InUsage )
bool	ContainsUsage ( ENiagaraScriptUsage InUsage )
bool	ConvertUsageToGroup ( ENiagaraScriptUsage InUsage, ENiagaraScriptGroup& OutGroup )
void	DeleteVersion ( const FGuid& VersionGuid )	Deletes the version data for an existing version.
bool	DidScriptCompilationSucceed ( bool bGPUScript )
void	EnableVersioning()	Enables versioning for this script asset.
bool	ExecToBinaryData ( const UNiagaraScript* Script, TArray< uint8 >& OutBinaryData, FNiagaraVMExecutableData& InExecDa... )	Reverse of the BinaryToExecData() function
void	ExposeVersion ( const FGuid& VersionGuid )	Changes the exposed version. Does nothing if the guid does not exist in the script's version data.
FNiagaraAsse...	FindVersionData ( const FGuid& VersionGuid )	Returns the version data for the given guid, if it exists. Otherwise returns nullptr.
void	GenerateStatIDs()
TArray< FNia...	GetAllAvailableVersions()	Returns all available versions for this script.
FGuid	GetBaseChangeID ( const FGuid& VersionGuid )
TArray< FNia...	GetCachedDefaultDataInterfaces()
TArray< UNia...	GetCachedParameterCollectionReferences()
TOptional< T...	GetCompilerTag ( const FNiagaraVariableBase& InVar, const FNiagaraParameterStore* ... )
const FNiaga...	GetComputedVMCompilationId()
FText	GetDescription ( const FGuid& VersionGuid )
const FNiaga...	GetExecutionReadyParameterStore ( ENiagaraSimTarget SimTarget )
FNiagaraAsse...	GetExposedVersion()	Returns the version of the exposed version data (i.e. the version used when adding a module to the stack)
FString	GetFriendlyName()
ENiagaraScri...	GetLastCompileStatus()
const FVersi...	GetLatestScriptData()	Returns the script data for latest exposed version.
FVersionedNi...	GetLatestScriptData()	Returns the script data for latest exposed version.
UNiagaraScri...	GetLatestSource()
const UNiaga...	GetLatestSource()
FString	GetNiagaraDDCKeyString ( const FGuid& ScriptVersion )	Creates a string key for the derived data cache
FNiagaraShad...	GetRenderThreadScript()
const FNiaga...	GetRenderThreadScript()
FVersionedNi...	GetScriptData ( const FGuid& VersionGuid )	Returns the script data for a specific version or nullptr if no such version is found.
const FVersi...	GetScriptData ( const FGuid& VersionGuid )	Returns the script data for a specific version or nullptr if no such version is found.
UNiagaraScri...	GetSource ( const FGuid& VersionGuid )
const UNiaga...	GetSource ( const FGuid& VersionGuid )
TArray< ENia...	GetSupportedUsageContextsForBitmask ( int32 InModuleUsageBitmask, bool bIncludeHiddenUsages )
ENiagaraScri...	GetUsage()
FGuid	GetUsageId()
FNiagaraVMEx...	GetVMExecutableData()
const FNiaga...	GetVMExecutableData()
const FNiaga...	GetVMExecutableDataCompilationId()
bool	HandleVariableRenames ( const TMap< FNiagaraVariable, FNiag..., const FString& UniqueEmitterName )
void	InvalidateCompileResults ( const FString& Reason )
void	InvalidateExecutionReadyParameterStores()
bool	IsCompilable ( ENiagaraScriptUsage Usage )
bool	IsCompilable()
bool	IsDynamicInputScript ( ENiagaraScriptUsage Usage )
bool	IsDynamicInputScript()
bool	IsEmitterSpawnScript ( ENiagaraScriptUsage Usage )
bool	IsEmitterSpawnScript()
bool	IsEmitterUpdateScript ( ENiagaraScriptUsage Usage )
bool	IsEmitterUpdateScript()
bool	IsEquivalentUsage ( ENiagaraScriptUsage InUsage )
bool	IsEquivalentUsage ( ENiagaraScriptUsage InUsageA, ENiagaraScriptUsage InUsageB )
bool	IsFunctionScript()
bool	IsFunctionScript ( ENiagaraScriptUsage Usage )
bool	IsGPUScript ( ENiagaraScriptUsage Usage )
bool	IsInterpolatedParticleSpawnScript()
bool	IsInterpolatedParticleSpawnScript ( ENiagaraScriptUsage Usage )
bool	IsModuleScript ( ENiagaraScriptUsage Usage )
bool	IsModuleScript()
bool	IsNonParticleScript ( ENiagaraScriptUsage Usage )
bool	IsNonParticleScript()
bool	IsParticleEventScript ( ENiagaraScriptUsage Usage )
bool	IsParticleEventScript()
bool	IsParticleScript ( ENiagaraScriptUsage Usage )
bool	IsParticleScript()
bool	IsParticleSpawnScript()
bool	IsParticleSpawnScript ( ENiagaraScriptUsage Usage )
bool	IsParticleStageScript ( ENiagaraScriptUsage Usage )
bool	IsParticleUpdateScript()
bool	IsParticleUpdateScript ( ENiagaraScriptUsage Usage )
bool	IsReadyToRun ( ENiagaraSimTarget SimTarget )
bool	IsScriptCompilationPending ( bool bGPUScript )
bool	IsScriptCooked()
bool	IsSpawnScript()
bool	IsSpawnScript ( ENiagaraScriptUsage Usage )
bool	IsStandaloneScript ( ENiagaraScriptUsage Usage )
bool	IsStandaloneScript()
bool	IsSupportedUsageContextForBitmask ( int32 InModuleUsageBitmask, ENiagaraScriptUsage InUsageContext, bool bIncludeHiddenUsages )
bool	IsSystemScript ( ENiagaraScriptUsage Usage )
bool	IsSystemSpawnScript ( ENiagaraScriptUsage Usage )
bool	IsSystemSpawnScript()
bool	IsSystemUpdateScript ( ENiagaraScriptUsage Usage )
bool	IsSystemUpdateScript()
bool	IsUsageDependentOn ( ENiagaraScriptUsage InUsageA, ENiagaraScriptUsage InUsageB )	Is usage A dependent on Usage B?
bool	IsVersioningEnabled()	If true then this script asset uses active version control to track changes.
void	MarkScriptAndSourceDesynchronized ( FString Reason, const FGuid& VersionGuid )	Ensure that the Script and its source graph are marked out of sync.
FOnScriptCom...	OnGPUScriptCompiled()	Callback issued whenever a GPU script compilation successfully happened (even if the results are a script that cannot be executed due to errors)
FOnPropertyC...	OnPropertyChanged()	Callback issues whenever post edit changed is called on this script.
FOnScriptCom...	OnVMScriptCompiled()	Callback issued whenever a VM script compilation successfully happened (even if the results are a script that cannot be executed due to errors)
void	PostEditChangeVersionedProperty ( FPropertyChangedEvent& PropertyCha..., const FGuid& Version )
void	RaiseOnGPUCompilationComplete()
void	RequestCompile ( const FGuid& ScriptVersion, bool bForceCompile )	Request a synchronous compile for the script, possibly forcing it to compile.
bool	RequestExternallyManagedAsyncCompile ( const TSharedPtr< FNiagaraCompileRe..., FNiagaraVMExecutableDataId& OutCom..., uint32& OutAsyncHandle )	Request an asynchronous compile for the script, possibly forcing it to compile.
void	SetLatestSource ( UNiagaraScriptSourceBase* InSo... )
void	SetSource ( UNiagaraScriptSourceBase* InSo..., const FGuid& VersionGuid )
void	SetUsage ( ENiagaraScriptUsage InUsage )
void	SetUsageId ( const FGuid& InUsageId )
void	SetVMCompilationResults ( const FNiagaraVMExecutableDataId& ..., FNiagaraVMExecutableData& InScript..., FNiagaraCompileRequestDataBase*... )	External call used to identify the values for a successful VM script compilation.
bool	ShouldCacheShadersForCooking ( const ITargetPlatform* TargetP... )
void	SyncAliases ( const TMap< FString, FString >& Re... )
bool	SynchronizeExecutablesWithMaster ( const UNiagaraScript* Script, const TMap< FString, FString >& Re... )	In the event where we "merge" we duplicate the changes of the master copy onto the newly cloned copy.
bool	UsesCollection ( const UNiagaraParameterCollection&... )

Overridden from UNiagaraScriptBase

		Name	Description
	TConstArrayV...	GetSimulationStageMetaData()
	void	ModifyCompilationEnvironment ( FShaderCompilerEnvironment& OutEnv... )

Overridden from UObject

	Name	Description
void	BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetP... )	Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects
void	BeginDestroy()	Called before destroying the object.
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
bool	IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetP... )	Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
bool	IsEditorOnly()	Called during saving to determine if the object is forced to be editor only or not
bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreSave ( const ITargetPlatform* TargetP... )	Presave function.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name	Description
FOnPropertyChanged
FOnScriptCompiled

Constants

Name	Description
NiagaraCustomVersionTagName

Deprecated Variables

	Name	Description
uint32: 1	bDeprecated_DEPRECATED	Use property in struct returned from GetScriptData() instead
uint32: 1	bExperimental_DEPRECATED	Use property in struct returned from GetScriptData() instead
uint32: 1	bExposeToLibrary_DEPRECATED	Deprecated, use LibraryVisibility instead.
FText	Category_DEPRECATED	Use property in struct returned from GetScriptData() instead
FText	CollapsedViewFormat_DEPRECATED	Deprecated, use LibraryVisibility instead.
TSubclassOf< UN...	ConversionUtility_DEPRECATED	Use property in struct returned from GetScriptData() instead
FText	DeprecationMessage_DEPRECATED	Use property in struct returned from GetScriptData() instead
UNiagaraScript ...	DeprecationRecommendation_DEPRECATED	Use property in struct returned from GetScriptData() instead
FText	Description_DEPRECATED	Use property in struct returned from GetScriptData() instead
FText	ExperimentalMessage_DEPRECATED	Use property in struct returned from GetScriptData() instead
TArray< FNiagar...	Highlights_DEPRECATED	Deprecated, use LibraryVisibility instead.
FText	Keywords_DEPRECATED	Use property in struct returned from GetScriptData() instead
ENiagaraScriptL...	LibraryVisibility_DEPRECATED	Use property in struct returned from GetScriptData() instead
int32	ModuleUsageBitmask_DEPRECATED	Use property in struct returned from GetScriptData() instead
FText	NoteMessage_DEPRECATED	Use property in struct returned from GetScriptData() instead
ENiagaraNumeric...	NumericOutputTypeSelectionMode_DEPRECATED	Use property in struct returned from GetScriptData() instead
TArray< FName >	ProvidedDependencies_DEPRECATED	Use property in struct returned from GetScriptData() instead
TArray< FNiagar...	RequiredDependencies_DEPRECATED	Use property in struct returned from GetScriptData() instead
TMap< FName, FS...	ScriptMetaData_DEPRECATED	Deprecated, use LibraryVisibility instead.
UNiagaraScriptS...	Source_DEPRECATED	'Source' data/graphs for this script
int32	UsageIndex_DEPRECATED	Which instance of the usage in the graph to use. This is now deprecated and is handled by UsageId.

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

Take our survey

Dismiss