`unreal.BlueprintGraphPinLibrary`¶

class unreal.BlueprintGraphPinLibrary(outer: Object | None = None, name: Name | str = 'None')¶

Bases: Object

API for FBlueprintGraphPin

C++ Source:

Module: BlueprintEditorLibrary
File: BlueprintGraphPin.h

classmethod break_pin_links(pin) → bool¶

Breaks all pin links associated with this pin

Parameters:: pin (BlueprintGraphPin)
Return type:: bool

classmethod break_single_pin_link(pin, other) → bool¶

Breaks a pin link between this pin and Other

Parameters:

pin (BlueprintGraphPin)
other (BlueprintGraphPin)

Return type:

bool

classmethod can_create_connection(pin, other) → bool¶

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

Parameters:

pin (BlueprintGraphPin)
other (BlueprintGraphPin)

Return type:

bool

classmethod get_owning_node(pin) → K2Node¶

Returns the pin’s node

Parameters:: pin (BlueprintGraphPin)
Return type:: K2Node

classmethod get_pin_direction(pin) → EdGraphPinDirection¶

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

Parameters:: pin (BlueprintGraphPin)
Return type:: EdGraphPinDirection

classmethod get_pin_name(pin) → Name¶

Returns the low level name of the pin

Parameters:: pin (BlueprintGraphPin)
Return type:: Name

classmethod get_pin_type(pin) → 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

Parameters:: pin (BlueprintGraphPin)
Return type:: EdGraphPinType

classmethod get_pin_type_as_json_schema(pin) → str¶

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

Parameters:: pin (BlueprintGraphPin)
Return type:: str

classmethod get_pin_type_display_string(pin) → Text¶

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

Parameters:: pin (BlueprintGraphPin)
Return type:: Text

classmethod get_pin_value(pin) → str¶

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

Parameters:: pin (BlueprintGraphPin)
Return type:: str

classmethod is_same_native_pin(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:

pin (BlueprintGraphPin)
other (BlueprintGraphPin)

Returns:

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

Return type:

bool

classmethod is_valid(pin) → bool¶

Parameters:: pin (BlueprintGraphPin)
Returns:: true if the pin has a valid underlying pin
Return type:: bool

classmethod list_connected_pins(pin) → 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