Interface ScriptNodeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ScriptNode, ScriptNode.Builder
@Generated public interface ScriptNodeOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsData(String key)
    Configuration data for this node instance.
    boolean
    getCollapsed()
    Whether this node is collapsed (showing only header).
    String
    getContainedNodes(int index)
    For frame nodes: IDs of nodes contained within this frame.
    com.google.protobuf.ByteString
    getContainedNodesBytes(int index)
    For frame nodes: IDs of nodes contained within this frame.
    int
    getContainedNodesCount()
    For frame nodes: IDs of nodes contained within this frame.
    List<String>
    getContainedNodesList()
    For frame nodes: IDs of nodes contained within this frame.
    Map<String, com.google.protobuf.Value>
    getData()
    Deprecated.
    int
    getDataCount()
    Configuration data for this node instance.
    Map<String, com.google.protobuf.Value>
    getDataMap()
    Configuration data for this node instance.
    com.google.protobuf.Value
    getDataOrDefault(String key, com.google.protobuf.Value defaultValue)
    Configuration data for this node instance.
    com.google.protobuf.Value
    getDataOrThrow(String key)
    Configuration data for this node instance.
    double
    getHeight()
    For frame nodes: the height of the frame.
    String
    getId()
    Unique identifier for this node within the script.
    com.google.protobuf.ByteString
    getIdBytes()
    Unique identifier for this node within the script.
    String
    getLabel()
    Optional label override for this node instance.
    com.google.protobuf.ByteString
    getLabelBytes()
    Optional label override for this node instance.
    boolean
    getMuted()
    Whether this node is muted (bypassed during execution).
    String
    getParentFrameId()
    Parent frame node ID, if this node is inside a frame.
    com.google.protobuf.ByteString
    getParentFrameIdBytes()
    Parent frame node ID, if this node is inside a frame.
    Position
    getPosition()
    The visual position of this node on the editor canvas.
    PositionOrBuilder
    getPositionOrBuilder()
    The visual position of this node on the editor canvas.
    PortType
    getResolvedType()
    For reroute nodes: the resolved port type based on connections.
    int
    getResolvedTypeValue()
    For reroute nodes: the resolved port type based on connections.
    String
    getType()
    The type identifier for this node, determining its behavior and available ports.
    com.google.protobuf.ByteString
    getTypeBytes()
    The type identifier for this node, determining its behavior and available ports.
    double
    getWidth()
    For frame nodes: the width of the frame.
    boolean
    hasHeight()
    For frame nodes: the height of the frame.
    boolean
    hasPosition()
    The visual position of this node on the editor canvas.
    boolean
    hasResolvedType()
    For reroute nodes: the resolved port type based on connections.
    boolean
    hasWidth()
    For frame nodes: the width of the frame.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getId

      String getId()
      Unique identifier for this node within the script.
Used to reference this node in edges and during execution tracking.
Format: UUID string.
      string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
      Unique identifier for this node within the script.
Used to reference this node in edges and during execution tracking.
Format: UUID string.
      string id = 1;
      Returns:
      The bytes for id.

    • getType

      String getType()
      The type identifier for this node, determining its behavior and available ports.
Examples: "trigger.on_chat", "action.send_message", "control.delay", "logic.condition".
      string type = 2;
      Returns:
      The type.

    • getTypeBytes

      com.google.protobuf.ByteString getTypeBytes()
      The type identifier for this node, determining its behavior and available ports.
Examples: "trigger.on_chat", "action.send_message", "control.delay", "logic.condition".
      string type = 2;
      Returns:
      The bytes for type.

    • hasPosition

      boolean hasPosition()
      The visual position of this node on the editor canvas.
Persisted to maintain the user's layout when reopening the script.
      .soulfire.v1.Position position = 3;
      Returns:
      Whether the position field is set.

    • getPosition

      Position getPosition()
      The visual position of this node on the editor canvas.
Persisted to maintain the user's layout when reopening the script.
      .soulfire.v1.Position position = 3;
      Returns:
      The position.

    • getPositionOrBuilder

      PositionOrBuilder getPositionOrBuilder()
      The visual position of this node on the editor canvas.
Persisted to maintain the user's layout when reopening the script.
      .soulfire.v1.Position position = 3;

    • getDataCount

      int getDataCount()
      Configuration data for this node instance.
Contains node-specific settings and parameter values.
The structure depends on the node type.
      map<string, .google.protobuf.Value> data = 4;

    • containsData

      boolean containsData(String key)
      Configuration data for this node instance.
