UNiagaraScriptSource

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

NiagaraEditor

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraScriptSource.h

Include

#include "NiagaraScriptSource.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI)
class UNiagaraScriptSource : public UNiagaraScriptSourceBase

Variables

Name Description

Public variable UProperty

UNiagaraGraph &...

 

NodeGraph

Graph for particle update expression

Constructors

Name Description

Public function

UNiagaraScriptSource

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual Const

void

 

FixupRenamedParameters

(
    UNiagaraNode* Node,
    FNiagaraParameterStore& RapidItera...,
    const TArray< FNiagaraVariable >& ...,
    const TSet< FName >& ValidRapidIte...,
    const UNiagaraEmitter* Emitter,
    ENiagaraScriptUsage ScriptUsage
)

Overridden from UNiagaraScriptSourceBase

Name Description

Public function Virtual

bool

 

AddModuleIfMissing

(
    FString ModulePath,
    ENiagaraScriptUsage Usage,
    bool& bOutFoundModule
)

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

Public function Virtual Const

void

 

CleanUpOldAndInitializeNewRapidIterationParameters

(
    const UNiagaraEmitter* Emitter,
    ENiagaraScriptUsage ScriptUsage,
    FGuid ScriptUsageId,
    FNiagaraParameterStore& RapidItera...
)

Public function Virtual Const

void

 

CollectDataInterfaces

(
    TArray< const UNiagaraDataInterface...
)

Public function Virtual Const

void

 

ComputeVMCompilationId

(
    FNiagaraVMExecutableDataId& Id,
    ENiagaraScriptUsage InUsage,
    const FGuid& InUsageId,
    bool bForceRebuild
)

Public function Virtual

void

 

ForceGraphToRecompileOnNextCheck()

Public function Virtual

FGuid

 

GetChangeID()

Public function Virtual Const

FGuid

 

GetCompileBaseId

(
    ENiagaraScriptUsage InUsage,
    const FGuid& InUsageId
)

Public function Virtual Const

FNiagaraComp...

 

GetCompileHash

(
    ENiagaraScriptUsage InUsage,
    const FGuid& InUsageId
)

Public function Virtual

bool

 

IsSynchronized

(
    const FGuid& InChangeId
)

Virtual ENiagaraScriptCompileStatus Compile(UNiagaraScript* ScriptOwner, FString& OutGraphLevelErrorMessages) override;

Public function Virtual

void

 

MarkNotSynchronized

(
    FString Reason
)

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

Public function Virtual

void

 

PostLoadFromEmitter

(
    UNiagaraEmitter& OwningEmitter
)

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

Public function Virtual

void

 

RefreshFromExternalChanges()

Public function Virtual

void

 

RenameGraphAssignmentAndSetNodePins

(
    const FName OldName,
    const FName NewName
)

Rename all graph assignment and map set node pins.

Public function Virtual

void

 

SynchronizeGraphParametersWithParameterDefinitions

(
    const TArray< UNiagaraParameterDefi...,
    const TArray< FGuid >& ParameterDe...,
    FSynchronizeWithParameterDefinition...
)

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

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss