INodeOption
Interface for a node option.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Interface
- Namespace: Unity.GraphToolkit.Editor
- Assembly: UnityEditor
public interface INodeOption
Remarks
Node options are typed properties that appear under the node header and in the inspector when a node is selected. Unlike ports, they cannot receive values from wires. They allow the tool developers to change the behavior or topology of the node at edit time. For example, you can use node options to change the number of available ports on a node.
Each option has a unique INodeOption.Name (which must be unique per node for identification), a INodeOption.DisplayName (for the UI), and a INodeOption.DataType that defines the type of its value. Use INodeOption.TryGetValue to retrieve the option's value.
Properties
Property | Description |
|---|---|
| DataType | The data type of the node option. |
| DisplayName | The display name of the node option shown in the UI. |
| Name | The unique identifier of the node option. |
| Tooltip | The text displayed when hovering over the node option's display name. |
Methods
Method | Description |
|---|---|
| TryGetValue | Tries to retrieve the value of the node option using the specified type. |
| TrySetValue | Sets a new value for the node option. |