1. Epic GamesDeveloper
  3. UNiagaraScriptSourceBase

UNiagaraScriptSourceBase

Runtime data for a Niagara system

API > API/Plugins > API/Plugins/Niagara

Runtime data for a Niagara system

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

Syntax

UCLASS (MinimalAPI)  
class UNiagaraScriptSourceBase : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraScriptSourceBase ( const FObjectInitializer& ObjectInitializer
)

   NiagaraScriptSourceBase.h  

Typedefs

Name Type Remarks Include Path
FOnChanged TMulticastDelegate_NoParams< void >   NiagaraScriptSourceBase.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ExposedVectorConstants TArray< TSharedPtr< EditorExposedVectorConstant > >   NiagaraScriptSourceBase.h  
ExposedVectorCurveConstants TArray< TSharedPtr< EditorExposedVectorCurveConstant > >   NiagaraScriptSourceBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AddModuleIfMissing ( FString ModulePath,
ENiagaraScriptUsage Usage,
bool& bOutFoundModule
)

 Adds a module if it isn't already in the graph. NiagaraScriptSourceBase.h  

virtual void ChangedLinkedInputTypes ( const FNiagaraVariable& ParametersToCheck,
const FNiagaraTypeDefinition& NewType
)

   NiagaraScriptSourceBase.h  

virtual void CleanUpOldAndInitializeNewRapidIterationParameters ( const FVersionedNiagaraEmitter& Emitter,
ENiagaraScriptUsage ScriptUsage,
FGuid ScriptUsageId,
FNiagaraParameterStore& RapidIterationParameters
) const

   NiagaraScriptSourceBase.h  

virtual void CollectDataInterfaces ( TArray< const UNiagaraDataInterfaceBase* >& DataInterfaces
) const

   NiagaraScriptSourceBase.h  

virtual TMap< FName, UNiagaraDataInterface * > ComputeObjectNameMap ( UNiagaraSystem& System,
ENiagaraScriptUsage Usage,
FGuid UsageId,
FString EmitterUniqueName
) const

   NiagaraScriptSourceBase.h  

virtual void ComputeVMCompilationId ( FNiagaraVMExecutableDataId& Id,
FNiagaraScriptHashCollector& HashCollector,
ENiagaraScriptUsage InUsage,
const FGuid& InUsageId
) const

   NiagaraScriptSourceBase.h  

virtual void ForceGraphToRecompileOnNextCheck()

   NiagaraScriptSourceBase.h  

virtual FGuid GetChangeID()

   NiagaraScriptSourceBase.h  

virtual FGuid GetCompileBaseId ( ENiagaraScriptUsage InUsage,
const FGuid& InUsageId
) const

   NiagaraScriptSourceBase.h  

virtual FNiagaraCompileHash GetCompileHash ( ENiagaraScriptUsage InUsage,
const FGuid& InUsageId
) const

   NiagaraScriptSourceBase.h  

virtual void GetLinkedPositionTypeInputs ( const TArray< FNiagaraVariable >& ParametersToCheck,
TSet< FNiagaraVariable >& OutLinkedParameters
)

 Checks if any of the provided variables are linked to function inputs of position type data NiagaraScriptSourceBase.h  

virtual bool IsSynchronized ( const FGuid& InChangeId
)

 Determines if the input change id is equal to the current source graph's change id. NiagaraScriptSourceBase.h  

virtual void MarkNotSynchronized ( FString Reason
)

 Enforce that the source graph is now out of sync with the script. NiagaraScriptSourceBase.h  

virtual void MigrateParameterDataToHierarchyRoot ( FVersionedNiagaraScriptData& OwnerData
)

   NiagaraScriptSourceBase.h  

FOnChanged & OnChanged()

   NiagaraScriptSourceBase.h  

virtual void PostLoadFromEmitter ( FVersionedNiagaraEmitter OwningEmitter
)

 Allows the derived editor only script source to handle a post load requested by an owning emitter. NiagaraScriptSourceBase.h  

virtual TSharedPtr< FNiagaraCompileRequestDataBase, ESPMode::ThreadSafe > PreCompile ( UNiagaraEmitter* Emitter,
const TArray< FNiagaraVariable >& EncounterableVariables,
TArray< TSharedPtr< FNiagaraCompileRequestDataBase, ESPMode::ThreadSafe > >& ReferencedCompileReque...,
bool bClearErrors
)

 Cause the source to build up any internal variables that will be useful in the compilation process. NiagaraScriptSourceBase.h  

virtual void RefreshFromExternalChanges()

   NiagaraScriptSourceBase.h  

virtual void RefreshGraphCompileId()

 Will conditionally refresh the graph's CompileId. NiagaraScriptSourceBase.h  

virtual void RegisterVMCompilationIdDependencies ( FNiagaraScriptHashCollector& Collector,
ENiagaraScriptUsage InUsage,
const FGuid& InUsageId
) const

   NiagaraScriptSourceBase.h  

virtual void RenameGraphAssignmentAndSetNodePins ( const FName OldName,
const FName NewName
)

 Rename all graph assignment and map set node pins. NiagaraScriptSourceBase.h  

virtual void ReplaceScriptReferences ( UNiagaraScript* OldScript,
UNiagaraScript* NewScript
)

   NiagaraScriptSourceBase.h  

virtual void ReportAnalyticsData ( FNiagaraScriptSourceAnalytics& InData
) const

   NiagaraScriptSourceBase.h  

virtual void SynchronizeGraphParametersWithParameterDefinitions ( const TArray< UNiagaraParameterDefinitionsBase* > TargetDefinitions,
const TArray< UNiagaraParameterDefinitionsBase* > AllDefinitions,
const TSet< FGuid >& AllDefinitionsParameterIds,
INiagaraParameterDefinitionsSubscriber* Subscriber,
FSynchronizeWithParameterDefinitionsArgs Args
)

 Synchronize all source script variables that have been changed or removed from the parameter definitions to all eligible destination script variables owned by the graph. NiagaraScriptSourceBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsEditorOnly()

   NiagaraScriptSourceBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page