Class NodeData
Represents node data describing a certain INode
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public class NodeDataProperties
Category
Gets the category of the node this data represents
Declaration
public string Category { get; }Property Value
| Type | Description |
|---|---|
| string |
Description
Gets the description of the node this data represents
Declaration
public string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
HelpUrl
Gets the help URL of the node this data represents
Declaration
public string HelpUrl { get; }Property Value
| Type | Description |
|---|---|
| string |
InputType
Gets the primary input type of the node this data represents
Declaration
public Type? InputType { get; }Property Value
| Type | Description |
|---|---|
| Type |
Name
Gets the name of the node this data represents
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
OutputType
Gets the primary output of the node this data represents
Declaration
public Type? OutputType { get; }Property Value
| Type | Description |
|---|---|
| Type |
Plugin
Gets the plugin that provided this node data
Declaration
public Plugin Plugin { get; }Property Value
| Type | Description |
|---|---|
| Plugin |
Type
Gets the type of INode this data represents
Declaration
public Type Type { get; }Property Value
| Type | Description |
|---|---|
| Type |
Methods
CreateNode(INodeScript, NodeEntity?)
Creates a new instance of the node this data represents
Declaration
public INode CreateNode(INodeScript script, NodeEntity? entity)Parameters
| Type | Name | Description |
|---|---|---|
| INodeScript | script | The script to create the node for |
| NodeEntity | entity | An optional storage entity to apply to the node |
Returns
| Type | Description |
|---|---|
| INode | The returning node of type Type |
IsCompatibleWithPin(IPin?)
Determines whether the given pin is compatible with this node data's node.
Declaration
public bool IsCompatibleWithPin(IPin? pin)Parameters
| Type | Name | Description |
|---|---|---|
| IPin | pin | The pin to check compatibility with, if null then the node data is always considered compatible. |
Returns
| Type | Description |
|---|---|
| bool | true if the pin is compatible with this node data's node; otherwise false. |
MatchesSearch(string)
Determines whether the given text matches this node data for a search query.
Declaration
public bool MatchesSearch(string text)Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The text to search for. |
Returns
| Type | Description |
|---|---|
| bool |