FVersionedNiagaraScriptData Struct Reference

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

Public Member Functions
Functions
void	SetbExperimental (bool Value)
	Is this script experimental and less supported?
void	SetbCanBeUsedForTypeConversions (bool Value)
	If used as a dynamic input with exactly one input and output of different types, setting this to true will auto-insert this script to convert from one type to another when dragging and dropping parameters in the stack. For example, a script with a bool as input and a float as output will be automatically inserted in the stack when dropping a bool parameter into the float input of a module in the stack.
FVersionedNiagaraScriptData &	opAssign (FVersionedNiagaraScriptData Other)

Public Attributes
Asset Options
TArray< FNiagaraAssetTagDefinitionReference >	AssetTagDefinitionReferences
Script
FText	Category
	Used to break up scripts of the same Usage type in UI display.
FText	ExperimentalMessage
	The message to display when a function is marked experimental.
bool	bSuggested
	If true, this script will be added to a 'Suggested' category at the top of menus during searches.
TArray< FName >	ProvidedDependencies
	Array of Ids of dependencies provided by this module to other modules on the stack (e.g. 'ProvidesNormalizedAge').
TArray< FNiagaraModuleDependency >	RequiredDependencies
	Dependencies required by this module from other modules on the stack.
UNiagaraScript	DeprecationRecommendation
	Which script to use if this is deprecated.
bool	bUsePythonScriptConversion
	If true then a python script will be executed when changing from this script to the selected deprectation recommendation. This allows the current script to transfer its inputs to the new script.
ENiagaraPythonUpdateScriptReference	ConversionScriptExecution
	Reference to a python script that is executed when the user updates from a previous version to this version.
FString	PythonConversionScript
	Python script to run when converting this script to the recommended deprecation update script.
FFilePath	ConversionScriptAsset
	Asset reference to a python script to run when converting this script to the recommended deprecation update script.
TSubclassOf< UNiagaraConvertInPlaceUtilityBase >	ConversionUtility
	Custom logic to convert the contents of an existing script assignment to this script.
int	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. This is useful to highlight pitfalls or weird behavior of the module.
FText	DebugDrawMessage
	A message to display on UI actions handling debug draw state.
ENiagaraScriptLibraryVisibility	LibraryVisibility
	Defines if this script is visible to the user when searching for modules to add to an emitter.
ENiagaraNumericOutputTypeSelectionMode	NumericOutputTypeSelectionMode
	The mode to use when deducing the type of numeric output pins from the types of the input pins.
FText	Description
FText	Keywords
	A list of space separated keywords which can be used to find this script in editor menus.
FText	CollapsedViewFormat
	The format for the text to display in the stack if the value is collapsed. This supports formatting placeholders for the function inputs, for example "myfunc({0}, {1})" will be converted to "myfunc(1.23, Particles.Position)".
TArray< FNiagaraInlineDynamicInputFormatToken >	InlineExpressionFormat
TArray< FNiagaraInlineDynamicInputFormatToken >	InlineGraphFormat
TMap< FName, FString >	ScriptMetaData
	Script Metadata.
TArray< FNiagaraStackSection >	InputSections

Detailed Description

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

Member Function Documentation

opAssign()

FVersionedNiagaraScriptData & opAssign

(

FVersionedNiagaraScriptData

Other

)

SetbCanBeUsedForTypeConversions()

void SetbCanBeUsedForTypeConversions

(

bool

Value

)

If used as a dynamic input with exactly one input and output of different types, setting this to true will auto-insert this script to convert from one type to another when dragging and dropping parameters in the stack. For example, a script with a bool as input and a float as output will be automatically inserted in the stack when dropping a bool parameter into the float input of a module in the stack.

SetbExperimental()

void SetbExperimental

(

bool

Value

)

Is this script experimental and less supported?

Member Data Documentation

AssetTagDefinitionReferences

TArray<FNiagaraAssetTagDefinitionReference> AssetTagDefinitionReferences

bSuggested

bool bSuggested

If true, this script will be added to a 'Suggested' category at the top of menus during searches.

bUsePythonScriptConversion

bool bUsePythonScriptConversion

If true then a python script will be executed when changing from this script to the selected deprectation recommendation. This allows the current script to transfer its inputs to the new script.

Category

FText Category

Used to break up scripts of the same Usage type in UI display.

CollapsedViewFormat

FText CollapsedViewFormat

The format for the text to display in the stack if the value is collapsed. This supports formatting placeholders for the function inputs, for example "myfunc({0}, {1})" will be converted to "myfunc(1.23, Particles.Position)".

ConversionScriptAsset

FFilePath ConversionScriptAsset

Asset reference to a python script to run when converting this script to the recommended deprecation update script.

ConversionScriptExecution

ENiagaraPythonUpdateScriptReference ConversionScriptExecution

Reference to a python script that is executed when the user updates from a previous version to this version.

ConversionUtility

TSubclassOf<UNiagaraConvertInPlaceUtilityBase> ConversionUtility

Custom logic to convert the contents of an existing script assignment to this script.

DebugDrawMessage

FText DebugDrawMessage

A message to display on UI actions handling debug draw state.

DeprecationRecommendation

UNiagaraScript DeprecationRecommendation

Which script to use if this is deprecated.

Description

FText Description

ExperimentalMessage

FText ExperimentalMessage

The message to display when a function is marked experimental.

InlineExpressionFormat

TArray<FNiagaraInlineDynamicInputFormatToken> InlineExpressionFormat

InlineGraphFormat

TArray<FNiagaraInlineDynamicInputFormatToken> InlineGraphFormat

InputSections

TArray<FNiagaraStackSection> InputSections

Keywords

FText Keywords

A list of space separated keywords which can be used to find this script in editor menus.

LibraryVisibility

ENiagaraScriptLibraryVisibility LibraryVisibility

Defines if this script is visible to the user when searching for modules to add to an emitter.

ModuleUsageBitmask

int ModuleUsageBitmask

When used as a module, what are the appropriate script types for referencing this module?

NoteMessage

FText NoteMessage

A message to display when adding the module to the stack. This is useful to highlight pitfalls or weird behavior of the module.

NumericOutputTypeSelectionMode

ENiagaraNumericOutputTypeSelectionMode NumericOutputTypeSelectionMode

The mode to use when deducing the type of numeric output pins from the types of the input pins.

ProvidedDependencies

TArray<FName> ProvidedDependencies

Array of Ids of dependencies provided by this module to other modules on the stack (e.g. 'ProvidesNormalizedAge').

PythonConversionScript

FString PythonConversionScript

Python script to run when converting this script to the recommended deprecation update script.

RequiredDependencies

TArray<FNiagaraModuleDependency> RequiredDependencies

Dependencies required by this module from other modules on the stack.

ScriptMetaData

TMap<FName,FString> ScriptMetaData

Script Metadata.