VoxelGraphFunction

public void AddConnection(uint srcNodeId, uint srcPortIndex, uint dstNodeId, uint dstPortIndex);

Connects the outputs of a node to the input of another node. Connecting a node to itself, or in a way that can lead it back to itself, is not supported.

public bool CanConnect(uint srcNodeId, uint srcPortIndex, uint dstNodeId, uint dstPortIndex);

Tests if two ports can be connected together.

public void Clear();

Removes all nodes from the graph. Input and output definitions will not be cleared.

public uint CreateFunctionNode(VoxelGraphFunction function, Vector2 position, uint id = 0);

Creates a node based on an existing graph (creates a "sub-graph instance").

public uint CreateNode(VoxelGraphFunction.NodeTypeId typeId, Vector2 position, uint id = 0);

Creates a graph node of a given type at a specific visual position. The position parameter does not affect how the graph will perform, however it helps organizing nodes. An optional ID can be specified. If left to 0, the ID will be generated. This function then returns the ID of the node, which may be useful to modify other properties of the node later.

public uint FindNodeByName(StringName name);

Finds a node with the specified name and returns its ID. If the node is not found, returns 0.

public Reckfell.Collections.Array GetConnections();

Gets an array describing all connections between nodes. The array has the following format:

[
    {
        "src_node_id": int,
        "src_port_index": int,
        "dst_node_id": int,
        "dst_port_index": int
    },
    ...
]

public Vector2 GetNodeGuiPosition(uint nodeId);

Get the position of the node in the graph editor.

public Vector2 GetNodeGuiSize(uint nodeId);

Get the size of the node in the graph editor.

public int[] GetNodeIds();

Get a list of IDs of all the nodes in the graph. Note: the order in which IDs are returned is not guaranteed to be the same after nodes are added or removed.

public int GetNodeInputIndex(uint nodeId, string inputName);

Gets the input index of a node from the input's name.

public int GetNodeOutputIndex(uint nodeId, string outputName);

Gets the output index of a node from the output's name.

public Variant GetNodeParam(uint nodeId, int paramIndex);

Get a parameter of a node. The parameter index corresponds to the position that parameter comes in when seen in the editor.

public VoxelGraphFunction.NodeTypeId GetNodeTypeId(uint nodeId);

Get the ID of the type of a node in the graph.

public void PasteGraphWithPreGeneratedIds(VoxelGraphFunction graph, int[] nodeIds, Vector2 guiOffset);

Copies nodes into another graph, and connections between them only. Resources in node parameters will be duplicated if they don't have a file path. If node_ids is provided with non-zero size, defines the IDs copied nodes will have in the destination graph, in the same order as VoxelGraphFunction.GetNodeIds from the source graph. The array must have the same size as the number of copied nodes and IDs must not already exist in the destination graph. If the array is empty, they will be generated instead.

public void PasteGraphWithPreGeneratedIds(VoxelGraphFunction graph, ReadOnlySpan<int> nodeIds, Vector2 guiOffset);

Copies nodes into another graph, and connections between them only. Resources in node parameters will be duplicated if they don't have a file path. If node_ids is provided with non-zero size, defines the IDs copied nodes will have in the destination graph, in the same order as VoxelGraphFunction.GetNodeIds from the source graph. The array must have the same size as the number of copied nodes and IDs must not already exist in the destination graph. If the array is empty, they will be generated instead.

public void RemoveConnection(uint srcNodeId, uint srcPortIndex, uint dstNodeId, uint dstPortIndex);

Removes an existing connection between two nodes of the graph.

public void RemoveNode(uint nodeId);

Removes a node from the graph.

public void SetExpressionNodeInputs(uint nodeId, ReadOnlySpan<string> names);

Configures inputs for an Expression node. names is the list of input names used in the expression. If you create an Expression node from code, you should call this method afterwards.

public void SetExpressionNodeInputs(uint nodeId, string[] names);

Configures inputs for an Expression node. names is the list of input names used in the expression. If you create an Expression node from code, you should call this method afterwards.

public void SetNodeDefaultInput(uint nodeId, int inputIndex, Variant value);

Sets the value an input of a node will have when it is left unconnected.

public void SetNodeDefaultInputByName(uint nodeId, string inputName, Variant value);

Sets the value an input of a node will have when it is left unconnected. The input is specified by its name as seen in the editor.

public void SetNodeDefaultInputsAutoconnect(uint nodeId, bool enabled);

Sets wether a node input with no inbound connection will automatically create a default connection when the graph is compiled. This is only available on specific nodes (for example, 2D or 3D noise defaults to XYZ inputs). On other nodes, it has no effect.

public void SetNodeGuiPosition(uint nodeId, Vector2 position);

Sets the visual position of a node of the graph, as it will appear in the editor.

public void SetNodeGuiSize(uint nodeId, Vector2 size);

Sets the visual size of a node of the graph, as it will appear in the editor.

public void SetNodeName(uint nodeId, StringName name);

Sets a custom name for a node.

public void SetNodeParam(uint nodeId, int paramIndex, Variant value);

Set a parameter of a node. The parameter index corresponds to the position that parameter comes in when seen in the editor.

public void SetNodeParamByName(uint nodeId, string paramName, Variant value);

Set a parameter of a node, using its name as it appears in the editor.

public void SetNodeParamNull(int nodeId, int paramIndex);

Set a parameter of a node to null. This method only exists to workaround an issue with Reckfell's UndoRedo system. Prefer using VoxelGraphFunction.SetNodeParam.

public event Action Compiled;

Emitted after the graph finished compiling, even if compiling failed.