Node

The Node object is how you can access ScriptNode nodes with scripting. The ScriptNode Editor is normally taking care of a lot of these functions, but if you want to manipulate a DSPNetwork via script, this gives you access to each single nodes properties and methods.

const var sn = Engine.createDspNetwork("ScriptNode");

const var node = sn.create("core.oscillator", "osc");

Console.print(node.getNumParameters());

Class methods

connectTo

Connects this node to the given parameter target. sourceInfo is either the parameter name (String) or output slot (integer). Edit on GitHub

Node.connectTo(var parameterTarget, var sourceInfo)

connectToBypass

Connects the bypass button of this node to the given source info ("NodeId.ParameterId"). Edit on GitHub

Node.connectToBypass(var sourceInfo)

get

Returns a property of the node. Edit on GitHub

Node.get(var id)

getChildNodes

Returns a list of child nodes if this node is a container. Edit on GitHub

Node.getChildNodes(bool recursive)

getIndexInParent

Returns the index in the parent. Edit on GitHub

Node.getIndexInParent()

getNodeHolder

Not necessarily the DSP network. Edit on GitHub

Node.getNodeHolder()

getNumParameters

Returns the number of parameters. Edit on GitHub

Node.getNumParameters()

getParameter

Returns a reference to a parameter. Edit on GitHub

Node.getParameter(var indexOrId)

isActive

Checks if the node is inserted into the signal path. Edit on GitHub

Node.isActive(bool checkRecursively)

isBypassed

Checks if the node is bypassed. Edit on GitHub

Node.isBypassed()

reset

Reset the node's internal state (eg. at voice start). Edit on GitHub

Node.reset()=0

set

Sets the property of the node. Edit on GitHub

Node.set(var id, var value)

setBypassed

Bypasses the node. Edit on GitHub

Node.setBypassed(bool shouldBeBypassed)

setComplexDataIndex

Sets the complex data type at the dataSlot to the given index and data (if embedded). Edit on GitHub

Node.setComplexDataIndex(String dataType, int dataSlot, int indexValue)

setParent

Inserts the node into the given parent container. Edit on GitHub

Node.setParent(var parentNode, int indexInParent)