1. Epic GamesDeveloper
  3. FVersionedNiagaraScriptData

FVersionedNiagaraScriptData

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

API > API/Plugins > API/Plugins/Niagara

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

   
Name FVersionedNiagaraScriptData
Type struct
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraScript.h
Include Path #include "NiagaraScript.h"

Syntax

USTRUCT ()  
struct FVersionedNiagaraScriptData

Constructors

Name Remarks Include Path Unreal Specifiers

FVersionedNiagaraScriptData()

   NiagaraScript.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetTagDefinitionReferences TArray< FNiagaraAssetTagDefinitionReference >   NiagaraScript.h
  • EditAnywhere
  • Category="Asset Options"
bCanBeUsedForTypeConversions uint32 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. NiagaraScript.h
  • EditAnywhere
  • Category=Script
bDeprecated bool If this script is no longer meant to be used, this option should be set. NiagaraScript.h  
bExperimental uint32 Is this script experimental and less supported? NiagaraScript.h
  • EditAnywhere
  • Category=Script
bSuggested bool If true, this script will be added to a 'Suggested' category at the top of menus during searches NiagaraScript.h
  • AssetRegistrySearchable
  • EditAnywhere
  • Category=Script
bUsePythonScriptConversion bool If true then a python script will be executed when changing from this script to the selected deprectation recommendation. NiagaraScript.h
  • EditAnywhere
  • Category=Script
Category FText Used to break up scripts of the same Usage type in UI display. NiagaraScript.h
  • EditAnywhere
  • Category=Script
CollapsedViewFormat FText The format for the text to display in the stack if the value is collapsed. NiagaraScript.h
  • EditAnywhere
  • Category=Script
ConversionScriptAsset FFilePath Asset reference to a python script to run when converting this script to the recommended deprecation update script. NiagaraScript.h
  • EditAnywhere
  • Category=Script
  • Meta=(EditCondition="bUsePythonScriptConversion && ConversionScriptExecution == ENiagaraPythonUpdateScriptReference::ScriptAsset", EditConditionHides)
ConversionScriptExecution ENiagaraPythonUpdateScriptReference Reference to a python script that is executed when the user updates from a previous version to this version. NiagaraScript.h
  • EditAnywhere
  • Category=Script
  • Meta=(EditCondition="bUsePythonScriptConversion", EditConditionHides, SegmentedDisplay)
ConversionUtility TSubclassOf< UNiagaraConvertInPlaceUtilityBase > Custom logic to convert the contents of an existing script assignment to this script. NiagaraScript.h
  • EditAnywhere
  • Category=Script
  • Meta=(EditCondition="!bUsePythonScriptConversion", EditConditionHides)
DebugDrawMessage FText A message to display on UI actions handling debug draw state. NiagaraScript.h
  • EditAnywhere
  • Category=Script
  • Meta=(MultiLine=true)
DeprecationMessage FText Message to display when the script is deprecated. NiagaraScript.h  
DeprecationRecommendation TObjectPtr< UNiagaraScript > Which script to use if this is deprecated. NiagaraScript.h
  • EditAnywhere
  • Category=Script
Description FText   NiagaraScript.h
  • AssetRegistrySearchable
  • EditAnywhere
  • Category=Script
  • Meta=(MultiLine=true)
ExperimentalMessage FText The message to display when a function is marked experimental. NiagaraScript.h
  • EditAnywhere
  • Category=Script
  • Meta=(EditCondition="bExperimental", MultiLine=true)
InlineExpressionFormat TArray< FNiagaraInlineDynamicInputFormatToken >   NiagaraScript.h
  • EditAnywhere
  • Category="Script"
InlineGraphFormat TArray< FNiagaraInlineDynamicInputFormatToken >   NiagaraScript.h
  • EditAnywhere
  • Category="Script"
Keywords FText A list of space separated keywords which can be used to find this script in editor menus. NiagaraScript.h
  • AssetRegistrySearchable
  • EditAnywhere
  • Category=Script
LastGeneratedVMId FNiagaraVMExecutableDataId Adjusted every time ComputeVMCompilationId is called. NiagaraScript.h  
LibraryVisibility ENiagaraScriptLibraryVisibility Defines if this script is visible to the user when searching for modules to add to an emitter. NiagaraScript.h
  • AssetRegistrySearchable
  • EditAnywhere
  • Category=Script
  • Meta=(SegmentedDisplay)
ModuleUsageBitmask int32 When used as a module, what are the appropriate script types for referencing this module? NiagaraScript.h
  • EditAnywhere
  • Category=Script
  • Meta=(Bitmask, BitmaskEnum="/Script/Niagara.ENiagaraScriptUsage")
NoteMessage FText A message to display when adding the module to the stack. NiagaraScript.h
  • EditAnywhere
  • Category=Script
  • Meta=(MultiLine=true)
NumericOutputTypeSelectionMode ENiagaraNumericOutputTypeSelectionMode The mode to use when deducing the type of numeric output pins from the types of the input pins. NiagaraScript.h
  • EditAnywhere
  • Category=Script
ParameterDefinitionsSubscriptions TArray< FParameterDefinitionsSubscription > Subscriptions to parameter definitions for this script version NiagaraScript.h  
ProvidedDependencies TArray< FName > Array of Ids of dependencies provided by this module to other modules on the stack (e.g. 'ProvidesNormalizedAge') NiagaraScript.h
  • EditAnywhere
  • Category=Script
PythonConversionScript FString Python script to run when converting this script to the recommended deprecation update script. NiagaraScript.h
  • EditAnywhere
  • Category=Script
  • Meta=(MultiLine=true, EditCondition="bUsePythonScriptConversion && ConversionScriptExecution == ENiagaraPythonUpdateScriptReference::DirectTextEntry", EditConditionHides)
PythonUpdateScript FString Python script to run when updating to this script version. NiagaraScript.h  
RequiredDependencies TArray< FNiagaraModuleDependency > Dependencies required by this module from other modules on the stack NiagaraScript.h
  • EditAnywhere
  • Category=Script
ScriptAsset FFilePath Asset reference to a python script to run when updating to this script version. NiagaraScript.h  
ScriptMetaData TMap< FName, FString >   NiagaraScript.h
  • EditAnywhere
  • Category=Script
  • DisplayName="Script Metadata"
  • Meta=(ToolTip="Script Metadata")
UpdateScriptExecution ENiagaraPythonUpdateScriptReference Reference to a python script that is executed when the user updates from a previous version to this version. NiagaraScript.h  
Version FNiagaraAssetVersion   NiagaraScript.h  
VersionChangeDescription FText What changed in this version compared to the last? Displayed to the user when upgrading to a new script version. NiagaraScript.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Source TObjectPtr< class UNiagaraScriptSourceBase > 'Source' data/graphs for this script NiagaraScript.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UNiagaraScriptSourceBase * GetSource()

   NiagaraScript.h  

TArray< ENiagaraScriptUsage > GetSupportedUsageContexts()

   NiagaraScript.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
InputSections_DEPRECATED TArray< FNiagaraStackSection >   NiagaraScript.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page