Interface INodeService
A service that provides access to the node system
Namespace: Artemis.Core.Services
Assembly: Artemis.Core.dll
Syntax
public interface INodeServiceProperties
AvailableNodes
Gets all available nodes
Declaration
IEnumerable<NodeData> AvailableNodes { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<NodeData> |
Methods
ExportScript(NodeScript)
Exports the provided node script to JSON.
Declaration
string ExportScript(NodeScript nodeScript)Parameters
| Type | Name | Description |
|---|---|---|
| NodeScript | nodeScript | The node script to export. |
Returns
| Type | Description |
|---|---|
| string | The resulting JSON. |
GetRegisteredTypes()
Gets all currently available node pin types.
Declaration
List<Type> GetRegisteredTypes()Returns
| Type | Description |
|---|---|
| List<Type> | A List<T> of Type containing the currently available node pin types. |
GetTypeColorRegistration(Type)
Gets the best matching registration for the provided type
Declaration
TypeColorRegistration GetTypeColorRegistration(Type type)Parameters
| Type | Name | Description |
|---|---|---|
| Type | type |
Returns
| Type | Description |
|---|---|
| TypeColorRegistration |
ImportScript(string, NodeScript)
Imports the provided JSON onto the provided node script, overwriting any existing contents.
Declaration
void ImportScript(string json, NodeScript target)Parameters
| Type | Name | Description |
|---|---|---|
| string | json | The JSON to import. |
| NodeScript | target | The target node script whose contents to overwrite. |
RegisterNodeType(Plugin, Type)
Registers a node of the provided nodeType
Declaration
NodeTypeRegistration RegisterNodeType(Plugin plugin, Type nodeType)Parameters
| Type | Name | Description |
|---|---|---|
| Plugin | plugin | The plugin the node belongs to |
| Type | nodeType | The type of node to initialize |
Returns
| Type | Description |
|---|---|
| NodeTypeRegistration |
RegisterTypeColor(Plugin, Type, SKColor)
Registers a type with a provided color for use in the node editor
Declaration
TypeColorRegistration RegisterTypeColor(Plugin plugin, Type type, SKColor color)Parameters
| Type | Name | Description |
|---|---|---|
| Plugin | plugin | The plugin making the registration |
| Type | type | The type to associate the color with |
| SKColor | color | The color to display |
Returns
| Type | Description |
|---|---|
| TypeColorRegistration |