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 > FVersionedNiagaraScriptData

Light Theme

Dark Theme

FVersionedNiagaraScriptData

Struct containing all of the data that can be different between different script versions.

Windows

MacOS

Linux

References

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

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FVersionedNiagaraScriptData

Remarks

Struct containing all of the data that can be different between different script versions.

Variables

	Name	Description
uint32: 1	bDeprecated	If this script is no longer meant to be used, this option should be set.
uint32: 1	bExperimental	Is this script experimental and less supported?
bool	bSuggested	If true, this script will be added to a 'Suggested' category at the top of menus during searches
FText	Category	Used to break up scripts of the same Usage type in UI display.
FText	CollapsedViewFormat	The format for the text to display in the stack if the value is collapsed.
TSubclassOf< UN...	ConversionUtility	Custom logic to convert the contents of an existing script assignment to this script.
FText	DeprecationMessage	Message to display when the script is deprecated.
UNiagaraScript ...	DeprecationRecommendation	Which script to use if this is deprecated.
FText	Description
FText	ExperimentalMessage	The message to display when a function is marked experimental.
TArray< FNiagar...	Highlights
FText	Keywords	A list of space separated keywords which can be used to find this script in editor menus.
FNiagaraVMExecu...	LastGeneratedVMId	Adjusted every time ComputeVMCompilationId is called.
ENiagaraScriptL...	LibraryVisibility	Defines if this script is visible to the user when searching for modules to add to an emitter.
int32	ModuleUsageBitmask	When used as a module, what are the appropriate script types for referencing this module?
FText	NoteMessage	A message to display when adding the module to the stack.
ENiagaraNumeric...	NumericOutputTypeSelectionMode	The mode to use when deducing the type of numeric output pins from the types of the input pins.
TArray< FParame...	ParameterDefinitionsSubscriptions	Subscriptions to parameter definitions for this script version
TArray< FName >	ProvidedDependencies	Array of Ids of dependencies provided by this module to other modules on the stack (e.g. 'ProvidesNormalizedAge')
FString	PythonUpdateScript	Python script to run when updating to this script version.
TArray< FNiagar...	RequiredDependencies	Dependencies required by this module from other modules on the stack
FFilePath	ScriptAsset	Asset reference to a python script to run when updating to this script version.
TMap< FName, FS...	ScriptMetaData
ENiagaraPythonU...	UpdateScriptExecution	Reference to a python script that is executed when the user updates from a previous version to this version.
FNiagaraAssetVe...	Version
FText	VersionChangeDescription	What changed in this version compared to the last? Displayed to the user when upgrading to a new script version.

Constructors

	Name	Description
	FVersionedNiagaraScriptData()

Functions

		Name	Description
	TArray< ENia...	GetSupportedUsageContexts()

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

Take our survey

Dismiss