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

References

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

Syntax

USTRUCT ()  
struct FVersionedNiagaraScriptData

Remarks

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

Variables

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

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UNiagaraScriptSourceBase *  
Public function Const TArray< ENiagaraScriptUsage >  

Deprecated Variables

  Type Name Description
Public variable UProperty TArray< FNiagaraStackSection > InputSections_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page