1. Epic GamesDeveloper
  3. UNiagaraScript

UNiagaraScript

Scripts are function graphs that define the runtime execution for a Niagara system (similar to a Blueprint).

API > API/Plugins > API/Plugins/Niagara

Scripts are function graphs that define the runtime execution for a Niagara system (similar to a Blueprint).

There are three types of scripts: 1) Module: can be added as a standalone part to the emitter stack and encapsulates a single behavior, for example "Add Velocity" 2) Dynamic input: has a single output value and can be added to any input in the stack to compute such a value, for example "Random Vector" 3) Function: usually reserved for helper functions; can only be called from within modules or dynamic inputs

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

Syntax

UCLASS (MinimalAPI)  
class UNiagaraScript :  
    public UNiagaraScriptBase ,  
    public FNiagaraVersionedObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  NiagaraScript.h  

UNiagaraScript ( const FObjectInitializer& ObjectInitializer
)

   NiagaraScript.h  

Typedefs

Name Type Remarks Include Path
FOnPropertyChanged TMulticastDelegate_OneParam< void, FPropertyChangedEvent & >   NiagaraScript.h
FOnScriptCompiled TMulticastDelegate_TwoParams< void, UNiagaraScript *, const FGuid & >   NiagaraScript.h

Constants

Name Type Remarks Include Path
LogCompileStaticVars int32   NiagaraScript.h
NiagaraCustomVersionTagName const FName   NiagaraScript.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
RapidIterationParameters FNiagaraParameterStore Contains all of the top-level values that are iterated on in the UI. NiagaraScript.h  
RapidIterationParametersCookedEditorCache FNiagaraParameterStore   NiagaraScript.h  
Usage ENiagaraScriptUsage How this script is to be used. cannot be private due to use of GET_MEMBER_NAME_CHECKED NiagaraScript.h
  • AssetRegistrySearchable
ValidationRules TArray< TObjectPtr< UNiagaraValidationRule > > A set of rules to apply when this script is used in the stack. NiagaraScript.h
  • EditAnywhere
  • Category="Validation"
  • Instanced
VersionToOpenInEditor FGuid This is used as a transient value to open a specific version in the graph editor NiagaraScript.h
  • Transient

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveCompileRoots TArray< TObjectPtr< UObject > >   NiagaraScript.h
  • Transient
bMigrateParameterDataToHierarchyRoot bool Transient flag marking that the script will need to rebuild the hierarchy root based on the custom version encountered during serialize. NiagaraScript.h  
bVersioningEnabled bool If true then this script asset uses active version control to track changes. NiagaraScript.h  
CachedDefaultDataInterfaces TArray< FNiagaraScriptDataInterfaceInfo >   NiagaraScript.h  
CachedDefaultUObjects TArray< FNiagaraScriptUObjectCompileInfo > Populated from compilation process, used to generate resolved list. NiagaraScript.h  
CachedParameterCollectionReferences TArray< TObjectPtr< UNiagaraParameterCollection > >   NiagaraScript.h  
CachedScriptResourcesForCooking TMap< const class ITargetPlatform *, TArray< TUniquePtr< FNiagaraShaderScript > > > Runtime stat IDs generated from StatScopes. script resources being cached for cooking. NiagaraScript.h  
CachedScriptVM FNiagaraVMExecutableData Compiled VM bytecode and data necessary to run this script. NiagaraScript.h  
CachedScriptVMId FNiagaraVMExecutableDataId Adjusted every time that we compile this script. NiagaraScript.h  
CustomAssetRegistryTagCache TOptional< TMap< FName, FString > >   NiagaraScript.h  
DataInterfacesPendingInvalidation TArray< TObjectPtr< UNiagaraDataInterface > > These data interfaces are populated via InvalidateAndEmptyDefaultDataInterfaces(). NiagaraScript.h
  • Transient
  • DuplicateTransient
