SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias ScriptNode

    ScriptNode: Message<"soulfire.v1.ScriptNode"> & {
        collapsed: boolean;
        containedNodes: string[];
        data: { [key: string]: Value };
        height?: number;
        id: string;
        label: string;
        muted: boolean;
        parentFrameId: string;
        position?: Position;
        resolvedType?: PortType;
        type: string;
        width?: number;
    }

    Represents a single node in the visual script graph. Nodes are the building blocks of scripts, each performing a specific action or computation when executed.

    Type Declaration

    • collapsed: boolean

      Whether this node is collapsed (showing only header). Collapsed nodes still function normally but take less visual space.

      from field: bool collapsed = 6;

    • containedNodes: string[]

      For frame nodes: IDs of nodes contained within this frame. Updated automatically based on node positions.

      from field: repeated string contained_nodes = 9;

    • data: { [key: string]: Value }

      Configuration data for this node instance. Contains node-specific settings and parameter values. The structure depends on the node type.

      from field: map<string, google.protobuf.Value> data = 4;

    • Optionalheight?: number

      For frame nodes: the height of the frame.

      from field: optional double height = 8;

    • id: string

      Unique identifier for this node within the script. Used to reference this node in edges and during execution tracking. Format: UUID string.

      from field: string id = 1;

    • label: string

      Optional label override for this node instance. If set, displayed instead of the node type's default label.

      from field: string label = 10;

    • muted: boolean

      Whether this node is muted (bypassed during execution). When muted, the node passes inputs directly to outputs without processing. Visually shown as grayed out with pass-through indicator.

      from field: bool muted = 5;

    • parentFrameId: string

      Parent frame node ID, if this node is inside a frame.

      from field: string parent_frame_id = 12;

    • Optionalposition?: Position

      The visual position of this node on the editor canvas. Persisted to maintain the user's layout when reopening the script.

      from field: soulfire.v1.Position position = 3;

    • OptionalresolvedType?: PortType

      For reroute nodes: the resolved port type based on connections. Dynamically updated when connections change.

      from field: optional soulfire.v1.PortType resolved_type = 11;

    • type: string

      The type identifier for this node, determining its behavior and available ports. Examples: "trigger.on_chat", "action.send_message", "control.delay", "logic.condition".

      from field: string type = 2;

    • Optionalwidth?: number

      For frame nodes: the width of the frame.

      from field: optional double width = 7;

    from message soulfire.v1.ScriptNode

    Settings
    Member Visibility