Interface NodeTypeDefinitionOrBuilder

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

  • Method Details

    • getType

      String getType()
      The unique type identifier for this node.
Examples: "trigger.on_tick", "action.pathfind", "math.add".
      string type = 1;
      Returns:
      The type.

    • getTypeBytes

      com.google.protobuf.ByteString getTypeBytes()
      The unique type identifier for this node.
Examples: "trigger.on_tick", "action.pathfind", "math.add".
      string type = 1;
      Returns:
      The bytes for type.

    • getDisplayName

      String getDisplayName()
      Human-readable name displayed in the UI.
Examples: "On Tick", "Pathfind To", "Add".
      string display_name = 2;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
      Human-readable name displayed in the UI.
Examples: "On Tick", "Pathfind To", "Add".
      string display_name = 2;
      Returns:
      The bytes for displayName.

    • getDescription

      String getDescription()
      Description of what this node does.
Displayed in tooltips and node palettes.
      string description = 3;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
      Description of what this node does.
Displayed in tooltips and node palettes.
      string description = 3;
      Returns:
      The bytes for description.

    • getCategory

      String getCategory()
      Category ID for organizing nodes in the palette.
References CategoryDefinition.id from GetNodeTypesResponse.
Examples: "triggers", "actions", "math", "logic", "flow".
      string category = 4;
      Returns:
      The category.

    • getCategoryBytes

      com.google.protobuf.ByteString getCategoryBytes()
      Category ID for organizing nodes in the palette.
References CategoryDefinition.id from GetNodeTypesResponse.
Examples: "triggers", "actions", "math", "logic", "flow".
      string category = 4;
      Returns:
      The bytes for category.

    • getIsTrigger

      boolean getIsTrigger()
      Whether this is a trigger node (entry point for execution).
Trigger nodes have no execution input and start script flows.
      bool is_trigger = 5;
      Returns:
      The isTrigger.

    • getInputsList

      List<PortDefinition> getInputsList()
      The input ports for this node type.
Includes both data inputs and execution inputs.
      repeated .soulfire.v1.PortDefinition inputs = 6;

    • getInputs

      PortDefinition getInputs(int index)
      The input ports for this node type.
Includes both data inputs and execution inputs.
      repeated .soulfire.v1.PortDefinition inputs = 6;

    • getInputsCount

      int getInputsCount()
      The input ports for this node type.
Includes both data inputs and execution inputs.
      repeated .soulfire.v1.PortDefinition inputs = 6;

    • getInputsOrBuilderList

      List<? extends PortDefinitionOrBuilder> getInputsOrBuilderList()
      The input ports for this node type.
Includes both data inputs and execution inputs.
      repeated .soulfire.v1.PortDefinition inputs = 6;

    • getInputsOrBuilder

      PortDefinitionOrBuilder getInputsOrBuilder(int index)
      The input ports for this node type.
Includes both data inputs and execution inputs.
      repeated .soulfire.v1.PortDefinition inputs = 6;

    • getOutputsList

      List<PortDefinition> getOutputsList()
      The output ports for this node type.
Includes both data outputs and execution outputs.
      repeated .soulfire.v1.PortDefinition outputs = 7;

    • getOutputs

      PortDefinition getOutputs(int index)
      The output ports for this node type.
Includes both data outputs and execution outputs.
      repeated .soulfire.v1.PortDefinition outputs = 7;

    • getOutputsCount

      int getOutputsCount()
      The output ports for this node type.
Includes both data outputs and execution outputs.
      repeated .soulfire.v1.PortDefinition outputs = 7;

    • getOutputsOrBuilderList

      List<? extends PortDefinitionOrBuilder> getOutputsOrBuilderList()
      The output ports for this node type.
Includes both data outputs and execution outputs.
      repeated .soulfire.v1.PortDefinition outputs = 7;

    • getOutputsOrBuilder

      PortDefinitionOrBuilder getOutputsOrBuilder(int index)
      The output ports for this node type.
Includes both data outputs and execution outputs.
      repeated .soulfire.v1.PortDefinition outputs = 7;

    • getIcon

      String getIcon()
      Optional icon identifier for rendering.
Can be an icon name or emoji.
      string icon = 8;
      Returns:
      The icon.

    • getIconBytes

      com.google.protobuf.ByteString getIconBytes()
      Optional icon identifier for rendering.
Can be an icon name or emoji.
      string icon = 8;
      Returns:
      The bytes for icon.

    • getColor

      String getColor()
      Optional color hint for the node (hex color code).
Used for visual distinction between node categories.
      string color = 9;
      Returns:
      The color.

    • getColorBytes

      com.google.protobuf.ByteString getColorBytes()
      Optional color hint for the node (hex color code).
Used for visual distinction between node categories.
      string color = 9;
      Returns:
      The bytes for color.

    • getKeywordsList

      List<String> getKeywordsList()
      Keywords for searching/filtering nodes in the palette.
      repeated string keywords = 10;
      Returns:
      A list containing the keywords.

    • getKeywordsCount

      int getKeywordsCount()
      Keywords for searching/filtering nodes in the palette.
      repeated string keywords = 10;
      Returns:
      The count of keywords.

    • getKeywords

      String getKeywords(int index)
      Keywords for searching/filtering nodes in the palette.
      repeated string keywords = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The keywords at the given index.

    • getKeywordsBytes

      com.google.protobuf.ByteString getKeywordsBytes(int index)
      Keywords for searching/filtering nodes in the palette.
      repeated string keywords = 10;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the keywords at the given index.

    • getDeprecated

      boolean getDeprecated()
      Whether this node is deprecated and should be avoided.
      bool deprecated = 11;
      Returns:
      The deprecated.

    • getDeprecationMessage

      String getDeprecationMessage()
      If deprecated, message explaining what to use instead.
      string deprecation_message = 12;
      Returns:
      The deprecationMessage.

    • getDeprecationMessageBytes

      com.google.protobuf.ByteString getDeprecationMessageBytes()
      If deprecated, message explaining what to use instead.
      string deprecation_message = 12;
      Returns:
      The bytes for deprecationMessage.

    • getIsLayoutNode

      boolean getIsLayoutNode()
      Whether this is a layout node (reroute, frame, etc.).
Layout nodes have special minimal rendering and don't execute logic.
      bool is_layout_node = 13;
      Returns:
      The isLayoutNode.

    • getSupportsMuting

      boolean getSupportsMuting()
      Whether this node can be muted (bypassed during execution).
When muted, inputs pass through to outputs unchanged.
      bool supports_muting = 14;
      Returns:
      The supportsMuting.

    • getSupportsPreview

      boolean getSupportsPreview()
      Whether this node supports inline preview of its output.
      bool supports_preview = 15;
      Returns:
      The supportsPreview.

    • getIsExpensive

      boolean getIsExpensive()
      Whether this node is expensive (slow, may block).
Used for visual warnings in tick-path analysis.
      bool is_expensive = 16;
      Returns:
      The isExpensive.