ExposedVersion FGuid The exposed version is the version that is used by default when a user adds this script somewhere. NiagaraScript.h  
IsCooked bool Flag set on load based on whether we're loading from a cooked package. NiagaraScript.h  
LastReportedVMId FNiagaraVMExecutableDataId   NiagaraScript.h  
LoadedScriptResources TArray< FNiagaraShaderScript >   NiagaraScript.h  
OnGPUScriptCompiledDelegate FOnScriptCompiled   NiagaraScript.h  
OnPropertyChangedDelegate FOnPropertyChanged   NiagaraScript.h  
OnVMScriptCompiledDelegate FOnScriptCompiled A multicast delegate which is called whenever the script has been compiled (successfully or not). NiagaraScript.h  
PreviewMoviePath FSoftObjectPath   NiagaraScript.h
  • EditAnywhere
  • Category="Preview"
  • AssetRegistrySearchable
  • Meta=(AllowedClasses="/Script/MediaAssets.FileMediaSource")
ReleasedByRT FThreadSafeBool Flag used to guarantee that the RT isn't accessing the FNiagaraScriptResource before cleanup. NiagaraScript.h  
ResolvedDataInterfaces TArray< FNiagaraScriptResolvedDataInterfaceInfo >   NiagaraScript.h  
ResolvedUObjectInfos TArray< FNiagaraResolvedUObjectInfo > Resolved objects are used to populate the script parameter stores, they are 1:1 mapping from variable -> object. NiagaraScript.h  
ResolvedUserDataInterfaceBindings TArray< FNiagaraResolvedUserDataInterfaceBinding >   NiagaraScript.h  
ScriptExecutionBoundParameters TArray< FNiagaraBoundParameter > The cooked binding data between ScriptExecutionParamStore and RapidIterationParameters. NiagaraScript.h  
ScriptExecutionParamStore FNiagaraScriptExecutionParameterStore The equivalent of ScriptExecutionParamStoreCPU (or GPU) cooked for the given platform. NiagaraScript.h  
ScriptExecutionParamStoreCPU FNiagaraScriptExecutionParameterStore   NiagaraScript.h
  • Transient
ScriptExecutionParamStoreGPU FNiagaraScriptExecutionParameterStore   NiagaraScript.h
  • Transient
