UK2Node_Variable

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

BlueprintGraph

Header

/Engine/Source/Editor/BlueprintGraph/Classes/K2Node_Variable.h

Include

#include "K2Node_Variable.h"

Syntax

class UK2Node_Variable : public UK2Node

Variables

Name Description

Public variable

TEnumAsByte< ES...

 

SelfContextInfo

Public variable

FMemberReferenc...

 

VariableReference

Reference to variable we want to set/get

Constructors

Name Description

Public function

UK2Node_Variable

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

CheckForErrors

(
    const UEdGraphSchema_K2* Schem...,
    FCompilerResultsLog& MessageLog
)

Validates there are no errors in the node

Public function

void

 

CreatePinForSelf()

Creates 'self' pin

Public function

bool

 

CreatePinForVariable

(
    EEdGraphPinDirection Direction,
    FName InPinName
)

Creates a reader or writer pin for a variable.

Public function Static

bool

 

DoesRenamedVariableMatch

(
    FName OldVariableName,
    FName NewVariableName,
    UStruct* StructType
)

Returns true if the variable names match, this looks for redirectors

Protected function Static

bool

 

FunctionParameterExists

(
    const UEdGraph* InFunctionGrap...,
    const FName InParameterName
)

Returns whether a Function Graph contains a parameter with the given name

Protected function Const

const UActor...

 

GetActorComponent

(
    const FProperty* VariablePrope...
)

Utility function to retrieve actor component for variable property.

Protected function Const

FBPVariableD...

 

GetBlueprintVarDescription()

Public function Const

FProperty &#...

 

GetPropertyForVariable()

Get the FProperty for this variable node

Public function Const

FProperty &#...

 

GetPropertyForVariableFromSkeleton()

Get the FProperty for this variable node

Public function Const

UEdGraphPin ...

 

GetValuePin()

Accessor for the value output pin of the node

Public function Static

FSlateIcon

 

GetVariableIconAndColor

(
    const UStruct* VarScope,
    FName VarName,
    FLinearColor& IconColorOut
)

Utility method intended to serve as a choke point for various slate widgets to grab an icon from (for a specified variable).

Public function Const

UClass *

 

GetVariableSourceClass()

Get the class to look for this variable in

Public function Static

FSlateIcon

 

GetVarIconFromPinType

(
    const FEdGraphPinType& InPinType,
    FLinearColor& IconColorOut
)

Utility method intended to serve as a choke point for various slate widgets to grab an icon from (for a specified variable pin type).

Public function Const

FName

 

GetVarName()

Util to get variable name

Public function Const

FString

 

GetVarNameString()

Util to get variable name as a string

Public function Const

FText

 

GetVarNameText()

Public function

bool

 

RecreatePinForVariable

(
    EEdGraphPinDirection Direction,
    TArray< UEdGraphPin* >& OldPi...,
    FName InPinName
)

Creates a reader or writer pin for a variable from an old pin.

Protected function

bool

 

RemapRestrictedLinkReference

(
    FName OldVariableName,
    FName NewVariableName,
    const UClass* MatchInVariableC...,
    const UClass* RemapIfLinkedToC...,
    bool bLogWarning
)

Remap a reference from one variable to another, if this variable is of class type 'MatchInVariableClass', and if linked to anything that is a child of 'RemapIfLinkedToClass'.

Public function

void

 

SetFromProperty

(
    const FProperty* Property,
    bool bSelfContext,
    UClass* OwnerClass
)

Set up this variable node from the supplied FProperty

Overridden from UK2Node

Name Description

Public function Virtual Const

ERedirectTyp...

 

DoPinsMatchForReconstruction

(
    const UEdGraphPin* NewPin,
    int32 NewPinIndex,
    const UEdGraphPin* OldPin,
    int32 OldPinIndex
)

Whether or not two pins match for purposes of reconnection after reconstruction.

Public function Virtual Const

bool

 

DrawNodeAsVariable()

Return whether to draw this node as a small variable node

Public function Virtual Const

FName

 

GetCornerIcon()

