1. Epic GamesDeveloper
  3. UNiagaraNodeCustomHlsl

UNiagaraNodeCustomHlsl

API > API/Plugins > API/Plugins/NiagaraEditor

   
Name UNiagaraNodeCustomHlsl
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraNodeCustomHlsl.h
Include Path #include "NiagaraNodeCustomHlsl.h"

Syntax

UCLASS (MinimalAPI)  
class UNiagaraNodeCustomHlsl : public UNiagaraNodeFunctionCall

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraNodeCustomHlsl ( const FObjectInitializer& ObjectInitializer
)

   NiagaraNodeCustomHlsl.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ScriptUsage ENiagaraScriptUsage   NiagaraNodeCustomHlsl.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AbsoluteIncludeFilePaths TArray< FFilePath > Links to hlsl files that will be included by the translator. These external files are not watched by the engine, so changes to them do not automatically trigger a recompile of Niagara scripts. NiagaraNodeCustomHlsl.h
  • EditAnywhere
  • Category="HLSL"
bIsShaderCodeShown bool Is the shader code UI shown? NiagaraNodeCustomHlsl.h  
CustomHlsl FString   NiagaraNodeCustomHlsl.h
  • EditAnywhere
  • Category="HLSL"
  • Meta=(MultiLine=true)
VirtualIncludeFilePaths TArray< FString > Links to hlsl files that will be included by the translator. NiagaraNodeCustomHlsl.h
  • EditAnywhere
  • Category="HLSL"

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CallsImpureDataInterfaceFunctions()

   NiagaraNodeCustomHlsl.h  

const FString & GetCustomHlsl()

   NiagaraNodeCustomHlsl.h  

FText GetHlslText()

   NiagaraNodeCustomHlsl.h  

void GetIncludeFilePaths ( TArray< FNiagaraCustomHlslInclude >& OutCustomHlslIncludeFilePaths
) const

   NiagaraNodeCustomHlsl.h  

bool GetTokens ( TArray< FStringView >& OutTokens,
bool IncludeComments,
bool IncludeWhitespace
) const

   NiagaraNodeCustomHlsl.h  

void InitAsCustomHlslDynamicInput ( const FNiagaraTypeDefinition& OutputType
)

   NiagaraNodeCustomHlsl.h  

bool IsShaderCodeShown()

   NiagaraNodeCustomHlsl.h  

void OnCustomHlslTextCommitted ( const FText& InText,
ETextCommit::Type InType
)

   NiagaraNodeCustomHlsl.h  

virtual bool ReferencesVariable ( const FNiagaraVariableBase& InVar
) const

   NiagaraNodeCustomHlsl.h  

void SetCustomHlsl ( const FString& InCustomHlsl
)

   NiagaraNodeCustomHlsl.h  

void SetShaderCodeShown ( bool bInShown
)

   NiagaraNodeCustomHlsl.h  

Overridden from UNiagaraNodeWithDynamicPins

Name Remarks Include Path Unreal Specifiers

virtual bool AllowNiagaraTypeForAddPin ( const FNiagaraTypeDefinition& InType
) const

 Determine whether or not a Niagara type is supported for an Add Pin possibility. NiagaraNodeCustomHlsl.h  

virtual bool AllowNiagaraTypeForAddPin ( const FNiagaraTypeDefinition& InType,
EEdGraphPinDirection InDirection
) const

   NiagaraNodeCustomHlsl.h  

Overridden from UNiagaraNode

Name Remarks Include Path Unreal Specifiers

virtual void BuildParameterMapHistory ( FNiagaraParameterMapHistoryBuilder& OutHistory,
bool bRecursive,
bool bFilterForCompilation
) const

 Adds the current node information to the parameter map history NiagaraNodeCustomHlsl.h  

virtual void GatherExternalDependencyData ( ENiagaraScriptUsage InUsage,
const FGuid& InUsageId,
FNiagaraScriptHashCollector& HashCollector
) const

 Go through all the external dependencies of this node in isolation and add them to the reference id list. NiagaraNodeCustomHlsl.h  

Overridden from UEdGraphNode

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< SGraphNode > CreateVisualWidget()

   NiagaraNodeCustomHlsl.h  

