Rig VMPin

Rig VMPin

Choose your operating system:

Windows

macOS

Linux

On this page

Actions

Find Sub Pin

Returns a SubPin given a name / path or nullptr.

Target is Rig VMPin

Get Array Element Cpp Type

Returns the C++ data type of an element of the Pin array

Target is Rig VMPin

Get Array Size

Returns the number of elements within an array Pin

Target is Rig VMPin

Get CPPType

Returns the C++ data type of the pin

Target is Rig VMPin

Get CPPType Object

Returns the struct of the data type of the Pin, or nullptr otherwise.

Target is Rig VMPin

Get Custom Widget Name

Returns the name of a custom widget to be used for editing the Pin.

Target is Rig VMPin

Get Default Value

Returns the default value of the Pin as a string. Note that this value is computed based on the Pin's SubPins - so for example for a FVector typed Pin the default value is actually composed out of the default values of the X, Y and Z SubPins.

Target is Rig VMPin

Get Direction

Returns the direction of the pin

Target is Rig VMPin

Get Display Name

Returns the display label of the pin

Target is Rig VMPin

Get Enum

Returns the enum of the data type of the Pin, or nullptr otherwise.

Target is Rig VMPin

Get Graph

Returns the graph of this Pin.

Target is Rig VMPin

Get Linked Source Pins

Returns all of the linked source Pins, using this Pin as the target.

Target is Rig VMPin

Get Linked Target Pins

Returns all of the linked target Pins, using this Pin as the source.

Target is Rig VMPin

Get Links

Returns all of the links linked to this Pin.

Target is Rig VMPin

Get Node

Returns the node of this Pin.

Target is Rig VMPin

Get Original Pin from Injected Node

Returns the original pin for a pin on an injected

  1. This can be used to determine where a link should go in the user interface

Target is Rig VMPin

Get Parent Pin

Returns the parent Pin - or nullptr if the Pin is nested directly below a node.

Target is Rig VMPin

Get Pin for Link

Returns the pin to be used for a link. This might differ from this actual pin, since the pin might contain injected nodes.

Target is Rig VMPin

Get Pin Index

Returns the index of the Pin within the node / parent Pin

Target is Rig VMPin

Get Pin Path

Returns a . separated path containing all names of the pin and its owners, this includes the node name, for example "Node.Color.R"

Target is Rig VMPin

Get Root Pin

Returns the top-most parent Pin, so for example for "Node.Transform.Translation.X" this returns the Pin for "Node.Transform".

Target is Rig VMPin

Get Script Struct

Returns the struct of the data type of the Pin, or nullptr otherwise.

Target is Rig VMPin

Get Segment Path

Returns a . separated path containing all names of the pin within its main memory owner / storage. This is typically used to create an offset pointer within memory (FRigVMRegisterOffset). So for example for a PinPath such as "Node.Transform.Translation.X" the corresponding SegmentPath is "Translation.X", since the transform is the storage / memory.

Target is Rig VMPin

Get Source Links

Returns all of the source pins using this Pin as the target.

Target is Rig VMPin

Get Sub Pins

Returns all of the SubPins of this one.

Target is Rig VMPin

Get Target Links

Returns all of the target links, using this Pin as the source.

Target is Rig VMPin

Get Tool Tip Text

Returns the tooltip of this pin

Target is Rig VMPin

Is Array

Returns true if the data type of the Pin is an array

Target is Rig VMPin

Is Array Element

Returns true if the Pin is a SubPin within an array

Target is Rig VMPin

Is Defined as Constant

Returns true if the pin is defined as a constant value / literal

Target is Rig VMPin

Is Dynamic Array

Returns true if this pin represents a dynamic array

Target is Rig VMPin

Is Execute Context

Returns true if the C++ data type is an execute context

Target is Rig VMPin

Is Expanded

Returns true if the pin is currently expanded

Target is Rig VMPin

Is Linked To

Returns true if this Pin is linked to another Pin

Target is Rig VMPin

Is Reference Counted Container

Returns true if this data type is referenced counted

Target is Rig VMPin

Is Root Pin

Returns true if this pin is a root pin

Target is Rig VMPin

Is String Type

Returns true if the C++ data type is FString or FName

Target is Rig VMPin

Is Struct

Returns true if the data type of the Pin is a struct

Target is Rig VMPin

Is Struct Member

Returns true if the Pin is a SubPin within a struct

Target is Rig VMPin

Is Unknown Type

Returns true if the C++ data type is unknown

Target is Rig VMPin

Is UObject

Returns true if the data type of the Pin is a uobject

Target is Rig VMPin

Requires Watch

Returns true if the pin should be watched

Target is Rig VMPin