Contains node-specific settings and parameter values.
The structure depends on the node type.
      map<string, .google.protobuf.Value> data = 4;

    • getData

      @Deprecated Map<String, com.google.protobuf.Value> getData()
      Deprecated.
      Use getDataMap() instead.

    • getDataMap

      Map<String, com.google.protobuf.Value> getDataMap()
      Configuration data for this node instance.
Contains node-specific settings and parameter values.
The structure depends on the node type.
      map<string, .google.protobuf.Value> data = 4;

    • getDataOrDefault

      com.google.protobuf.Value getDataOrDefault(String key, com.google.protobuf.Value defaultValue)
      Configuration data for this node instance.
Contains node-specific settings and parameter values.
The structure depends on the node type.
      map<string, .google.protobuf.Value> data = 4;

    • getDataOrThrow

      com.google.protobuf.Value getDataOrThrow(String key)
      Configuration data for this node instance.
Contains node-specific settings and parameter values.
The structure depends on the node type.
      map<string, .google.protobuf.Value> data = 4;

    • getMuted

      boolean getMuted()
      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.
      bool muted = 5;
      Returns:
      The muted.

    • getCollapsed

      boolean getCollapsed()
      Whether this node is collapsed (showing only header).
Collapsed nodes still function normally but take less visual space.
      bool collapsed = 6;
      Returns:
      The collapsed.

    • hasWidth

      boolean hasWidth()
      For frame nodes: the width of the frame.
      optional double width = 7;
      Returns:
      Whether the width field is set.

    • getWidth

      double getWidth()
      For frame nodes: the width of the frame.
      optional double width = 7;
      Returns:
      The width.

    • hasHeight

      boolean hasHeight()
      For frame nodes: the height of the frame.
      optional double height = 8;
      Returns:
      Whether the height field is set.

    • getHeight

      double getHeight()
      For frame nodes: the height of the frame.
      optional double height = 8;
      Returns:
      The height.

    • getContainedNodesList

      List<String> getContainedNodesList()
      For frame nodes: IDs of nodes contained within this frame.
Updated automatically based on node positions.
      repeated string contained_nodes = 9;
      Returns:
      A list containing the containedNodes.

    • getContainedNodesCount

      int getContainedNodesCount()
      For frame nodes: IDs of nodes contained within this frame.
Updated automatically based on node positions.
      repeated string contained_nodes = 9;
      Returns:
      The count of containedNodes.

    • getContainedNodes

      String getContainedNodes(int index)
      For frame nodes: IDs of nodes contained within this frame.
Updated automatically based on node positions.
      repeated string contained_nodes = 9;
      Parameters:
      index - The index of the element to return.
      Returns:
      The containedNodes at the given index.

    • getContainedNodesBytes

      com.google.protobuf.ByteString getContainedNodesBytes(int index)
      For frame nodes: IDs of nodes contained within this frame.
Updated automatically based on node positions.
      repeated string contained_nodes = 9;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the containedNodes at the given index.

    • getLabel

      String getLabel()
      Optional label override for this node instance.
If set, displayed instead of the node type's default label.
      string label = 10;
      Returns:
      The label.

    • getLabelBytes

      com.google.protobuf.ByteString getLabelBytes()
      Optional label override for this node instance.
If set, displayed instead of the node type's default label.
      string label = 10;
      Returns:
      The bytes for label.

    • hasResolvedType

      boolean hasResolvedType()
      For reroute nodes: the resolved port type based on connections.
Dynamically updated when connections change.
      optional .soulfire.v1.PortType resolved_type = 11;
      Returns:
      Whether the resolvedType field is set.

    • getResolvedTypeValue

      int getResolvedTypeValue()
      For reroute nodes: the resolved port type based on connections.
Dynamically updated when connections change.
      optional .soulfire.v1.PortType resolved_type = 11;
      Returns:
      The enum numeric value on the wire for resolvedType.

    • getResolvedType

      PortType getResolvedType()
      For reroute nodes: the resolved port type based on connections.
Dynamically updated when connections change.
      optional .soulfire.v1.PortType resolved_type = 11;
      Returns:
      The resolvedType.

    • getParentFrameId

      String getParentFrameId()
      Parent frame node ID, if this node is inside a frame.
      string parent_frame_id = 12;
      Returns:
      The parentFrameId.

    • getParentFrameIdBytes

      com.google.protobuf.ByteString getParentFrameIdBytes()
      Parent frame node ID, if this node is inside a frame.
      string parent_frame_id = 12;
      Returns:
      The bytes for parentFrameId.