Navigation
Unreal Engine C++ API Reference > Plugins > NiagaraEditor
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UEdGraphNode
- UNiagaraNode
- UNiagaraNodeDataSetBase
- UNiagaraNodeReadDataSet
- UNiagaraNodeWriteDataSet
- UNiagaraNodeInput
- UNiagaraNodeOutput
- UNiagaraNodeWithDynamicPins
- UNiagaraNodeFunctionCall
- UNiagaraNodeAssignment
- UNiagaraNodeCustomHlsl
- UNiagaraNodeOp
References
Module | NiagaraEditor |
Header | /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraNode.h |
Include | #include "NiagaraNode.h" |
Syntax
UCLASS&40;MinimalAPI&41;
class UNiagaraNode : public UEdGraphNode
Variables
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
FGuid | ChangeId | The current change identifier for this node. Used to sync status with UNiagaraScripts. |
![]() |
TArray< FGuid > | PinsGuidsWithRenamePending | |
![]() |
FOnNodeVisualsChanged | VisualsChangedDelegate |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
UNiagaraNode
(
const FObjectInitializer& ObjectInitializer |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | AddWidgetsToInputBox
(
TSharedPtr< SVerticalBox > InputBox |
Virtual function to allow for custom widgets in the input or output box |
![]() ![]() |
void | AddWidgetsToOutputBox
(
TSharedPtr< SVerticalBox > OutputBox |
|
![]() ![]() ![]() |
bool | AllowExternalPinTypeChanges
(
const UEdGraphPin* InGraphPin |
Determine whether we are allowed to change a pin's type from UI. |
![]() ![]() ![]() |
bool | AllowNiagaraTypeForPinTypeChange
(
const FNiagaraTypeDefinition& InType, |
Determine whether or not a pin can be changed to a certain type. |
![]() ![]() |
bool | AppendCompileHash
(
FNiagaraCompileHashVisitor* InVisitor |
Entry point for generating the compile hash. |
![]() ![]() ![]() |
void | AppendFunctionAliasForContext
(
const FNiagaraGraphFunctionAliasContext& InFunctionAliasContext, |
|
![]() ![]() ![]() |
void | BuildParameterMapHistory
(
FNiagaraParameterMapHistoryBuilder& OutHistory, |
Adds the current node information to the parameter map history |
![]() ![]() ![]() |
bool | CanAddToGraph
(
UNiagaraGraph* TargetGraph, |
Apply any node-specific logic to determine if it is safe to add this node to the graph. |
![]() ![]() |
bool | CancelEditablePinName
(
const FText& InName, |
Notify the rename was cancelled. |
![]() ![]() |
bool | CommitEditablePinName
(
const FText& InName, |
Verify that the potential rename has produced acceptable results for a pin. |
![]() ![]() ![]() |
void | Compile
(
FTranslator* Translator, |
|
![]() ![]() ![]() |
int32 | CompileInputPin
(
FTranslator* Translator, |
|
![]() ![]() |
bool | CompileInputPins
(
FTranslator* Translator, |
|
![]() ![]() |
bool | ConvertNumericPinToType
(
UEdGraphPin* InGraphPin, |
Convert the type of an existing numeric pin to a more known type. |
![]() ![]() |
TSharedRef< SWidget > | ||
![]() |
void | ForceChangeId
(
const FGuid& InId, |
Set the change id for this node to an explicit value. This should only be called by internal code. |
![]() ![]() ![]() |
void | GatherExternalDependencyData
(
ENiagaraScriptUsage InUsage, |
Go through all the external dependencies of this node in isolation and add them to the reference id list. |
![]() ![]() ![]() |
bool | GenerateCompileHashForClassMembers
(
const UClass* InClass, |
Go through all class members for a given UClass on this object and hash them into the visitor. |
![]() ![]() |
const FGuid & | GetChangeId () |
Get the change id for this node. |
![]() ![]() ![]() |
TOptional< float > | ||
![]() ![]() ![]() |
FText | If this does not return an empty title, compact mode will be activated putting the text into the center of the node. | |
![]() ![]() ![]() |
void | GetCompilationInputPins
(
FPinCollectorArray& InputPins |
|
![]() ![]() ![]() |
void | GetCompilationOutputPins
(
FPinCollectorArray& OutputPins |
|
![]() ![]() |
UEdGraphPin * | GetInputPin
(
int32 InputIndex |
|
![]() ![]() |
void | GetInputPins
(
ContainerType& OutInputPins |
|
![]() ![]() |
void | GetInputPinsInternal
(
ContainerType& OutInputPins |
|
![]() |
bool | GetIsPinRenamePending
(
const UEdGraphPin* Pin |
Returns whether or not the supplied pin has a rename pending. |
![]() |
UNiagaraGraph * | Get the Niagara graph that owns this node | |
![]() ![]() |
const UNiagaraGraph * | Get the Niagara graph that owns this node | |
![]() ![]() ![]() |
ENiagaraNumericOutputTypeSelectionMode | Gets which mode to use when deducing the type of numeric output pins from the types of the input pins. | |
![]() ![]() |
UEdGraphPin * | GetOutputPin
(
int32 OutputIndex |
|
![]() ![]() |
void | GetOutputPins
(
ContainerType& OutOutputPins |
|
![]() ![]() |
void | GetOutputPinsInternal
(
ContainerType& OutOutputPins |
|
![]() ![]() ![]() |
UEdGraphPin * | GetPassThroughPin
(
const UEdGraphPin* LocallyOwnedOutputPin, |
|
![]() ![]() |
UEdGraphPin * | GetPinByPersistentGuid
(
const FGuid& InGuid |
|
![]() ![]() ![]() |
UObject * | Gets the asset referenced by this node, or nullptr if there isn't one. | |
![]() ![]() |
UNiagaraScriptSource * | GetSource () |
Get the source object |
![]() ![]() |
bool | GetTooltipTextForKnownPin
(
const UEdGraphPin& Pin, |
If the pin is a known name (like Engine.DeltaTime) this tries to return a default tooltip for it. |
![]() ![]() ![]() |
UEdGraphPin * | GetTracedOutputPin
(
UEdGraphPin* LocallyOwnedOutputPin, |
Traces one of this node's output pins to its source output pin. |
![]() ![]() ![]() |
void | GetWildcardPinHoverConnectionTextAddition
(
const UEdGraphPin* WildcardPin, |
|
![]() ![]() |
bool | IsParameterMapPin
(
const UEdGraphPin* Pin |
|
![]() ![]() ![]() |
bool | IsPinNameEditable
(
const UEdGraphPin* GraphPinObj |
Determine whether or not a pin should be renamable. |
![]() ![]() ![]() |
bool | IsPinNameEditableUponCreation
(
const UEdGraphPin* GraphPinObj |
Determine whether or not a specific pin should immediately be opened for rename. |
![]() ![]() ![]() |
bool | IsValidPinToCompile
(
UEdGraphPin* Pin |
|
![]() |
void | MarkNodeRequiresSynchronization
(
FString Reason, |
Identify that this node has undergone changes that will require synchronization with a compiled script. |
![]() ![]() ![]() |
bool | NestedPropertiesAppendCompileHash
(
const void* Container, |
Helper function to hash arbitrary UProperty entries (Arrays, Maps, Structs, etc). |
![]() ![]() |
bool | NiagaraNodeAppendCompileHash
(
FNiagaraCompileHashVisitor* InVisitor |
Write out the specific entries for UNiagaraNode into the visitor hash. |
![]() |
void | NumericResolutionByPins
(
const UEdGraphSchema_Niagara* Schema, |
|
![]() ![]() |
bool | OnNewPinTypeRequested
(
UEdGraphPin* PinToChange, |
Pin type changes are handled by the individual subclasses to account for pin sets (like the if node or select node) |
![]() ![]() |
void | ||
![]() |
FOnNodeVisualsChanged & | ||
![]() ![]() ![]() |
void | ||
![]() ![]() ![]() |
bool | PinAppendCompileHash
(
const UEdGraphPin* InPin, |
Write out the specific entries of this pin to the visitor hash. |
![]() ![]() ![]() |
bool | PODPropertyAppendCompileHash
(
const void* Container, |
For a simple Plain old data type UProperty, hash the data. |
![]() |
bool | ReallocatePins
(
bool bMarkNeedsResynchronizeOnChange |
|
![]() ![]() |
bool | Refreshes the node due to external changes, e.g. the underlying function changed for a function call node. | |
![]() ![]() ![]() |
void | RegisterPassthroughPin
(
FNiagaraParameterMapHistoryBuilder& OutHistory, |
Basically routes the pin through the parameter map builder so that it looks like a regular pin. |
![]() |
void | RequestNewPinType
(
UEdGraphPin* PinToChange, |
Request a pin type change to a specific type. |
![]() ![]() ![]() |
FNiagaraTypeDefinition | ResolveCustomNumericType
(
const TArray< FNiagaraTypeDefinition >& NonNumericInputs |
|
![]() ![]() |
void | ResolveNumerics
(
const UEdGraphSchema_Niagara* Schema, |
|
![]() ![]() ![]() |
void | RouteParameterMapAroundMe
(
FNiagaraParameterMapHistoryBuilder& OutHistory, |
Route input parameter map to output parameter map if it exists. |
![]() |
void | SetIsPinRenamePending
(
const UEdGraphPin* Pin, |
Sets whether or not the supplied pin has a rename pending. |
![]() ![]() |
bool | SetPinDefaultToTypeDefaultIfUnset
(
UEdGraphPin* InPin |
|
![]() ![]() |
bool | ||
![]() ![]() |
bool | SubstituteCompiledPin
(
FTranslator* Translator, |
Allows a node to replace a pin that is about to be compiled with another pin. |
![]() ![]() |
UEdGraphPin * | TraceOutputPin
(
UEdGraphPin* LocallyOwnedOutputPin, |
Traces a node's output pins to its source output pin. |
![]() ![]() ![]() |
void | UpdateCompileHashForNode
(
FSHA1& HashState |
Old style compile hash code. To be removed in the future. |
![]() ![]() ![]() |
bool | VerifyEditablePinName
(
const FText& InName, |
Verify that the potential rename has produced acceptable results for a pin. |
Overridden from UEdGraphNode
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | AutowireNewNode
(
UEdGraphPin* FromPin |
Autowire a newly created node. |
![]() ![]() ![]() |
bool | CanCreateUnderSpecifiedSchema
(
const UEdGraphSchema* Schema |
Determine if this node can be created under the specified schema |
![]() ![]() |
TSharedPtr< SGraphNode > | Create a visual widget to represent this node in a graph editor or graph panel. | |
![]() ![]() ![]() |
void | GatherForLocalization
(
FPropertyLocalizationDataGatherer& PropertyLocalizationDataGatherer, |
|
![]() ![]() ![]() |
void | GetNodeContextMenuActions
(
UToolMenu* Menu, |
Gets a list of actions that can be done to this particular node |
![]() ![]() ![]() |
UEdGraphPin * | GetPassThroughPin
(
const UEdGraphPin* FromPin |
Return the matching "pass-through" pin for the given pin (if supported by this node) |
![]() ![]() ![]() |
void | GetPinHoverText
(
const UEdGraphPin& Pin, |
Fetch the hover text for a pin when the graph is being edited. |
![]() ![]() |
void | Called when something external to this node has changed the connection list of any of the pins in the node | |
![]() ![]() |
void | OnPinRemoved
(
UEdGraphPin* InRemovedPin |
Called when a pin is removed |
![]() ![]() |
void | OnRenameNode
(
const FString& NewName |
Called when this node is being renamed after a successful name validation |
![]() ![]() |
void | PinConnectionListChanged
(
UEdGraphPin* Pin |
Called when the connection list of one of the pins of this node is changed in the editor |
![]() ![]() |
void | PinDefaultValueChanged
(
UEdGraphPin* Pin |
Called when the DefaultValue of one of the pins of this node is changed in the editor |
![]() ![]() |
void | PinTypeChanged
(
UEdGraphPin* Pin |
Called when one of the pins of this node has had its' pin type changed from an external source (like the SPinTypeSelector in the case of kismet) |
![]() ![]() |
void | A chance to initialize a new node; called just once when a new node is created, before AutowireNewNode or AllocateDefaultPins is called. |
Overridden from UObject
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
Typedefs
Name | Description |
---|---|
FOnNodeVisualsChanged | |
FTranslator |