ScriptResource TSharedPtr< FNiagaraShaderScript >   NiagaraScript.h  
ScriptResourcesByFeatureLevel TSharedPtr< FNiagaraShaderScript >   NiagaraScript.h  
UsageId FGuid Specifies a unique id for use when there are multiple scripts with the same usage, e.g. events. NiagaraScript.h  
VersionData TArray< FVersionedNiagaraScriptData > Contains all of the versioned script data. NiagaraScript.h  
VersionedScriptAdapters TArray< struct FVersionedNiagaraScript > Editor time adapters to a specific VersionData and this Script ptr to handle synchronizing changes made by parameter definitions. NiagaraScript.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ApplyRapidIterationParameters ( TConstArrayView< FNiagaraVariable > InParameters,
bool bAllowRemoval
)

 Updates the RI parameter store based on the provided variables (missing entries will be added and stale entries will be removed. Returns true if the parameter store was modified. NiagaraScript.h  

bool AreScriptAndSourceSynchronized ( const FGuid& VersionGuid
) const

 Determine if the Script and its source graph are in sync. NiagaraScript.h  

void AssignRapidIterationParameters ( const FNiagaraVMExecutableData& InScriptVM
)

   NiagaraScript.h  

void CacheResourceShadersForCooking ( EShaderPlatform ShaderPlatform,
TArray< TUniquePtr< FNiagaraShaderScript > >& InOutCachedResources,
const ITargetPlatform* TargetPlatform
)

   NiagaraScript.h  

void CacheResourceShadersForRendering ( bool bRegenerateId,
bool bForceRecompile
)

   NiagaraScript.h  

void CacheShadersForResources ( FNiagaraShaderScript* ResourceToCache,
bool bApplyCompletedShaderMapForRendering,
bool bForceRecompile,
bool bCooking,
const ITargetPlatform* TargetPlatform
)

   NiagaraScript.h  

bool CanBeRunOnGpu()

   NiagaraScript.h  

void CheckVersionDataAvailable()

 Makes sure that the default version data is available and fixes old script assets. NiagaraScript.h  
Clears out resolved runtime data. NiagaraScript.h  

void ComputeVMCompilationId ( FNiagaraVMExecutableDataId& Id,
const FGuid& VersionGuid,
FNiagaraScriptHashCollector* HashCollector
) const

   NiagaraScript.h  

bool ContainsUsage ( ENiagaraScriptUsage InUsage
) const

   NiagaraScript.h  

UNiagaraScript * CreateCompilationCopy()

 Creates a shallow transient copy of this script for compilation purposes. NiagaraScript.h  

bool DidScriptCompilationSucceed ( bool bGPUScript
) const

   NiagaraScript.h  

TArray< FName > FindShaderFormatsForCooking ( const ITargetPlatform* TargetPlatform
) const

   NiagaraScript.h  

void GatherScriptStaticVariables ( TArray< FNiagaraVariable >& StaticVariables
) const

 Use of this function differs from the above in that the data is being pulled from the RapidIterationParameters rather than the compiled data NiagaraScript.h  

void GenerateStatIDs()

   NiagaraScript.h  

FGuid GetBaseChangeID ( const FGuid& VersionGuid
) const

   NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  

TArray< TObjectPtr< UNiagaraParameterCollection > > & GetCachedParameterCollectionReferences()

   NiagaraScript.h  

TOptional< T > GetCompiledStaticVariableValue ( const FNiagaraVariableBase& InVar
) const

   NiagaraScript.h  

TOptional< T > GetCompilerTag ( const FNiagaraVariableBase& InVar,
const FNiagaraParameterStore* FallbackParameterStore
) const

   NiagaraScript.h  

TOptional< FVector3d > GetCompilerTag ( const FNiagaraVariableBase& InVar,
const FNiagaraParameterStore* FallbackParameterStore
) const

   NiagaraScript.h  

const FNiagaraVMExecutableDataId & GetComputedVMCompilationId()

   NiagaraScript.h  

TConstArrayView< FNiagaraDataInterfaceGPUParamInfo > GetDataInterfaceGPUParamInfos()

   NiagaraScript.h  

FText GetDescription ( const FGuid& VersionGuid
)

   NiagaraScript.h  

const FNiagaraScriptExecutionParameterStore * GetExecutionReadyParameterStore ( ENiagaraSimTarget SimTarget
)

   NiagaraScript.h  

FString GetFriendlyName()

   NiagaraScript.h  

ENiagaraScriptCompileStatus GetLastCompileStatus()

   NiagaraScript.h  
Returns the script data for latest exposed version. NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  

FString GetNiagaraDDCKeyString ( const FGuid& ScriptVersion,
const FString& ScriptPath
)

 Creates a string key for the derived data cache NiagaraScript.h  

FVersionedNiagaraEmitter GetOuterEmitter()

 Workaround for emitter versioning because we used a lot of Script->GetOuter() previously. NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  

TConstArrayView< FNiagaraScriptResolvedDataInterfaceInfo > GetResolvedDataInterfaces()

   NiagaraScript.h  

TConstArrayView< FNiagaraResolvedUObjectInfo > GetResolvedUObjects()

   NiagaraScript.h  

TConstArrayView< FNiagaraResolvedUserDataInterfaceBinding > GetResolvedUserDataInterfaceBindings()

   NiagaraScript.h  

const FVersionedNiagaraScriptData * GetScriptData ( const FGuid& VersionGuid
) const

   NiagaraScript.h  
Returns the script data for a specific version or nullptr if no such version is found. NiagaraScript.h  

const UNiagaraScriptSourceBase * GetSource ( const FGuid& VersionGuid
) const

   NiagaraScript.h  

UNiagaraScriptSourceBase * GetSource ( const FGuid& VersionGuid
)

   NiagaraScript.h  

ENiagaraScriptUsage GetUsage()

   NiagaraScript.h  

FGuid GetUsageId()

   NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  

const FNiagaraVMExecutableDataId & GetVMExecutableDataCompilationId()

   NiagaraScript.h  

bool HandleVariableRenames ( const TMap< FNiagaraVariable, FNiagaraVariable >& OldToNewVars,
const FString& UniqueEmitterName
)

   NiagaraScript.h  

bool HasScriptStaticVariables()

   NiagaraScript.h  

void InvalidateCompileResults ( const FString& Reason
)

   NiagaraScript.h  

void InvalidateExecutionReadyParameterStores()

   NiagaraScript.h  

bool IsCompilable ()

   NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  

bool IsEquivalentUsage ( ENiagaraScriptUsage InUsage
) const

   NiagaraScript.h  
  NiagaraScript.h  

bool IsGPUScript ()

   NiagaraScript.h  
  NiagaraScript.h  

bool IsModuleScript ()

   NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  

bool IsReadyToRun ( ENiagaraSimTarget SimTarget
) const

   NiagaraScript.h  

bool IsScriptCompilationPending ( bool bGPUScript
) const

   NiagaraScript.h  

bool IsScriptCooked()

   NiagaraScript.h  

bool IsScriptShaderSynchronized ( const FGuid& VersionGuid
) const

   NiagaraScript.h  

bool IsShaderMapCached ( const ITargetPlatform* TargetPlatform,
const FNiagaraShaderMapId& ShaderMapId
) const

   NiagaraScript.h  

bool IsSpawnScript ()

   NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  

void MarkScriptAndSourceDesynchronized ( FString Reason,
const FGuid& VersionGuid
)

 Ensure that the Script and its source graph are marked out of sync. NiagaraScript.h  

FOnScriptCompiled & OnGPUScriptCompiled()

 Callback issued whenever a GPU script compilation successfully happened (even if the results are a script that cannot be executed due to errors) NiagaraScript.h  

FOnPropertyChanged & OnPropertyChanged()

 Callback issues whenever post edit changed is called on this script. NiagaraScript.h  

FOnScriptCompiled & OnVMScriptCompiled()

 Callback issued whenever a VM script compilation successfully happened (even if the results are a script that cannot be executed due to errors) NiagaraScript.h  

virtual void PostEditChangeVersionedProperty ( FPropertyChangedEvent& PropertyChangedEvent,
const FGuid& Version
)

   NiagaraScript.h  

void RaiseOnGPUCompilationComplete()

   NiagaraScript.h  

void RequestCompile ( const FGuid& ScriptVersion,
bool bForceCompile
)

 Request a synchronous compile for the script, possibly forcing it to compile. NiagaraScript.h  
Request an asynchronous compile for the script, possibly forcing it to compile. NiagaraScript.h  

void SaveShaderStableKeys ( const ITargetPlatform* TP
)

   NiagaraScript.h  

void SetComputeCompilationResults ( const ITargetPlatform* TargetPlatform,
EShaderPlatform ShaderPlatform,
ERHIFeatureLevel::Type FeatureLevel,
const FNiagaraShaderScriptParametersMetadata& SharedParameters,
const FNiagaraShaderMapRef& ShaderMap,
TConstArrayView< FShaderCompilerError > CompilationErrors
)

   NiagaraScript.h  

void SetLatestSource ( UNiagaraScriptSourceBase* InSource
)

   NiagaraScript.h  

void SetResolvedDataInterfaces ( const TArray< FNiagaraScriptResolvedDataInterfaceInfo >& InResolvedDataInterfaces
)

   NiagaraScript.h  

void SetResolvedUObjects ( TConstArrayView< FNiagaraResolvedUObjectInfo > InResolvedUObjectInfos
)

   NiagaraScript.h  

void SetResolvedUserDataInterfaceBindings ( const TArray< FNiagaraResolvedUserDataInterfaceBinding >& InResolvedUserDataInterfaceBindings
)

   NiagaraScript.h  

void SetSource ( UNiagaraScriptSourceBase* InSource,
const FGuid& VersionGuid
)

   NiagaraScript.h  

void SetUsage ( ENiagaraScriptUsage InUsage
)

   NiagaraScript.h  

void SetUsageId ( const FGuid& InUsageId
)

   NiagaraScript.h  

void SetVMCompilationResults ( const FNiagaraVMExecutableDataId& InCompileId,
FNiagaraVMExecutableData& InScriptVM,
const FString& EmitterUniqueName,
const TMap< FName, UNiagaraDataInterface* >& ObjectNameMap,
bool ApplyRapidIterationParameters
)

 External call used to identify the values for a successful VM script compilation. NiagaraScript.h  

void SyncAliases ( const FNiagaraAliasContext& ResolveAliasesContext
)

   NiagaraScript.h  

bool SynchronizeExecutablesWithCompilation ( const UNiagaraScript* Script,
const TMap< FString, FString >& RenameMap
)

 In the event where we "merge" we duplicate the changes of the source script onto the newly cloned copy. NiagaraScript.h  

bool UsesCollection ( const UNiagaraParameterCollection* Collection
) const

   NiagaraScript.h  

Overridden from UNiagaraScriptBase

Name Remarks Include Path Unreal Specifiers

virtual TConstArrayView< FSimulationStageMetaData > GetSimulationStageMetaData()

   NiagaraScript.h  

virtual void ModifyCompilationEnvironment ( EShaderPlatform Platform,
FShaderCompilerEnvironment& OutEnvironment
) const

   NiagaraScript.h  

virtual bool ShouldCompile ( EShaderPlatform Platform
) const

   NiagaraScript.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   NiagaraScript.h  

virtual void BeginDestroy()

   NiagaraScript.h  

virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   NiagaraScript.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   NiagaraScript.h  

virtual bool IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetPlatform
)

   NiagaraScript.h  