Public function Virtual Const

void

 

GetNodeAttributes

(
    TArray< TKeyValuePair< FString, FSt...
)

This function returns an arbitrary number of attributes that describe this node for analytics events

Public function Virtual Const

FText

 

GetToolTipHeading()

Public function Virtual

void

 

HandleVariableRenamed

(
    UBlueprint* InBlueprint,
    UClass* InVariableClass,
    UEdGraph* InGraph,
    const FName& InOldVarName,
    const FName& InNewVarName
)

Handle when a variable is renamed in the Blueprint Palette

Public function Virtual Const

bool

 

HasExternalDependencies

(
    TArray< class UStruct* >*...
)

Returns whether or not this node has dependencies on an external structure If OptionalOutput isn't null, it should be filled with the known dependencies objects (Classes, Structures, Functions, etc).

Public function Virtual Const

bool

 

ReferencesVariable

(
    const FName& InVarName,
    const UStruct* InScope
)

Return whether this node references the specified variable, give the supplied scope.

Public function Virtual

void

 

ReplaceReferences

(
    UBlueprint* InBlueprint,
    UBlueprint* InReplacementBluep...,
    const FMemberReference& InSource,
    const FMemberReference& InReplacem...
)

Replace any member references of source with replacement

Overridden from UEdGraphNode

Name Description

Public function Virtual

void

 

AutowireNewNode

(
    UEdGraphPin* FromPin
)

Autowire a newly created node.

Public function Virtual Const

bool

 

CanJumpToDefinition()

Returns true if it is possible to jump to the definition of this node (e.g., if it's a variable get or a function call)

Public function Virtual Const

bool

 

CanPasteHere

(
    const UEdGraph* TargetGraph
)

Determine if this node can live in the specified graph

Public function Virtual Const

FEdGraphNode...

 

GetDeprecationResponse

(
    EEdGraphNodeDeprecationType Depreca...
)

Returns the response to use when reporting a deprecation.

Public function Virtual Const

FString

 

GetDocumentationExcerptName()

Returns the name of the excerpt to display from the specified external documentation link for the graph node Default behavior is to return the class name (including prefix)

Public function Virtual Const

FString

 

GetDocumentationLink()

Returns the link used for external documentation for the graph node

Public function Virtual Const

FString

 

GetFindReferenceSearchString()

Gets the search string to find references to this node

Public function Virtual Const

FSlateIcon

 

GetIconAndTint

(
    FLinearColor& OutColor
)

Public function Virtual Const

UObject *...

 

GetJumpTargetForDoubleClick()

Returns the object that should be focused when double-clicking on this node (the object can be an actor, which selects it in the world, or a node/graph/pin)

Public function Virtual Const

FLinearColor

 

GetNodeTitleColor()

Gets the draw color of a node's title bar

Public function Virtual

FString

 

GetPinMetaData

(
    FName InPinName,
    FName InKey
)

Return the requested metadata for the pin if there is any

Public function Virtual Const

bool

 

HasDeprecatedReference()

Returns true if this node references a deprecated type or member.

Public function Virtual Const

void

 

JumpToDefinition()

Jump to the definition of this node (should only be called if CanJumpToDefinition() return true)

Public function Virtual

void

 

PostPasteNode()

Perform any fixups (deep copies of associated data, etc...) necessary after a node has been pasted in the editor

Public function Virtual

void

 

ReconstructNode()

Refresh the connectors on a node, preserving as many connections as it can.

Public function Virtual Const

void

 

ValidateNodeDuringCompilation

(
    FCompilerResultsLog& MessageLog
)

Gives each visual node a chance to do final validation before it's node is harvested for use at runtime.

Overridden from UObject

Name Description

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

Name Description

Protected variable

uint32: 1

 

bSelfContext_DEPRECATED

Whether or not this should be a "self" context

Protected variable

FName

 

VariableName_DEPRECATED

Name of variable

Protected variable

TSubclassOf< cl...

 

VariableSourceClass_DEPRECATED

Class that this variable is defined in. Should be NULL if bSelfContext is true.