unreal.BlueprintGraphPin

class unreal.BlueprintGraphPin

Bases: StructBase

A value type representing a blueprint graph pin (underlying native type: UEdGraphPin). Use IsValid() to detect whether it represents a real pin value (e.g. after finding a pin on a node).

C++ Source:

• Module: BlueprintEditorLibrary

• File: BlueprintGraphPin.h

break_pin_links() → bool

Breaks all pin links associated with this pin

Return type:

bool

break_single_pin_link(other) → bool

Breaks a pin link between this pin and Other

Parameters:

other (BlueprintGraphPin)

Return type:

bool

can_create_connection(other) → bool

Returns true if this and Other pin can be connected. Performing connection may result in implicitly created conversion nodes.

Parameters:

other (BlueprintGraphPin)

Return type:

bool

get_owning_node() → K2Node

Returns the pin’s node

Return type:

K2Node

get_pin_direction() → EdGraphPinDirection

Returns the direction of the pin (either EGPD_Output or EGPD_Input)

Return type:

EdGraphPinDirection

get_pin_name() → Name

Returns the low level name of the pin

Return type:

Name

get_pin_type() → EdGraphPinType

Returns the pin’s type, FEdGraphPinType is mostly opaque to script but can be used e.g. to create variables of the same type

Return type:

EdGraphPinType

get_pin_type_as_json_schema() → str

Returns a json schema encoded description of the pin’s type:

Return type:

str

get_pin_type_display_string() → Text

Returns the string used to describe the pin type in the blueprint UI

Return type:

Text

get_pin_value() → str

Returns the literal value associated with the pin. Empty string for pins that have nothing set or are connected to some other pin:

Return type:

str

is_same_native_pin(other) → bool

Because these pin objects are proxies for the underlying native pin, this function should be used for establishing whether to FBlueprintGraphPin values refer to the same pin on a node

Parameters:

other (BlueprintGraphPin)

Returns:

true if the Other pin and this Pin are the same pin

Return type:

bool

is_valid() → bool

Returns:

true if the pin has a valid underlying pin

Return type:

bool

list_connected_pins() → Array[BlueprintGraphPin]

Returns a list of pins this pin is connected to, note that these pin objects are proxies and so comparison to other pin objects must be done via IsSameNativePin

Return type:

Array[BlueprintGraphPin]

set_pin_value(value) → bool

Sets the literal value associated with this pin, returning false if the value is not valid

Parameters:

value (str)

Return type:

bool

try_create_connection(other) → bool

Tries to create a connection between this pin and Other, returning false if the connection is not allowed

Parameters:

other (BlueprintGraphPin)

Return type:

bool