virtual bool IsEditorOnly()

   NiagaraScript.h  

virtual bool IsReadyForFinishDestroy()

   NiagaraScript.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraScript.h  

virtual void PostEditUndo()

   NiagaraScript.h  

virtual void PostLoad()

   NiagaraScript.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   NiagaraScript.h  

virtual void Serialize ( FArchive& Ar
)

   NiagaraScript.h  

Overridden from FNiagaraVersionedObject

Name Remarks Include Path Unreal Specifiers

virtual FGuid AddNewVersion ( int32 MajorVersion,
int32 MinorVersion
)

 Creates a new data entry for the given version number. NiagaraScript.h  

virtual void DeleteVersion ( const FGuid& VersionGuid
)

 Deletes the version data for an existing version. NiagaraScript.h  

virtual void DisableVersioning ( const FGuid& VersionGuidToUse
)

 Disables versioning and keeps only the data from the given version guid. NiagaraScript.h  

virtual void EnableVersioning()

 Enables versioning for this script asset. NiagaraScript.h  

virtual void ExposeVersion ( const FGuid& VersionGuid
)

 Changes the exposed version. Does nothing if the guid does not exist in the script's version data. NiagaraScript.h  

virtual FNiagaraAssetVersion const * FindVersionData ( const FGuid& VersionGuid
) const

 Returns the version data for the given guid, if it exists. Otherwise returns nullptr. NiagaraScript.h  

