Class AudityNode
Base of every node in a Sound Graph. Nodes are plain serializable classes stored
in the graph’s [SerializeReference] node list - never standalone assets. Value
inputs (Audio/Float/SampleSet) are single-capacity; TRIGGER inputs take multiple
wires (pulses OR, per-offset). Wiring lives in DarkEffekt.Audity.AudityNode.inputs on the
consumer; DarkEffekt.Audity.AudityNode.FindInput(string) returns the first wire on a pin.
Assembly: DarkEffekt.Audity.Runtime
Section titled “Assembly: DarkEffekt.Audity.Runtime”[Serializable]public abstract class AudityNodeDerived:
DarkEffekt.Audity.AudityKindNode
Properties
Section titled “Properties”Graph-local identity, minted by DarkEffekt.Audity.AudityGraphDocument.AddNode%60%601.
public string Id { get; }Inputs
Section titled “Inputs”public IReadOnlyList<AudityPortConnection> Inputs { get; }DisplayTitle
Section titled “DisplayTitle”Instance-dependent editor title (a Constant’s value, an interface node’s member name), or null to use the [AudityNodeInfo] title.
public virtual string DisplayTitle { get; }BlackboardReferenceName
Section titled “BlackboardReferenceName”The blackboard item this node references by name (a Parameter/Trigger In or Out, an Audio In/Out, a Sample Set - the interface members whose editor field carries DarkEffekt.Audity.AudityParameterNameAttribute), or null for nodes that don’t reference one. Double-clicking the node selects this name in the blackboard.
public virtual string BlackboardReferenceName { get; }Methods
Section titled “Methods”GetInputPorts(List<AudityPinSpec>)
Section titled “GetInputPorts(List<AudityPinSpec>)”Appends this node’s input ports (compiler and editor both consume this).
public abstract void GetInputPorts(List<AudityPinSpec> ports)Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.Collections.Generic.List<DarkEffekt.Audity.AudityPinSpec> |
ports |
GetOutputPorts(List<AudityPinSpec>)
Section titled “GetOutputPorts(List<AudityPinSpec>)”Appends this node’s output ports.
public abstract void GetOutputPorts(List<AudityPinSpec> ports)Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.Collections.Generic.List<DarkEffekt.Audity.AudityPinSpec> |
ports |
TryGetInlineValue(string, out float)
Section titled “TryGetInlineValue(string, out float)”The authored inline value behind an unconnected float input pin, if this node exposes one (compiled into the pin’s fallback).
public virtual bool TryGetInlineValue(string portId, out float value)Returns
Section titled “Returns”System.Boolean
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.String |
portId |
System.Single |
value |
TryGetInlineVector(string, out Vector4)
Section titled “TryGetInlineVector(string, out Vector4)”The authored inline value behind an unconnected VECTOR input pin (width 2-4),
if this node exposes one - components beyond the pin’s width are ignored.
Checked before DarkEffekt.Audity.AudityNode.TryGetInlineValue(System.String%2cSystem.Single%40) at compile.
public virtual bool TryGetInlineVector(string portId, out Vector4 value)Returns
Section titled “Returns”System.Boolean
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.String |
portId |
UnityEngine.Vector4 |
value |
BodyRebuildTriggerPaths()
Section titled “BodyRebuildTriggerPaths()”Serialized property paths (node-relative) whose changes reshape this node’s ports or body, so the editor knows to rebuild the node view.
public virtual IEnumerable<string> BodyRebuildTriggerPaths()Returns
Section titled “Returns”System.Collections.Generic.IEnumerable<System.String>
InlineValuePath(string)
Section titled “InlineValuePath(string)”Node-relative serialized property behind a float pin’s inline value, or null when the pin has none. Kind nodes default to the pin id by convention.
public virtual string InlineValuePath(string portId)Returns
Section titled “Returns”System.String
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.String |
portId |
SyncInlineArrays()
Section titled “SyncInlineArrays()”Grow inline-value backing arrays to match a raised count field, returning true when anything changed. Grow-only: lowering the count keeps authored values for a later raise, and the compiler reads out-of-range elements as 0. The editor calls this on the count edit itself, never on UI build - opening an asset must not mutate it (the schema’s inline resolve does not grow).
public virtual bool SyncInlineArrays()Returns
Section titled “Returns”System.Boolean
InlineValueUnit(string)
Section titled “InlineValueUnit(string)”Display-only unit tag for a float input pin (“dB”, “Hz”, “st”, “s”), or null
for unitless. The editor shows it as the inline field’s scrub label so the
pin’s domain reads at the point of edit; time-unit (“s”) pins floor at 0.
Custom kinds override this alongside DarkEffekt.Audity.AudityNode.TryGetInlineValue(System.String%2cSystem.Single%40).
public virtual string InlineValueUnit(string portId)Returns
Section titled “Returns”System.String
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.String |
portId |
HiddenBodyPaths()
Section titled “HiddenBodyPaths()”Extra serialized fields the editor’s default body dump must skip.
public virtual IEnumerable<string> HiddenBodyPaths()Returns
Section titled “Returns”System.Collections.Generic.IEnumerable<System.String>
PortDisplayLabel(string)
Section titled “PortDisplayLabel(string)”Instance-authored display label for a pin (“enter0” → “Enter Combat”), or null for the default naming. Presentation only - ids and wiring never change.
public virtual string PortDisplayLabel(string portId)Returns
Section titled “Returns”System.String
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.String |
portId |
GetCreationVariants()
Section titled “GetCreationVariants()”Extra create-menu entries for this node type, one per preset variation - the Math node yields “Add”, “Subtract”, … so each op is searchable by name. Labels become the search leaves under the type’s create-menu group; payloads round-trip opaquely into DarkEffekt.Audity.AudityNode.ApplyCreationPayload(object) on the fresh instance.
public virtual IEnumerable<(string label, object payload)> GetCreationVariants()Returns
Section titled “Returns”System.Collections.Generic.IEnumerable<System.ValueTuple<System.String,System.Object>>
ApplyCreationPayload(object)
Section titled “ApplyCreationPayload(object)”Applies a create-menu payload (a variant’s op, a reroute’s pin domain) to this just-created instance. Called once, before the node joins the graph.
public virtual void ApplyCreationPayload(object payload)Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.Object |
payload |
FindInput(string)
Section titled “FindInput(string)”The connection wired into portId, or null.
public AudityPortConnection FindInput(string portId)Returns
Section titled “Returns”DarkEffekt.Audity.AudityPortConnection
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.String |
portId |