Represents a specialized node that can only exist within a BlockNode.ContextNode.
Use block nodes to define logic or operations that are scoped within a BlockNode.ContextNode.
A block node cannot be added directly to the graph; it must be a child of a valid context node type.
Attempting to instantiate or add a BlockNode outside of a BlockNode.ContextNode will result in invalid behavior.
To limit which context types can contain a block node, use the UseWithContextAttribute.
| Property | Description |
|---|---|
| ContextNode | The BlockNode.ContextNode that contains this block node. |
| Index | The index of this block node within the list of blocks in the context node. |
| Property | Description |
|---|---|
| DefaultColor | The highlight color of the node. The highlight is located on the upper border of nodes, and on the upper and lower borders of context nodes. |
| Graph | The Graph that contains this node. |
| InputPortCount | The number of input ports on the node. |
| NodeOptionCount | The number of node options defined in the node. |
| NodeOptions | The node options defined on this node. |
| OutputPortCount | The number of output ports on the node. |
| Position | The position of the node in the graph. |
| Title | The main text displayed in the node's header. |
| Tooltip | The text displayed when hovering over the node's header. |
| Method | Description |
|---|---|
| DefineNode | Defines the structure of the node by building its ports and options. |
| GetInputPort | Retrieves an input port using its index. |
| GetInputPortByName | Retrieves an input port using its name. |
| GetInputPorts | Retrieves all input ports on the node in the order they are displayed. |
| GetNodeOption | Retrieves a node option using its zero-based index. |
| GetNodeOptionByName | Retrieves a node option using its name. |
| GetOutputPort | Retrieves an output port using its index in the displayed order. |
| GetOutputPortByName | Retrieves an output port using its name. |
| GetOutputPorts | Retrieves all output ports on the node in the order they are displayed. |
| OnDisable | Called when the node is removed or when the graph is disabled. |
| OnEnable | Called when the node is created or when the graph is enabled. |
| RemoveFromGraph | Removes the node from its graph. |
| Method | Description |
|---|---|
| OnDefineOptions | Called during Node.DefineNode to define the options available on the node. |
| OnDefinePorts | Called during Node.DefineNode to define the input and output ports of the node. |