virtual TArray< FNiagaraAssetVersion > GetAllAvailableVersions()

 Returns all available versions for this script. NiagaraScript.h  

virtual FNiagaraAssetVersion GetExposedVersion()

 Returns the version of the exposed version data (i.e. the version used when adding a module to the stack) NiagaraScript.h  

virtual TSharedPtr< FNiagaraVersionDataAccessor > GetVersionDataAccessor ( const FGuid& Version
)

   NiagaraScript.h  

virtual bool IsVersioningEnabled()

 If true then this script asset uses active version control to track changes. NiagaraScript.h  

Static

Name Remarks Include Path Unreal Specifiers
Infrastructure for GPU compute Shaders. NiagaraScript.h  

static bool BinaryToExecData ( const UNiagaraScript* Script,
const TArray< uint8 >& InBinaryData,
FNiagaraVMExecutableData& OutExecData
)

 Helper to convert the struct from its binary data out of the DDC to it's actual in-memory version. NiagaraScript.h  

static void BuildClassSchema ( FAppendToClassSchemaContext& Context
)

 Called from UNiagaraSystem::AppendToClassSchema() to collect the Script specific details for iterative cooking NiagaraScript.h  

static FString BuildNiagaraDDCKeyString ( const FNiagaraVMExecutableDataId& CompileId,
const FString& ScriptPath
)

 Builds the DDC string for the derived data cache using the supplied CompiledId and ScriptPath NiagaraScript.h  

static bool ContainsEquivilentUsage ( const TArray< ENiagaraScriptUsage >& Usages,
ENiagaraScriptUsage InUsage
)

   NiagaraScript.h  

static bool ConvertUsageToGroup ( ENiagaraScriptUsage InUsage,
ENiagaraScriptGroup& OutGroup
)

   NiagaraScript.h  

static UNiagaraDataInterface * CopyDataInterface ( UNiagaraDataInterface* Src,
UObject* Owner
)

   NiagaraScript.h  

static bool ExecToBinaryData ( const UNiagaraScript* Script,
TArray< uint8 >& OutBinaryData,
FNiagaraVMExecutableData& InExecData
)

 Reverse of the BinaryToExecData() function NiagaraScript.h  

