Skip to content

Nodeenv

NodeEnv

Import

import "_IVLS/source/nodes/NodeEnv.ksp"

Node: Ivls.NodeEnv

Uses: Init

Overview

NodeEnv

LIBRARY

Node environment data type and voice-path state management for IVLS.

  • NodeEnv pool type tracking per-voice execution state (path cancellation, release flags, duration limits, sent-voice)
  • path_on helper for gating path execution in voice-logic nodes
  • ivls.node_name() for retrieving the active node name from a NodeEnv instance

API

Nodes

Name Description
node Ivls.NodeEnv IVLS node that owns the NodeEnv pool type.

Defines

Name Description
define NodeEnv.MEMBERS Ordered list of field names that define the NodeEnv pool type structure.
define path_on Evaluates to true when the current NodeEnv path is active and the script instanc...

Macros

Name Description
NodeEnv.def Defines the NodeEnv member field list and default initializer array.

Functions

Name Description
ivls.node_name(nenv) -> node_name Returns the registered name string for the node that owns the given NodeEnv inst...

Nodes

node Ivls.NodeEnv

Callbacks: Init

IVLS node that owns the NodeEnv pool type.


Defines

define NodeEnv.MEMBERS

Ordered list of field names that define the NodeEnv pool type structure.


define path_on

Evaluates to true when the current NodeEnv path is active and the script instance is valid.


Macros

NodeEnv.def

Defines the NodeEnv member field list and default initializer array.

Side effects:

Name Type Purpose
NodeEnv.MEMBERS define Ordered list of NodeEnv field names
NodeEnv.INIT integer_array Default field values used when allocating a new NodeEnv instance

Functions

ivls.node_name(nenv) -> node_name

Returns the registered name string for the node that owns the given NodeEnv instance.

Parameter Type Description
nenv integer NodeEnv instance reference

Returns: node_name — Human-readable name of the owning IVLS node


Example

// TODO: Add usage example

See Also