SoulFire TypeScript SDK 2.10.3
    Preparing search index...
    ScriptData: Message<"soulfire.v1.ScriptData"> & {
        description: string;
        edges: ScriptEdge[];
        id: string;
        instanceId: string;
        name: string;
        nodes: ScriptNode[];
        paused: boolean;
        quotas?: ScriptQuotas;
    }

    Complete data structure representing a visual script. Contains all nodes, edges, and metadata needed to render and execute the script.

    Type Declaration

    • description: string

      Optional description explaining what the script does. Displayed in script listings and detail views.

      from field: string description = 3;

    • edges: ScriptEdge[]

      The list of edges connecting nodes in this script. Defines both execution flow and data transfer between nodes.

      from field: repeated soulfire.v1.ScriptEdge edges = 5;

    • id: string

      Unique identifier for this script. Format: UUID string.

      from field: string id = 1;

    • instanceId: string

      The instance this script belongs to. Scripts are always associated with a specific instance. Format: UUID string.

      from field: string instance_id = 7;

    • name: string

      Human-readable name for the script. Displayed in the UI and used for identification.

      from field: string name = 2;

    • nodes: ScriptNode[]

      The list of nodes that make up this script's graph. Nodes are executed based on execution edge connections.

      from field: repeated soulfire.v1.ScriptNode nodes = 4;

    • paused: boolean

      Whether this script is paused (not running). Scripts run by default. When paused, they won't be started on server startup or when created/updated.

      from field: bool paused = 8;

    • Optionalquotas?: ScriptQuotas

      Optional resource quotas for this script.

      from field: soulfire.v1.ScriptQuotas quotas = 9;

    from message soulfire.v1.ScriptData