static ERHIFeatureLevel::Type GetPreviewFeatureLevel()

   NiagaraScript.h  

static TArray< ENiagaraScriptUsage > GetSupportedUsageContextsForBitmask ( int32 InModuleUsageBitmask,
bool bIncludeHiddenUsages
)

   NiagaraScript.h  

static bool IsCompilable ( ENiagaraScriptUsage Usage
)

   NiagaraScript.h  
  NiagaraScript.h  

static bool IsEmitterScript ( ENiagaraScriptUsage Usage
)

   NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  

static bool IsEquivalentUsage ( ENiagaraScriptUsage InUsageA,
ENiagaraScriptUsage InUsageB
)

   NiagaraScript.h  

static bool IsFunctionScript ( ENiagaraScriptUsage Usage
)

   NiagaraScript.h  

static bool IsGPUScript ( ENiagaraScriptUsage Usage
)

   NiagaraScript.h  
  NiagaraScript.h  

static bool IsModuleScript ( ENiagaraScriptUsage Usage
)

   NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  

static bool IsParticleScript ( ENiagaraScriptUsage Usage
)

   NiagaraScript.h  
  NiagaraScript.h  

static bool IsParticleStageScript ( ENiagaraScriptUsage Usage
)

   NiagaraScript.h  
  NiagaraScript.h  

static bool IsSpawnScript ( ENiagaraScriptUsage Usage
)

   NiagaraScript.h  

static bool IsStandaloneScript ( ENiagaraScriptUsage Usage
)

   NiagaraScript.h  

static bool IsSupportedUsageContextForBitmask ( int32 InModuleUsageBitmask,
ENiagaraScriptUsage InUsageContext,
bool bIncludeHiddenUsages
)

   NiagaraScript.h  

static bool IsSystemScript ( ENiagaraScriptUsage Usage
)

   NiagaraScript.h  
  NiagaraScript.h  
  NiagaraScript.h  

static bool IsUsageDependentOn ( ENiagaraScriptUsage InUsageA,
ENiagaraScriptUsage InUsageB
)

 Is usage A dependent on Usage B? NiagaraScript.h  

static void SetPreviewFeatureLevel ( ERHIFeatureLevel::Type PreviewFeatureLevel
)

   NiagaraScript.h  

static bool ShouldUseDDC()

   NiagaraScript.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bDeprecated_DEPRECATED uint32 Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
bExperimental_DEPRECATED uint32 Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
bExposeToLibrary_DEPRECATED uint32 Deprecated, use LibraryVisibility instead. NiagaraScript.h
  • Meta=(DeprecatedProperty)
Category_DEPRECATED FText Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
CollapsedViewFormat_DEPRECATED FText Deprecated, use LibraryVisibility instead. NiagaraScript.h
  • Meta=(DeprecatedProperty)
ConversionUtility_DEPRECATED TSubclassOf< UNiagaraConvertInPlaceUtilityBase > Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
DeprecationMessage_DEPRECATED FText Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
DeprecationRecommendation_DEPRECATED TObjectPtr< UNiagaraScript > Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
Description_DEPRECATED FText Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
ExperimentalMessage_DEPRECATED FText Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
Keywords_DEPRECATED FText Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
LibraryVisibility_DEPRECATED ENiagaraScriptLibraryVisibility Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
ModuleUsageBitmask_DEPRECATED int32 Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
NoteMessage_DEPRECATED FText Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
NumericOutputTypeSelectionMode_DEPRECATED ENiagaraNumericOutputTypeSelectionMode Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
ProvidedDependencies_DEPRECATED TArray< FName > Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
RequiredDependencies_DEPRECATED TArray< FNiagaraModuleDependency > Use property in struct returned from GetScriptData() instead NiagaraScript.h
  • Meta=(DeprecatedProperty)
ScriptMetaData_DEPRECATED TMap< FName, FString > Deprecated, use LibraryVisibility instead. NiagaraScript.h
  • Meta=(DeprecatedProperty)
Source_DEPRECATED TObjectPtr< class UNiagaraScriptSourceBase > 'Source' data/graphs for this script NiagaraScript.h
  • Meta=(DeprecatedProperty)
UsageIndex_DEPRECATED int32 Which instance of the usage in the graph to use. This is now deprecated and is handled by UsageId. NiagaraScript.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page