virtual FLinearColor GetNodeTitleColor()

   NiagaraNodeCustomHlsl.h  

virtual FText GetTooltipText()

   NiagaraNodeCustomHlsl.h  

virtual void OnRenameNode ( const FString& NewName
)

   NiagaraNodeCustomHlsl.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraNodeCustomHlsl.h  

Protected

Name Remarks Include Path Unreal Specifiers

void RebuildSignatureFromPins()

   NiagaraNodeCustomHlsl.h  

Overridden from UNiagaraNodeFunctionCall

Name Remarks Include Path Unreal Specifiers

virtual bool GetValidateDataInterfaces()

   NiagaraNodeCustomHlsl.h  

Overridden from UNiagaraNodeWithDynamicPins

Name Remarks Include Path Unreal Specifiers

virtual bool AllowDynamicPins()

   NiagaraNodeCustomHlsl.h  

virtual bool CanModifyPin ( const UEdGraphPin* Pin
) const

 Called to determine if this node can modify a given pin at all. NiagaraNodeCustomHlsl.h  

virtual bool CanMovePin ( const UEdGraphPin* Pin,
int32 DirectionToMove
) const

 Called to determine if a pin can be moved by the user. Negative values for up, positive for down. NiagaraNodeCustomHlsl.h  

virtual bool CanRemovePin ( const UEdGraphPin* Pin
) const

 Called to determine if a pin can be removed by the user. NiagaraNodeCustomHlsl.h  

virtual bool CanRenamePin ( const UEdGraphPin* Pin
) const

 Called to determine if a pin can be renamed by the user. NiagaraNodeCustomHlsl.h  

virtual void MoveDynamicPin ( UEdGraphPin* Pin,
int32 MoveAmount
)

 Moves a pin among the pins of the same direction. Negative values for up, positive for down. NiagaraNodeCustomHlsl.h  

virtual void OnNewTypedPinAdded ( UEdGraphPin*& NewPin
)

 Called when a new typed pin is added by the user. NiagaraNodeCustomHlsl.h  

virtual void OnPinRenamed ( UEdGraphPin* RenamedPin,
const FString& OldPinName
)

 Called when a pin is renamed. NiagaraNodeCustomHlsl.h  

virtual void RemoveDynamicPin ( UEdGraphPin* Pin
)

 Removes a pin from this node with a transaction. NiagaraNodeCustomHlsl.h  

Overridden from UNiagaraNode

Name Remarks Include Path Unreal Specifiers

virtual bool CancelEditablePinName ( const FText& InName,
UEdGraphPin* InGraphPinObj
)

 Notify the rename was cancelled. NiagaraNodeCustomHlsl.h  

virtual bool CommitEditablePinName ( const FText& InName,
UEdGraphPin* InGraphPinObj,
bool bSuppressEvents
)

 Verify that the potential rename has produced acceptable results for a pin. NiagaraNodeCustomHlsl.h  

virtual bool IsPinNameEditable ( const UEdGraphPin* GraphPinObj
) const

 Determine whether or not a pin should be renamable. NiagaraNodeCustomHlsl.h  

virtual bool IsPinNameEditableUponCreation ( const UEdGraphPin* GraphPinObj
) const

 Determine whether or not a specific pin should immediately be opened for rename. NiagaraNodeCustomHlsl.h  

virtual bool VerifyEditablePinName ( const FText& InName,
FText& OutErrorMessage,
const UEdGraphPin* InGraphPinObj
) const

 Called in subclasses to restrict renaming. NiagaraNodeCustomHlsl.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool GetTokensFromString ( const FString& InHlsl,
TArray< FStringView >& OutTokens,
bool IncludeComments,
bool IncludeWhitespace
)

   NiagaraNodeCustomHlsl.h  

static uint32 ReplaceExactMatchTokens ( TArray< FString >& Tokens,
FStringView SrcString,
FStringView ReplaceString,
bool bAllowNamespaceSeparation
)

 Replace items in the tokens array if they start with the src string or optionally src string and a namespace delimiter. NiagaraNodeCustomHlsl.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page